Class UserResource

Represents an npm user, providing authenticated access to user profile information and package names associated with the account.

These endpoints require a registry auth token.

Example

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

const user = await npm.user('pilmee').get();
const packages = await npm.user('pilmee').packages();

Index

Methods

Methods

get

get(signal?: AbortSignal): Promise<NpmAuthenticatedUser>
Returns the authenticated registry profile document for this user.

GET /-/user/org.couchdb.user:{username}
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<NpmAuthenticatedUser>
npm user profile document
- Defined in src/resources/UserResource.ts:33

packages

packages(
params?: NpmUserPackagesParams,
signal?: AbortSignal,
): Promise<NpmUserPackages>
Returns package names associated with this user.

GET /-/by-user/{username}
Parameters
- params: NpmUserPackagesParams = {}
  Optional pagination parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<NpmUserPackages>
Package names associated with the user
- Defined in src/resources/UserResource.ts:51