Skip to content
packagesdep-idbrowser

@vltpkg/dep-id/browser

Type Aliases

Delimiter

type Delimiter = '·'

Defined in: browser.ts:6

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

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:
  • 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:42

A DepID, split apart and URI-decoded

Variables

delimiter

const delimiter: Delimiter = '·'

Defined in: browser.ts:5

Functions

asDepID()

function asDepID(str): DepID

Defined in: browser.ts:72

Parameters

str

string

Returns

DepID

hydrate()

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

Defined in: browser.ts:145

Turn a DepID into a Spec object

Parameters

id

DepID

name?

string

options?

SpecOptions = {}

Returns

Spec

hydrateTuple()

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

Defined in: browser.ts:154

Turn a DepIDTuple into a Spec object

Parameters

tuple

DepIDTuple

name?

string

options?

SpecOptions = {}

Returns

Spec

isDepID()

function isDepID(str): str is DepID

Defined in: browser.ts:69

Parameters

str

unknown

Returns

str is DepID

joinDepIDTuple()

function joinDepIDTuple(list): DepID

Defined in: browser.ts:84

turn a DepIDTuple into a DepID

Parameters

list

DepIDTuple

Returns

DepID

splitDepID()

function splitDepID(id): DepIDTuple

Defined in: browser.ts:107

turn a DepID into a DepIDTuple

Parameters

id

string

Returns

DepIDTuple