Skip to main content

MetadataStore

@quik/metadata


@quik/metadata / MetadataStore

Variable: MetadataStore

const MetadataStore: object

Defined in: store.ts:75

Utility wrapper for interacting with the metadata store.

Type Declaration

all

all: () => WeakMap<DecoratorMetadataObject, Record<string, unknown>>

Get the internal metadata store.

Returns

WeakMap<DecoratorMetadataObject, Record<string, unknown>>

clear

clear: () => void

Clears retained metadata cache references.

Returns

void

get

get: <T>(metadata) => T

Retrieve stored metadata.

Type Parameters

T

T = Record<string, unknown>

Parameters

metadata

DecoratorMetadataObject

Decorator metadata identifier.

Returns

T

register

register: <T>(metadata, base) => T

Register initial metadata for a decorator.

Type Parameters

T

T extends Record<string, unknown>

Parameters

metadata

DecoratorMetadataObject

Decorator metadata identifier.

base

T

Initial data to associate with the metadata.

Returns

T

snapshot

snapshot: () => Record<string, unknown>[]

Return a snapshot array of all metadata entries, memoized between updates.

Returns

Record<string, unknown>[]