Interface WriteArchivistFunctions<TReadResponse, TWriteResponse, TWrite, TId>

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

Type Parameters

TReadResponse
TWriteResponse = TReadResponse
TWrite = TReadResponse
TId = string

Hierarchy (View Summary)

WriteArchivistFunctions
- WriteArchivist

Index

Methods

clear delete insert

Methods

clear

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

delete

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

insert

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