Interface ConflictsDBInstance

Public API of the conflicts store.

interface ConflictsDBInstance {
    put(record: ConflictRecord): Promise<void>;
    get(layerId: string, localId: string): Promise<ConflictRecord | null>;
    listByLayer(layerId: string): Promise<ConflictRecord[]>;
    list(): Promise<ConflictRecord[]>;
    remove(layerId: string, localId: string): Promise<void>;
    clear(layerId?: string): Promise<void>;
}

Index

Methods

put get listByLayer list remove clear

Methods

put

put(record: ConflictRecord): Promise<void>
Writes one settled conflict, replacing the entity's previous one.
Parameters
- record: ConflictRecord
Returns Promise<void>
- Defined in packages/core/src/capabilities/offline/db/conflicts.ts:42

get

get(layerId: string, localId: string): Promise<ConflictRecord | null>
The conflict kept for one entity, or null when none was archived for it.
Parameters
- layerId: string
- localId: string
Returns Promise<ConflictRecord | null>
- Defined in packages/core/src/capabilities/offline/db/conflicts.ts:44

listByLayer

listByLayer(layerId: string): Promise<ConflictRecord[]>
Every conflict of one layer, via the composed key — no secondary index needed.
Parameters
- layerId: string
Returns Promise<ConflictRecord[]>
- Defined in packages/core/src/capabilities/offline/db/conflicts.ts:46

list

list(): Promise<ConflictRecord[]>
Every conflict, across every layer, in key order.

Returns Promise<ConflictRecord[]>
- Defined in packages/core/src/capabilities/offline/db/conflicts.ts:48

remove

remove(layerId: string, localId: string): Promise<void>
Drops one entity's conflict — a no-op when it holds none.
Parameters
- layerId: string
- localId: string
Returns Promise<void>
- Defined in packages/core/src/capabilities/offline/db/conflicts.ts:50

clear

clear(layerId?: string): Promise<void>
Drops one layer's conflicts, or all of them when layerId is omitted.
Parameters
- OptionallayerId: string
Returns Promise<void>
- Defined in packages/core/src/capabilities/offline/db/conflicts.ts:52

Interface ConflictsDBInstance

Index

Methods

Methods

put

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<ConflictRecord | null>

listByLayer

Parameters

Returns Promise<ConflictRecord[]>

list

Returns Promise<ConflictRecord[]>

remove

Parameters

Returns Promise<void>

clear

Parameters

Returns Promise<void>

Settings

On This Page