@vltpkg/package-info

Classes

PackageInfoClient

Defined in: index.ts:119

Constructors

new PackageInfoClient()

new PackageInfoClient(options): PackageInfoClient

Defined in: index.ts:140

Parameters

options

PackageInfoClientOptions = {}

Returns

PackageInfoClient

Properties

monorepo?

optional monorepo: Monorepo;

Defined in: index.ts:126

options

options: PackageInfoClientOptions

Defined in: index.ts:123

packageJson

packageJson: PackageJson

Defined in: index.ts:125

Accessors

registryClient

Get Signature

get registryClient(): RegistryClient

Defined in: index.ts:128

Returns

RegistryClient

tarPool

Get Signature

get tarPool(): Pool

Defined in: index.ts:135

Returns

Pool

Methods

extract()

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

Defined in: index.ts:158

Parameters

spec

string | Spec

target

string

options

PackageInfoClientExtractOptions = {}

Returns

Promise<Resolution>

manifest()

manifest(spec, options): Promise<Manifest>

Defined in: index.ts:424

Parameters

spec

string | Spec

options

PackageInfoClientRequestOptions = {}

Returns

Promise<Manifest>

packument()

packument(spec, options): Promise<Packument>

Defined in: index.ts:529

Parameters

spec

string | Spec

options

PackageInfoClientRequestOptions = {}

Returns

Promise<Packument>

resolve()

resolve(spec, options): Promise<Resolution>

Defined in: index.ts:592

Parameters

spec

string | Spec

options

PackageInfoClientRequestOptions = {}

Returns

Promise<Resolution>

tarball()

tarball(spec, options): Promise<Buffer>

Defined in: index.ts:308

Parameters

spec

string | Spec

options

PackageInfoClientRequestOptions = {}

Returns

Promise<Buffer>

Type Aliases

PackageInfoClientAllOptions

type PackageInfoClientAllOptions = PackageInfoClientOptions &
  PackageInfoClientRequestOptions &
  PackageInfoClientExtractOptions

Defined in: index.ts:69

---

PackageInfoClientExtractOptions

type PackageInfoClientExtractOptions =
  PackageInfoClientRequestOptions & object

Defined in: index.ts:63

Type declaration

integrity?

optional integrity: Integrity;

resolved?

optional resolved: string;

---

PackageInfoClientOptions

type PackageInfoClientOptions = RegistryClientOptions &
  SpecOptions &
  object

Defined in: index.ts:42

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: index.ts:58

Type declaration

from?

optional from: string;

dir to resolve file:// specifiers against. Defaults to projectRoot.

---

Resolution

type Resolution = object

Defined in: index.ts:35

Type declaration

integrity?

optional integrity: Integrity;

resolved

resolved: string

signatures?

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

spec

spec: Spec

Functions

extract()

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

Defined in: index.ts:112

Parameters

spec

string | Spec

target

string

options

PackageInfoClientAllOptions = {}

Returns

Promise<Resolution>

---

manifest()

function manifest(spec, options): Promise<Manifest>

Defined in: index.ts:97

Parameters

spec

string | Spec

options

PackageInfoClientAllOptions = {}

Returns

Promise<Manifest>

---

packument()

function packument(spec, options): Promise<Packument>

Defined in: index.ts:92

Parameters

spec

string | Spec

options

PackageInfoClientAllOptions = {}

Returns

Promise<Packument>

---

resolve()

function resolve(spec, options): Promise<Resolution>

Defined in: index.ts:102

Parameters

spec

string | Spec

options

PackageInfoClientAllOptions = {}

Returns

Promise<Resolution>

---

tarball()

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

Defined in: index.ts:107

Parameters

spec

string | Spec

options

PackageInfoClientAllOptions = {}

Returns

Promise<Buffer>