StorageWriteOptions interface

Options applied to every item in a version 2 write operation.

Properties

expectedVersion

The storage version that must match before writing.

mode

The condition controlling whether existing items may be written.

ttl

Optional time to live, in seconds, for written items.

When set, storage providers stop returning the written items after this duration has elapsed. Values must be finite numbers greater than zero.

Property Details

expectedVersion

The storage version that must match before writing.

expectedVersion?: string

Property Value

string

mode

The condition controlling whether existing items may be written.

mode?: StorageWriteMode

Property Value

ttl

Optional time to live, in seconds, for written items.

When set, storage providers stop returning the written items after this duration has elapsed. Values must be finite numbers greater than zero.

ttl?: number

Property Value

number