StorageV2 class

The version 2 storage contract.

This does not extend Storage: JavaScript cannot overload methods by return type at runtime. V2 providers are exposed as separately named classes.

Methods

delete(string[], StorageDeleteOptions)

Deletes values with an optional version condition.

read<T>(string[])

Reads stored values and returns one result for every requested key.

write<T>(Record<string, T>, StorageWriteOptions)

Writes values with optional create, replace, or version conditions.

Method Details

delete(string[], StorageDeleteOptions)

Deletes values with an optional version condition.

function delete(keys: string[], options?: StorageDeleteOptions): Promise<StorageDeleteResults>

Parameters

keys

string[]

The keys to delete. An empty array is valid.

options
StorageDeleteOptions

Conditions applied to every key in the batch.

Returns

One result for every supplied key.

read<T>(string[])

Reads stored values and returns one result for every requested key.

function read<T>(keys: string[]): Promise<StorageReadResults<T>>

Parameters

keys

string[]

The keys to read. An empty array is valid.

Returns

Promise<StorageReadResults<T>>

Keyed results containing a value and storage version when found.

write<T>(Record<string, T>, StorageWriteOptions)

Writes values with optional create, replace, or version conditions.

function write<T>(changes: Record<string, T>, options?: StorageWriteOptions): Promise<StorageWriteResults>

Parameters

changes

Record<string, T>

Values indexed by their storage keys.

options
StorageWriteOptions

Conditions applied to every value in the batch.

Returns

One result for every supplied key.