Interface Archivist<TReadResponse, TWriteResponse, TWrite, TId>

interface Archivist<
    TReadResponse extends Payload = Payload,
    TWriteResponse extends Payload = Payload,
    TWrite extends Payload = TReadResponse & Payload,
    TId = Hash,
> {
    all(): PromisableArray<WithStorageMeta<TReadResponse>>;
    clear(): Promisable<void>;
    commit(): PromisableArray<TWriteResponse>;
    delete(ids: TId[]): PromisableArray<TId>;
    get(ids: TId[]): PromisableArray<WithStorageMeta<TReadResponse>>;
    insert(item: TWrite[]): PromisableArray<WithStorageMeta<TWriteResponse>>;
    next(
        options?: NextOptions<TId>,
    ): PromisableArray<WithStorageMeta<TReadResponse>>;
}

Type Parameters

Hierarchy (View Summary)

Methods

all clear commit delete get insert next

Methods

all

clear

  • clear(): Promisable<void>

  • Returns Promisable<void>

commit

delete

  • delete(ids: TId[]): PromisableArray<TId>

  • Parameters

    Returns PromisableArray<TId>

get

insert

next

Settings

Member Visibility

On This Page

Methods