Interface ConflictUIBridge

interface ConflictUIBridge {
    acceptTheirs(key: string): Promise<boolean>;
    active(): ConflictBucket[];
    destroy(): void;
    keepMine(key: string): Promise<boolean>;
    on(listener: BridgeListener): () => void;
    onAcceptTheirs(kind: ConflictKind, action: ResolutionAction): () => void;
    onKeepMine(kind: ConflictKind, action: ResolutionAction): () => void;
    resolve(key: string): boolean;
}

Index

Methods

acceptTheirs active destroy keepMine on onAcceptTheirs onKeepMine resolve

Methods

acceptTheirs

acceptTheirs(key: string): Promise<boolean>
Same shape as keepMine, but for "accept theirs".
Parameters
- key: string
Returns Promise<boolean>

active

active(): ConflictBucket[]

All currently-open buckets.

Returns ConflictBucket[]

destroy

destroy(): void

Returns void

keepMine

keepMine(key: string): Promise<boolean>
Run the registered "keep mine" callback (if any) and close the bucket. Apps register the callback per kind via onKeepMine. The callback is responsible for emitting the follow-up CRDT edit that re-asserts the local user's value.
Parameters
- key: string
Returns Promise<boolean>

on

on(listener: BridgeListener): () => void
Subscribe to bucket lifecycle (open / update / close).
Parameters
- listener: BridgeListener
Returns () => void

onAcceptTheirs

onAcceptTheirs(kind: ConflictKind, action: ResolutionAction): () => void
Register an "accept theirs" handler for a given conflict kind.
Parameters
- kind: ConflictKind
- action: ResolutionAction
Returns () => void

onKeepMine

onKeepMine(kind: ConflictKind, action: ResolutionAction): () => void
Register a "keep mine" handler for a given conflict kind.
Parameters
- kind: ConflictKind
- action: ResolutionAction
Returns () => void

resolve

resolve(key: string): boolean
Mark a bucket resolved (close immediately). Useful when the UI dispatches a "keep mine" edit and wants the badge to disappear.
Parameters
- key: string
Returns boolean