XYO Platform SDK - v3.10.6
    Preparing search index...

    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<WithStorageMeta<TReadResponse>>>;
        clear(): Promisable<void>;
        commit(): PromisableArray<TWriteResponse>;
        delete(ids: TId[]): PromisableArray<TId>;
        get(
            ids: TId[],
        ): PromisableArray<WithStorageMeta<WithStorageMeta<TReadResponse>>>;
        insert(item: TWrite[]): PromisableArray<WithStorageMeta<TWriteResponse>>;
        next(
            options?: NextOptions<TId>,
        ): PromisableArray<WithStorageMeta<WithStorageMeta<TReadResponse>>>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Methods

    all clear commit delete get insert next

    Methods

    • Returns Promisable<void>

    • Parameters

      Returns PromisableArray<TId>

    Settings

    Member Visibility

    On This Page

    Methods