Melon-dbMelon-db
API reference@melon-db/db

SyncOutboxStore

@melon-db/db — SyncOutboxStore

@melon-db/db API Reference


Interface: SyncOutboxStore

Defined in: packages/melon-db/src/sync/types.ts:80

Methods

clear()

clear(collections?): Promise<void>

Defined in: packages/melon-db/src/sync/types.ts:88

Parameters

ParameterType
collections?string[]

Returns

Promise<void>


findByRecord()

findByRecord(collection, recordId): Promise<SyncOutboxEntry | null>

Defined in: packages/melon-db/src/sync/types.ts:82

Parameters

ParameterType
collectionstring
recordIdstring | number

Returns

Promise<SyncOutboxEntry | null>


list()

list(): Promise<SyncOutboxEntry[]>

Defined in: packages/melon-db/src/sync/types.ts:81

Returns

Promise<SyncOutboxEntry[]>


removeByRecord()

removeByRecord(collection, recordId): Promise<void>

Defined in: packages/melon-db/src/sync/types.ts:87

Parameters

ParameterType
collectionstring
recordIdstring | number

Returns

Promise<void>


upsert()

upsert(entry): Promise<void>

Defined in: packages/melon-db/src/sync/types.ts:86

Parameters

ParameterType
entrySyncOutboxEntry

Returns

Promise<void>