SyncMetadataApi

Defined in: packages/db/src/types.ts:488

Type Parameters

TKey

TKey extends string | number = string | number

Properties

collection

collection: object;

Defined in: packages/db/src/types.ts:496

delete()

delete: (key) => void;

Parameters

key

string

Returns

void

get()

get: (key) => unknown;

Parameters

key

string

Returns

unknown

list()

list: (prefix?) => readonly object[];

Parameters

prefix?

string

Returns

readonly object[]

set()

set: (key, value) => void;

Parameters

key

string

value

unknown

Returns

void

persistence

persistence: 
  | SyncPersistenceCapabilityV1<TKey>
  | null;

Defined in: packages/db/src/types.ts:514

Internal

Unstable, versioned bridge between persistence-aware collection adapters and sync adapters. Application code should not construct this capability. Custom adapter wrappers must forward it unchanged. null explicitly means that the collection has no persistence capability; a missing property is invalid.

Adapter infrastructure; not an application-facing API.

row

row: object;

Defined in: packages/db/src/types.ts:491

delete()

delete: (key) => void;

Parameters

key

TKey

Returns

void

get()

get: (key) => unknown;

Parameters

key

TKey

Returns

unknown

set()

set: (key, metadata) => void;

Parameters

key

TKey

metadata

unknown

Returns

void