@vltpkg/package-info
Classes
PackageInfoClient
Defined in: package-info/src/index.ts:84
Constructors
new PackageInfoClient()
new PackageInfoClient(options): PackageInfoClient
Defined in: package-info/src/index.ts:108
Parameters
options
Returns
Properties
monorepo?
optional monorepo: Monorepo;
Defined in: package-info/src/index.ts:91
options
options: PackageInfoClientOptions
Defined in: package-info/src/index.ts:88
packageJson
packageJson: PackageJson
Defined in: package-info/src/index.ts:90
Accessors
registryClient
Get Signature
get registryClient(): RegistryClient
Defined in: package-info/src/index.ts:96
Returns
tarPool
Get Signature
get tarPool(): Pool
Defined in: package-info/src/index.ts:103
Returns
Methods
_manifestCachePath()
_manifestCachePath(spec, options): undefined | string
Defined in: package-info/src/index.ts:324
Conditionally return the path to the manifest cache file. The logic to
determine if caching should be skipped aligns with pickManifest
and
is used to avoid caching manifest results that can be variable.
Parameters
spec
options
PackageInfoClientRequestOptions
Returns
undefined
| string
extract()
extract( spec, target,options): Promise<Resolution>
Defined in: package-info/src/index.ts:131
Parameters
spec
string
| Spec
target
string
options
PackageInfoClientExtractOptions
= {}
Returns
Promise
<Resolution
>
manifest()
manifest(spec, options): Promise< | Manifest| Override<Manifest, NormalizedFields>>
Defined in: package-info/src/index.ts:520
Parameters
spec
string
| Spec
options
PackageInfoClientRequestOptions
= {}
Returns
Promise
< | Manifest
|
Override
<Manifest
,
NormalizedFields
>>
packument()
packument(spec, options): Promise<Packument>
Defined in: package-info/src/index.ts:696
Parameters
spec
string
| Spec
options
PackageInfoClientRequestOptions
= {}
Returns
Promise
<Packument
>
resolve()
resolve(spec, options): Promise<Resolution>
Defined in: package-info/src/index.ts:761
Parameters
spec
string
| Spec
options
PackageInfoClientRequestOptions
= {}
Returns
Promise
<Resolution
>
tarball()
tarball(spec, options): Promise<Buffer<ArrayBufferLike>>
Defined in: package-info/src/index.ts:383
Parameters
spec
string
| Spec
options
PackageInfoClientExtractOptions
= {}
Returns
Promise
<Buffer
<ArrayBufferLike
>>
Type Aliases
PackageInfoClientExtractOptions
type PackageInfoClientExtractOptions = PackageInfoClientRequestOptions & object
Defined in: package-info/src/index.ts:75
Type declaration
integrity?
optional integrity: Integrity;
resolved?
optional resolved: string;
PackageInfoClientOptions
type PackageInfoClientOptions = RegistryClientOptions & SpecOptions & object
Defined in: package-info/src/index.ts:53
Type declaration
monorepo?
optional monorepo: Monorepo;
packageJson?
optional packageJson: PackageJson;
PackageJson object
projectRoot?
optional projectRoot: string;
root of the project. Defaults to process.cwd()
workspace?
optional workspace: string[];
workspace paths to load, irrelevant if Monorepo provided
workspace-group?
optional workspace-group: string[];
workspace groups to load, irrelevant if Monorepo provided
PackageInfoClientRequestOptions
type PackageInfoClientRequestOptions = PickManifestOptions & RegistryClientRequestOptions & object
Defined in: package-info/src/index.ts:69
Type declaration
from?
optional from: string;
dir to resolve file://
specifiers against. Defaults to projectRoot.
Resolution
type Resolution = object
Defined in: package-info/src/index.ts:46
Type declaration
integrity?
optional integrity: Integrity;
resolved
resolved: string
signatures?
optional signatures: Exclude<Manifest["dist"], undefined>["signatures"];
spec
spec: Spec
Variables
delimiter
const delimiter: '·' = '·'
Defined in: package-info/src/index.ts:44