@vltpkg/package-info

Classes

PackageInfoClient

Defined in: package-info/src/index.ts:113

Constructors

new PackageInfoClient()

new PackageInfoClient(options): PackageInfoClient

Defined in: package-info/src/index.ts:167

Parameters

options

PackageInfoClientOptions = {}

Returns

PackageInfoClient

Properties

monorepo?

optional monorepo: Monorepo;

Defined in: package-info/src/index.ts:120

options

options: PackageInfoClientOptions

Defined in: package-info/src/index.ts:117

packageJson

packageJson: PackageJson

Defined in: package-info/src/index.ts:119

Methods

_manifestCachePath()

_manifestCachePath(spec, options): undefined | string

Defined in: package-info/src/index.ts:516

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

Spec

options

PackageInfoClientRequestOptions

Returns

undefined | string

extract()

extract(
   spec,
   target,
options): Promise<Resolution>

Defined in: package-info/src/index.ts:190

Parameters

spec

string | Spec

target

string

options

PackageInfoClientExtractOptions = {}

Returns

Promise<Resolution>

getRegistryClient()

getRegistryClient(): Promise<RegistryClient>

Defined in: package-info/src/index.ts:146

Returns

Promise<RegistryClient>

getTarPool()

getTarPool(): Promise<Pool>

Defined in: package-info/src/index.ts:156

Returns

Promise<Pool>

manifest()

manifest(spec, options): Promise<
  | Manifest
| Override<Manifest, NormalizedFields>>

Defined in: package-info/src/index.ts:748

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:912

Parameters

spec

string | Spec

options

PackageInfoClientRequestOptions = {}

Returns

Promise<Packument>

resolve()

resolve(spec, options): Promise<Resolution>

Defined in: package-info/src/index.ts:1051

Parameters

spec

string | Spec

options

PackageInfoClientRequestOptions = {}

Returns

Promise<Resolution>

tarball()

tarball(spec, options): Promise<Buffer<ArrayBufferLike>>

Defined in: package-info/src/index.ts:562

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

fromLockfile?

optional fromLockfile: boolean;

When true, indicates that integrity + resolved came from a lockfile (i.e. they were already verified on first install). Skips the client-side tarball integrity check. Defaults to false — fresh installs always verify integrity.

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