Class VersionResource

Represents a specific version of an npm package, providing access to its manifest.

Implements PromiseLike<NpmPackageVersion> so it can be awaited directly.

Example

// Await directly to get the version manifest
const manifest = await npm.package('react').version('18.2.0');

// Or call .get() explicitly
const manifest = await npm.package('react').version('18.2.0').get();

Implements

PromiseLike<NpmPackageVersion>

Index

Methods

get then

Methods

get

get(signal?: AbortSignal): Promise<NpmPackageVersion>
Fetches the version manifest for this specific version.

GET /{package}/{version}
Parameters
- Optionalsignal: AbortSignal
  Optional AbortSignal to cancel the request
Returns Promise<NpmPackageVersion>
The version manifest object
- Defined in src/resources/VersionResource.ts:47

then

then<TResult1 = NpmPackageVersion, TResult2 = never>(
    onfulfilled?:
        | null
        | (value: NpmPackageVersion) => TResult1 | PromiseLike<TResult1>,
    onrejected?: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>,
): PromiseLike<TResult1 | TResult2>
Allows the resource to be awaited directly, resolving with the version manifest. Delegates to VersionResource.get.
Type Parameters
- TResult1 = NpmPackageVersion
- TResult2 = never
Parameters
- Optionalonfulfilled: null | (value: NpmPackageVersion) => TResult1 | PromiseLike<TResult1>
- Optionalonrejected: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>
Returns PromiseLike<TResult1 | TResult2>
Implementation of PromiseLike.then
- Defined in src/resources/VersionResource.ts:32

Class VersionResource

Example

Implements

Index

Methods

Methods

get

Parameters

Returns Promise<NpmPackageVersion>

then

Type Parameters

Parameters

Returns PromiseLike<TResult1 | TResult2>

Settings

On This Page