Interface DataStore

The interface that defines how to store and fetch data associated with a message.

interface DataStore {
    clear(): Promise<void>;
    close(): Promise<void>;
    delete(tenant: string, recordId: string, dataCid: string): Promise<void>;
    get(tenant: string, recordId: string, dataCid: string): Promise<undefined | DataStoreGetResult>;
    open(): Promise<void>;
    put(tenant: string, recordId: string, dataCid: string, dataStream: Readable): Promise<DataStorePutResult>;
}

Implemented by

Methods

clear close delete get open put

Methods

clear

  • clear(): Promise<void>

  • Clears the entire store. Mainly used for testing to cleaning up in test environments.

    Returns Promise<void>

close

delete

  • delete(tenant, recordId, dataCid): Promise<void>

  • Deletes the specified data. No-op if the data does not exist.

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

    • dataCid: string

      The IPFS CID of the data.

    Returns Promise<void>

get

  • get(tenant, recordId, dataCid): Promise<undefined | DataStoreGetResult>

  • Fetches the specified data.

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

    • dataCid: string

      The IPFS CID of the data.

    Returns Promise<undefined | DataStoreGetResult>

    the data size and data stream if found, otherwise undefined.

open

put

  • put(tenant, recordId, dataCid, dataStream): Promise<DataStorePutResult>

  • Stores the given data.

    Parameters

    • tenant: string
    • recordId: string

      The logical ID of the record that references the data.

    • dataCid: string

      The IPFS CID of the data.

    • dataStream: Readable

    Returns Promise<DataStorePutResult>

Settings

Member Visibility

On This Page

Methods