Interface SourceAdapter<T, Q>

Persistence adapter for multi-document collections.

interface SourceAdapter<T, Q = unknown> {
    create(doc: T): Promise<void>;
    delete(id: string): Promise<void>;
    getStatus(): AdapterStatus;
    subscribe(
        onUpdate: (docs: T[]) => void,
        onError: (error: Error) => void,
        query?: Q,
    ): UnsubscribeFn;
    update(id: string, changes: Partial<T>): Promise<void>;
}

Type Parameters

T
Q = unknown

Implemented by

Index

Methods

create delete getStatus subscribe update

Methods

create

create(doc: T): Promise<void>
Create a document.
Parameters
- doc: T
Returns Promise<void>
- Defined in types/adapter.ts:18

delete

delete(id: string): Promise<void>
Delete a document by id.
Parameters
- id: string
Returns Promise<void>
- Defined in types/adapter.ts:24

getStatus

getStatus(): AdapterStatus
Get adapter status.

Returns AdapterStatus
- Defined in types/adapter.ts:27

subscribe(
    onUpdate: (docs: T[]) => void,
    onError: (error: Error) => void,
    query?: Q,
): UnsubscribeFn
Subscribe to raw document updates and return an unsubscribe function.
Parameters
- onUpdate: (docs: T[]) => void
- onError: (error: Error) => void
- Optionalquery: Q
Returns UnsubscribeFn
- Defined in types/adapter.ts:11

update

update(id: string, changes: Partial<T>): Promise<void>
Update a document by id.
Parameters
- id: string
- changes: Partial<T>
Returns Promise<void>
- Defined in types/adapter.ts:21

Interface SourceAdapter<T, Q>

Type Parameters

Implemented by

Index

Methods

Methods

create

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<void>

getStatus

Returns AdapterStatus

Parameters

Returns UnsubscribeFn

update

Parameters

Returns Promise<void>

Settings

On This Page