Module "info"

Index

Interfaces

Type aliases

VendorPackageInput

Functions

Type aliases

VendorPackageInput

VendorPackageInput: string | { package: string; vendor: string }

Functions

constructVPString

constructVPString(vp: VendorPackageInput): string

- Defined in info.ts:137
Parameters
- vp: VendorPackageInput
Returns string

getPackageDetails

getPackageDetails(vp: VendorPackageInput): Promise<IPackagistPackageDetailResponse>

- Defined in info.ts:123
Checkout "Using the API" @ https://packagist.org/apidoc#get-package-data for more info.

Parameters
- vp: VendorPackageInput
Returns Promise<IPackagistPackageDetailResponse>

getPackageMetadata

getPackageMetadata(vp: VendorPackageInput, ifModifiedSince?: string): Promise<{ data: IPackagistMetadataResponse; lastModified: string }>

- Defined in info.ts:69
Checkout "Using the Composer metadata" @ https://packagist.org/apidoc#get-package-data for more info.

Parameters
- vp: VendorPackageInput
- Default value ifModifiedSince: string = ""
  
  If included the endpoint only returns data if it has changed since this date stamp in time.
Returns Promise<{ data: IPackagistMetadataResponse; lastModified: string }>

getPackagistStats

getPackagistStats(): Promise<IPackagistStatistics>

- Defined in info.ts:160
Checkout https://packagist.org/apidoc#get-statistics for more info.

Returns Promise<IPackagistStatistics>

Generated using TypeDoc