Interface StorageInterface

The backend storage interfaced used by StorageManager.

interface StorageInterface {
    load(key: StorageKey): Promise<Uint8Array<ArrayBufferLike>>;
    loadRange(
        key: StorageKey,
    ): Promise<{ data: Uint8Array<ArrayBufferLike>; key: StorageKey }[]>;
    remove(key: StorageKey): Promise<void>;
    removeRange(key: StorageKey): Promise<void>;
    save(key: StorageKey, data: Uint8Array): Promise<void>;
}

Methods

load loadRange remove removeRange save

Methods

load

  • load(key: StorageKey): Promise<Uint8Array<ArrayBufferLike>>

    Load the bytes at a given key.

    Parameters

    Returns Promise<Uint8Array<ArrayBufferLike>>

loadRange

  • loadRange(
        key: StorageKey,
    ): Promise<{ data: Uint8Array<ArrayBufferLike>; key: StorageKey }[]>

    Load all values and keys that are prefixed by the given key.

    Parameters

    Returns Promise<{ data: Uint8Array<ArrayBufferLike>; key: StorageKey }[]>

remove

removeRange

  • removeRange(key: StorageKey): Promise<void>

    Remove all values that are prefixed by the given key.

    Parameters

    Returns Promise<void>

save

  • save(key: StorageKey, data: Uint8Array): Promise<void>

    Save the given data to the provided key.

    Parameters

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods