Class StorageBackendJsonFile

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

Hierarchy (view full)

StorageBackendMemory
- StorageBackendJsonFile

Index

Constructors

Properties

committed isInitialized store commitDelay

Accessors

data initialized

Methods

clear clearAll close contexts delete get initialize keys set values create

Constructors

constructor

new StorageBackendJsonFile(path): StorageBackendJsonFile
Parameters
- path: string
Returns StorageBackendJsonFile
Overrides StorageBackendMemory.constructor
- Defined in packages/nodejs/dist/esm/storage/StorageBackendJsonFile.d.ts:15

Properties

committed

committed: Promise<void>

`Protected`isInitialized

isInitialized: boolean

`Protected`store

store: any

`Static`commitDelay

commitDelay: number

We store changes after a value was set to the storage, but not more often than this setting (in ms).

Accessors

data

get data(): any
Returns any
Inherited from StorageBackendMemory.data
- Defined in packages/general/dist/esm/storage/StorageBackendMemory.d.ts:19

initialized

get initialized(): boolean
Returns boolean
Inherited from StorageBackendMemory.initialized
- Defined in packages/general/dist/esm/storage/StorageBackendMemory.d.ts:13

Methods

clear

clear(): void
Returns void
Overrides StorageBackendMemory.clear
- Defined in packages/nodejs/dist/esm/storage/StorageBackendJsonFile.d.ts:21

clearAll

clearAll(contexts): void
Parameters
- contexts: string[]
Returns void
Inherited from StorageBackendMemory.clearAll
- Defined in packages/general/dist/esm/storage/StorageBackendMemory.d.ts:26

close

close(): Promise<void>
Returns Promise<void>
Overrides StorageBackendMemory.close
- Defined in packages/nodejs/dist/esm/storage/StorageBackendJsonFile.d.ts:23

contexts

contexts(contexts): string[]
Parameters
- contexts: string[]
Returns string[]
Inherited from StorageBackendMemory.contexts
- Defined in packages/general/dist/esm/storage/StorageBackendMemory.d.ts:25

delete

delete(contexts, key): void
Parameters
- contexts: string[]
- key: string
Returns void
Overrides StorageBackendMemory.delete
- Defined in packages/nodejs/dist/esm/storage/StorageBackendJsonFile.d.ts:20

get

get<T>(contexts, key): undefined | T
Type Parameters
- T extends SupportedStorageTypes
Parameters
- contexts: string[]
- key: string
Returns undefined | T
Inherited from StorageBackendMemory.get
- Defined in packages/general/dist/esm/storage/StorageBackendMemory.d.ts:20

initialize

initialize(): Promise<void>
Returns Promise<void>
Overrides StorageBackendMemory.initialize
- Defined in packages/nodejs/dist/esm/storage/StorageBackendJsonFile.d.ts:17

keys

keys(contexts): string[]
Parameters
- contexts: string[]
Returns string[]
Inherited from StorageBackendMemory.keys
- Defined in packages/general/dist/esm/storage/StorageBackendMemory.d.ts:23

set

set(contexts, keyOrValues, value?): void
Parameters
- contexts: string[]
- keyOrValues: string | Record<string, SupportedStorageTypes>
- Optionalvalue: SupportedStorageTypes
Returns void
Overrides StorageBackendMemory.set
- Defined in packages/nodejs/dist/esm/storage/StorageBackendJsonFile.d.ts:19

values

values(contexts): Record<string, SupportedStorageTypes>
Parameters
- contexts: string[]
Returns Record<string, SupportedStorageTypes>
Inherited from StorageBackendMemory.values
- Defined in packages/general/dist/esm/storage/StorageBackendMemory.d.ts:24

`Static`create

create(path): Promise<StorageBackendJsonFile>
Parameters
- path: string
Returns Promise<StorageBackendJsonFile>
Overrides StorageBackendMemory.create
- Defined in packages/nodejs/dist/esm/storage/StorageBackendJsonFile.d.ts:16