Class StorageBackendDisk

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

Hierarchy (view full)

SyncStorage
- StorageBackendDisk

Index

Constructors

Properties

Accessors

Methods

buildStorageKey clear clearAll close contexts delete get getContextBaseKey initialize keys set values

Constructors

constructor

new StorageBackendDisk(path, clear?): StorageBackendDisk
Parameters
- path: string
- Optionalclear: boolean
Returns StorageBackendDisk
Overrides SyncStorage.constructor
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:10

Properties

`Protected`isInitialized

isInitialized: boolean

Accessors

initialized

get initialized(): boolean
Returns boolean
Overrides SyncStorage.initialized
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:11

Methods

buildStorageKey

buildStorageKey(contexts, key): string
Parameters
- contexts: string[]
- key: string
Returns string
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:16

clear

clear(): void
Returns void
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:14

clearAll

clearAll(contexts): void
Parameters
- contexts: string[]
Returns void
Overrides SyncStorage.clearAll
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:25

close

close(): void
Returns void
Overrides SyncStorage.close
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:13

contexts

contexts(contexts): string[]
Parameters
- contexts: string[]
Returns string[]
Overrides SyncStorage.contexts
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:24

delete

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

get

get<T>(contexts, key): undefined | T
Type Parameters
- T extends SupportedStorageTypes
Parameters
- contexts: string[]
- key: string
Returns undefined | T
Overrides SyncStorage.get
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:17

getContextBaseKey

getContextBaseKey(contexts, allowEmptyContext?): string
Parameters
- contexts: string[]
- OptionalallowEmptyContext: boolean
Returns string
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:15

initialize

initialize(): void
Returns void
Overrides SyncStorage.initialize
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:12

keys

keys(contexts): string[]
Returns all keys of a storage context without keys of sub-contexts
Parameters
- contexts: string[]
Returns string[]
Overrides SyncStorage.keys
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:22

set

set(contexts, key, value): void
Parameters
- contexts: string[]
- key: string
- value: SupportedStorageTypes
Returns void
Overrides SyncStorage.set
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:18
set(contexts, values): void
Parameters
- contexts: string[]
- values: Record<string, SupportedStorageTypes>
Returns void
Overrides SyncStorage.set
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:19

values

values(contexts): Record<string, SupportedStorageTypes>
Parameters
- contexts: string[]
Returns Record<string, SupportedStorageTypes>
Overrides SyncStorage.values
- Defined in packages/nodejs/dist/esm/storage/StorageBackendDisk.d.ts:23