browser

Type Aliases

Delimiter

type Delimiter = "~";

Defined in: browser.ts:11

DepID

type DepID = 
  | `${"" | "git"}${Delimiter}${string}${Delimiter}${string}${Delimiter}${string}`
  | `${"" | "git"}${Delimiter}${string}${Delimiter}${string}`
  | `${"file" | "remote" | "workspace"}${Delimiter}${string}${Delimiter}${string}`
  | `${"file" | "remote" | "workspace"}${Delimiter}${string}`;

Defined in: browser.ts:39

Dependency IDs are a URI-encoded set of strings, separated by the Delimiter character ('~').

The first entry is always the specifier type. The rest depend on the type. git, registry, and workspace entries have 3 fields, the rest have 2.

• registry: 'registry~<registry>~name@specifier' The <registry> portion can be a known named registry name, or a url to a registry. If empty, it is the default registry. Examples:
  • ~~some-package@2.0.1
  • ~npm~whatever@1.2.3
  • ~http%3A%2F%2Fvlt.sh%2F~x@1.2.3
• git: 'git~<git remote>~<git selector>'. For example:
  • git~github:user/project~branchname
  • git~git%2Bssh%3A%2F%2Fuser%40host%3Aproject.git~semver:1.x
• workspace: 'workspace~<path>'. For example:
  • workspace~src/mything
• remote: 'remote~<url>'
• file: 'file~<path>'

Lastly, the final portion can contain arbitrary string data, and is used to store peer dep resolutions to maintain the peerDep contract.

DepIDTuple

type DepIDTuple = 
  | ["git", string, string, string]
  | ["registry", string, string, string]
  | ["file", string, string]
  | ["remote", string, string]
  | ["workspace", string, string];

Defined in: browser.ts:48

A DepID, split apart and URI-decoded

Variables

delimiter

const delimiter: Delimiter = '~';

Defined in: browser.ts:10

Functions

asDepID()

function asDepID(str): DepID

Defined in: browser.ts:86

Parameters

Returns

DepID

baseDepID()

function baseDepID(id): DepID

Defined in: browser.ts:330

Retrieves the base DepID for a given depID, ignoring any extra information that may be present.

Parameters

Returns

DepID

getId()

function getId(
   spec, 
   mani, 
   extra?): DepID

Defined in: browser.ts:626

Get the DepID for a given Spec and Manifest. The Manifest is used to get the name and version, if possible. If not found in the manifest, registry ID types will use the name or bareSpec from the specifier, so at least there's something to use later.

Parameters

Returns

DepID

getTuple()

function getTuple(
   spec, 
   mani, 
   extra?): DepIDTuple

Defined in: browser.ts:531

Get the DepIDTuple for a given Spec and Manifest. The Manifest is used to get the name and version, if possible. If not found in the manifest, registry ID types will use the name or bareSpec from the specifier, so at least there's something to use later.

Parameters

Returns

DepIDTuple

hydrate()

function hydrate(
   id, 
   name?, 
   options?): Spec

Defined in: browser.ts:346

Turn a DepID into a Spec object

Parameters

Returns

Spec

hydrateTuple()

function hydrateTuple(
   tuple, 
   name?, 
   options?): Spec

Defined in: browser.ts:365

Turn a DepIDTuple into a Spec object

Parameters

Returns

Spec

isDepID()

function isDepID(str): str is DepID

Defined in: browser.ts:81

Parameters

Returns

str is DepID

isPackageNameConfused()

function isPackageNameConfused(spec?, name?): boolean

Defined in: browser.ts:614

Checks for a potentially manifest-confused package name. Returns true if the package name is confused, false otherwise.

Parameters

Returns

boolean

joinDepIDTuple()

function joinDepIDTuple(list): DepID

Defined in: browser.ts:99

turn a DepIDTuple into a DepID

Parameters

Returns

DepID

joinExtra()

function joinExtra(__namedParameters): undefined | string

Defined in: browser.ts:635

Join a modifier and a peer set hash into a single "extra" string.

Parameters

Returns

undefined | string

resetCaches()

function resetCaches(): void

Defined in: browser.ts:679

Reset internal caches. This should be used when options change since they're not take into account in the memoization keys.

Returns

void

splitDepID()

function splitDepID(id): DepIDTuple

Defined in: browser.ts:285

turn a DepID into a DepIDTuple

Parameters

Returns

DepIDTuple

splitExtra()

function splitExtra(extra): object

Defined in: browser.ts:651

Split an "extra" string into a modifier and a peerSetHash.

Parameters

Returns

object