IdPlugin.

Classes

IdPlugableClass

Extends PlugableClass.

new IdPlugableClass(): IdPlugableClass

Returns IdPlugableClass. Inherited from PlugableClass.constructor.

PropertyType
functionsFunctionRecord

Methods

global(): `${string}-${string}-${string}-${string}-${string}`

Returns `${string}-${string}-${string}-${string}-${string}`.

install(definition, …ids): void | Errored

ParameterTypeDescription
definitionstring | Function | StringTuple
idsstring[]

Returns void | Errored. Inherited from PlugableClass.install.

local(prefix?): `${string}-${number}`

Simple local ID typically used within a single context.
ParameterTypeDescription
prefix?string

Returns `${string}-${number}`.

string(content?): Promise<DataOrError<string>>

ParameterTypeDescription
content?string

Returns Promise<DataOrError<string>>.

temp(): `00000000-${string}-${string}-${string}-${string}`

Returns `00000000-${string}-${string}-${string}-${string}`.

toString(): string

Returns string. Inherited from PlugableClass.toString.

Interfaces

Identified

Extended by Instance, TranslateArgs, Exporter, Importer, DataRow, ContentObject, IdQuery, RunningCommand, and MMExpress.

PropertyType
idstring

Variables

ID_PREFIX_TEMPORARY

const ID_PREFIX_TEMPORARY: "00000000"

IdPlugin

const IdPlugin: IdPlugableClass

Functions

idIsTemporary

idIsTemporary(value): value is `00000000-${string}-${string}-${string}-${string}`

ParameterType
valueunknown

Returns value is `00000000-${string}-${string}-${string}-${string}`.

idLocal

idLocal(prefix?): LocalId | undefined

ParameterType
prefix?string

Returns LocalId | undefined.

idString

idString(content?): Promise<DataOrError<string>>

ParameterType
content?string

Returns Promise<DataOrError<string>>.

idTemp

idTemp(): TemporaryUuid

Returns TemporaryUuid.

idUuid

idUuid(): Uuid

Returns Uuid.