Interface Storage

Matter.js uses this key/value API to manage persistent state.

interface Storage {
    initialized: boolean;
    clearAll(contexts: string[]): MaybePromise<void>;
    close(): MaybePromise<void>;
    contexts(contexts: string[]): MaybePromise<string[]>;
    delete(contexts: string[], key: string): MaybePromise<void>;
    get(contexts: string[], key: string): MaybePromise<SupportedStorageTypes>;
    initialize(): MaybePromise<void>;
    keys(contexts: string[]): MaybePromise<string[]>;
    set(contexts: string[], values: Record<string, SupportedStorageTypes>): MaybePromise<void>;
    set(contexts: string[], key: string, value: SupportedStorageTypes): MaybePromise<void>;
    values(contexts: string[]): MaybePromise<Record<string, SupportedStorageTypes>>;
}

Implemented by

Properties

initialized

Methods

clearAll close contexts delete get initialize keys set values

Properties

Readonlyinitialized

initialized: boolean

Methods

clearAll

close

contexts

delete

get

initialize

keys

set

values

Settings

Member Visibility

On This Page

Properties
Methods