Class OrgResource

Represents an npm organization, providing access to authenticated org data such as packages, teams, and members.

These endpoints require a registry auth token with org access.

Example

const npm = new NpmClient({ token: 'npm_...' });

const packages = await npm.org('npmcli').packages();
const teams = await npm.org('npmcli').teams();
const members = await npm.org('npmcli').members();
const wombats = await npm.org('npmcli').teamMembers('wombats');

Methods

members packages teamMembers teams

Methods

members

  • members(signal?: AbortSignal): Promise<NpmOrgMembers>

    Returns all members in an org, keyed by username.

    GET /-/org/{org}/user

    Parameters

    • Optionalsignal: AbortSignal

      Optional AbortSignal to cancel the request

    Returns Promise<NpmOrgMembers>

    Usernames mapped to developer, admin, or owner

packages

  • packages(signal?: AbortSignal): Promise<NpmOrgPackages>

    Returns all packages an org has access to, keyed by package name.

    GET /-/org/{org}/package

    Parameters

    • Optionalsignal: AbortSignal

      Optional AbortSignal to cancel the request

    Returns Promise<NpmOrgPackages>

    Package names mapped to read-only or read-write

teamMembers

  • teamMembers(team: string, signal?: AbortSignal): Promise<string[]>

    Returns all usernames in a team.

    GET /-/org/{org}/{team}/user

    Parameters

    • team: string

      Team name, with or without {org}: prefix

    • Optionalsignal: AbortSignal

      Optional AbortSignal to cancel the request

    Returns Promise<string[]>

    Usernames in the team

teams

  • teams(signal?: AbortSignal): Promise<string[]>

    Returns all teams in an org.

    GET /-/org/{org}/team

    Parameters

    • Optionalsignal: AbortSignal

      Optional AbortSignal to cancel the request

    Returns Promise<string[]>

    Team names, usually in {org}:{team} form

Settings

Member Visibility

On This Page

Methods