Interface StorageInterface

The backend storage interfaced used by StorageManager.

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

Index

Methods

load loadRange remove removeRange save

Methods

load

load(key: StorageKey): Promise<undefined | Uint8Array<ArrayBufferLike>>
Load the bytes at a given key.
Parameters
- key: StorageKey
Returns Promise<undefined | Uint8Array<ArrayBufferLike>>
- Defined in packages/leaf/src/storage.ts:22

loadRange

loadRange(
    key: StorageKey,
): Promise<
    { data: undefined
    | Uint8Array<ArrayBufferLike>; key: StorageKey }[],
>
Load all values and keys that are prefixed by the given key.
Parameters
- key: StorageKey
Returns Promise<{ data: undefined | Uint8Array<ArrayBufferLike>; key: StorageKey }[]>
- Defined in packages/leaf/src/storage.ts:28

remove

remove(key: StorageKey): Promise<void>
Remove the data at a given key.
Parameters
- key: StorageKey
Returns Promise<void>
- Defined in packages/leaf/src/storage.ts:26

removeRange

removeRange(key: StorageKey): Promise<void>
Remove all values that are prefixed by the given key.
Parameters
- key: StorageKey
Returns Promise<void>
- Defined in packages/leaf/src/storage.ts:32

save

save(key: StorageKey, data: Uint8Array): Promise<void>
Save the given data to the provided key.
Parameters
- key: StorageKey
- data: Uint8Array
Returns Promise<void>
- Defined in packages/leaf/src/storage.ts:24

Interface StorageInterface

Index

Methods

Methods

load

Parameters

Returns Promise<undefined | Uint8Array<ArrayBufferLike>>

loadRange

Parameters

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

remove

Parameters

Returns Promise<void>

removeRange

Parameters

Returns Promise<void>

save

Parameters

Returns Promise<void>

Settings

On This Page