@vltpkg/package-info

Classes

PackageInfoClient

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

Constructors

new PackageInfoClient()

new PackageInfoClient(options): PackageInfoClient

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

Parameters

options

PackageInfoClientOptions = {}

Returns

PackageInfoClient

Properties

monorepo?

optional monorepo: Monorepo;

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

options

options: PackageInfoClientOptions

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

packageJson

packageJson: PackageJson

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

Accessors

registryClient

Get Signature

get registryClient(): RegistryClient

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

Returns

RegistryClient

tarPool

Get Signature

get tarPool(): Pool

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

Returns

Pool

Methods

extract()

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

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

Parameters

spec

string | Spec

target

string

options

PackageInfoClientExtractOptions = {}

Returns

Promise<Resolution>

manifest()

manifest(spec, options): Promise<Manifest>

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

Parameters

spec

string | Spec

options

PackageInfoClientRequestOptions = {}

Returns

Promise<Manifest>

packument()

packument(spec, options): Promise<Packument>

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

Parameters

spec

string | Spec

options

PackageInfoClientRequestOptions = {}

Returns

Promise<Packument>

resolve()

resolve(spec, options): Promise<Resolution>

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

Parameters

spec

string | Spec

options

PackageInfoClientRequestOptions = {}

Returns

Promise<Resolution>

tarball()

tarball(spec, options): Promise<Buffer>

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

Parameters

spec

string | Spec

options

PackageInfoClientExtractOptions = {}

Returns

Promise<Buffer>

Type Aliases

PackageInfoClientExtractOptions

type PackageInfoClientExtractOptions =
  PackageInfoClientRequestOptions & object

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

Type declaration

integrity?

optional integrity: Integrity;

resolved?

optional resolved: string;

---

PackageInfoClientOptions

type PackageInfoClientOptions = RegistryClientOptions &
  SpecOptions &
  object

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

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 & object

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

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

Type declaration

integrity?

optional integrity: Integrity;

resolved

resolved: string

signatures?

optional signatures: Exclude<Manifest["dist"], undefined>["signatures"];

spec

spec: Spec