FROST Hubert TypeScript Library - v1.0.0-alpha.20
    Preparing search index...

    Interface StorageClient

    Storage client interface for Hubert operations.

    Port of struct StorageClient from cmd/storage.rs.

    interface StorageClient {
        put(arid: ARID, envelope: Envelope): Promise<void>;
        get(arid: ARID, timeoutSeconds?: number): Promise<Envelope | undefined>;
        exists(arid: ARID): Promise<boolean>;
    }
    Index

    Methods

    Methods

    • Put an envelope at the given ARID.

      Parameters

      • arid: ARID
      • envelope: Envelope

      Returns Promise<void>

    • Get an envelope from the given ARID.

      Parameters

      • arid: ARID
      • OptionaltimeoutSeconds: number

      Returns Promise<Envelope | undefined>

    • Check if an envelope exists at the given ARID.

      Parameters

      • arid: ARID

      Returns Promise<boolean>