Interface WriteArchivist<TReadResponse, TWriteResponse, TWrite, TId>

interface WriteArchivist<
    TReadResponse extends Payload = Payload,
    TWriteResponse extends Payload = TReadResponse,
    TWrite extends Payload = TReadResponse,
    TId = Hash,
> {
    clear(): Promisable<void>;
    delete(ids: TId[]): PromisableArray<TId>;
    insert(item: TWrite[]): PromisableArray<TWriteResponse>;
}

Type Parameters

TReadResponse extends Payload = Payload
TWriteResponse extends Payload = TReadResponse
TWrite extends Payload = TReadResponse
TId = Hash

Hierarchy (View Summary)

WriteArchivistFunctions<
    WithStorageMeta<TReadResponse>,
    TWriteResponse,
    TWrite,
    TId,
>
- WriteArchivist
  - ReadWriteArchivist
  - Archivist

Index

Methods

clear delete insert

Methods

clear

clear(): Promisable<void>
Returns Promisable<void>
Inherited from WriteArchivistFunctions.clear
- Defined in packages/modules/packages/archivist/packages/model/src/ArchivistFunctions.ts:15

delete

delete(ids: TId[]): PromisableArray<TId>
Parameters
- ids: TId[]
Returns PromisableArray<TId>
Inherited from WriteArchivistFunctions.delete
- Defined in packages/modules/packages/archivist/packages/model/src/ArchivistFunctions.ts:16

insert

insert(item: TWrite[]): PromisableArray<TWriteResponse>
Parameters
- item: TWrite[]
Returns PromisableArray<TWriteResponse>
Inherited from WriteArchivistFunctions.insert
- Defined in packages/modules/packages/archivist/packages/model/src/ArchivistFunctions.ts:17