Interface StateMethods

Async storage operations for a Durable Object instance.

interface StateMethods {
    delete: ((propertyName) => Promise<any>);
    deleteAll: (() => Promise<any>);
    get: ((propertyName) => Promise<any>);
    list: ((listRequestObject?) => Promise<any>);
    put: ((putRequestObject) => Promise<any>);
}

Properties

delete deleteAll get list put

Properties

delete

delete: ((propertyName) => Promise<any>)

Deletes one or more properties.

Type declaration

    • (propertyName): Promise<any>

    • Deletes one or more properties.

      Parameters

      • propertyName: string | string[]

      Returns Promise<any>

deleteAll

deleteAll: (() => Promise<any>)

Deletes every property.

Type declaration

    • (): Promise<any>

    • Deletes every property.

      Returns Promise<any>

get

get: ((propertyName) => Promise<any>)

Reads a single property.

Type declaration

    • (propertyName): Promise<any>

    • Reads a single property.

      Parameters

      • propertyName: string

      Returns Promise<any>

list

list: ((listRequestObject?) => Promise<any>)

Lists stored entries.

Type declaration

    • (listRequestObject?): Promise<any>

    • Lists stored entries.

      Parameters

      Returns Promise<any>

put

put: ((putRequestObject) => Promise<any>)

Persists one or more properties.

Type declaration

    • (putRequestObject): Promise<any>

    • Persists one or more properties.

      Parameters

      Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc