Class PackageResource

Chainable resource for one Packagist package.

Example

const pkg = await packagist.package('monolog/monolog');
const metadata = await packagist.package('monolog/monolog').metadata();
const stats = await packagist.package('monolog/monolog').stats();

Implements

PromiseLike<PackageResponse>

Index

Methods

then get metadata stats securityAdvisories

Methods

then

then<TResult1 = PackageResponse, TResult2 = never>(
    onfulfilled?:
        | ((value: PackageResponse) => TResult1 | PromiseLike<TResult1>)
        | null,
    onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null,
): Promise<TResult1 | TResult2>
Allows the resource to be awaited directly.

Awaiting a PackageResource delegates to PackageResource.get.
Type Parameters
- TResult1 = PackageResponse
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: PackageResponse) => TResult1 | PromiseLike<TResult1>) | null
- Optionalonrejected: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null
Returns Promise<TResult1 | TResult2>
Implementation of PromiseLike.then
- Defined in src/resources/PackageResource.ts:37

get

get(signal?: AbortSignal): Promise<PackageResponse>
Gets full JSON API package data.

GET /packages/[vendor]/[package].json
Parameters
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<PackageResponse>
Full package data, including versions, maintainers, downloads, and repository info.
- Defined in src/resources/PackageResource.ts:60

metadata

metadata(
options?: MetadataOptions,
signal?: AbortSignal,
): Promise<PackageMetadataResponse>
Gets Composer v2 metadata from repo.packagist.org.

GET /p2/[vendor]/[package].json
Parameters
- options: MetadataOptions = {}
  Metadata selection options.
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<PackageMetadataResponse>
Composer v2 metadata for tagged releases or dev versions.
- Defined in src/resources/PackageResource.ts:73

stats

stats(signal?: AbortSignal): Promise<PackageStatsResponse>
Gets download stats for this package.

GET /packages/[vendor]/[package]/stats.json
Parameters
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<PackageStatsResponse>
Download counts and version list for the package.
- Defined in src/resources/PackageResource.ts:94

securityAdvisories

securityAdvisories(signal?: AbortSignal): Promise<SecurityAdvisoriesResponse>
Gets security advisories for this package.

GET /api/security-advisories/?packages[]=[vendor/package]
Parameters
- Optionalsignal: AbortSignal
  Optional abort signal.
Returns Promise<SecurityAdvisoriesResponse>
Security advisories keyed by this package name.
- Defined in src/resources/PackageResource.ts:111

Class PackageResource

Example

Implements

Index

Methods

Methods

then

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

get

Parameters

Returns Promise<PackageResponse>

metadata

Parameters

Returns Promise<PackageMetadataResponse>

stats

Parameters

Returns Promise<PackageStatsResponse>

securityAdvisories

Parameters

Returns Promise<SecurityAdvisoriesResponse>

Settings

On This Page