Class StorageService

Service adapter for the Matter.js storage API.

Index

Constructors

Accessors

factory location

Methods

[value] open [create]

Constructors

constructor

new StorageService(environment, factory?): StorageService
Parameters
- environment: Environment
- Optionalfactory: ((namespace: string) => Storage)
  - - (namespace): Storage
    - Parameters
      namespace: string
      Returns Storage
Returns StorageService
- Defined in packages/general/src/storage/StorageService.ts:21

Accessors

factory

set factory(factory): void
Install a factory for opening storage. Without such a factory storage is unavailable.
Parameters
- factory: ((namespace: string) => Storage)
  - - (namespace): Storage
    - Parameters
      namespace: string
      Returns Storage
Returns void
- Defined in packages/general/src/storage/StorageService.ts:49

location

get location(): undefined | string
The storage location. Only used for diagnostic purposes.

Returns undefined | string
- Defined in packages/general/src/storage/StorageService.ts:56
set location(location): void
Parameters
- location: undefined | string
Returns void
- Defined in packages/general/src/storage/StorageService.ts:60

Methods

[value]

[value](): (string | Record<string, unknown> & Diagnostic)[]
Returns (string | Record<string, unknown> & Diagnostic)[]
- Defined in packages/general/src/storage/StorageService.ts:64

open

open(namespace): Promise<StorageManager<Storage>>
Open storage. The storage is initialized but the caller must take ownership.
Parameters
- namespace: string
  a unique namespace identifier such as a root node ID
Returns Promise<StorageManager<Storage>>
- Defined in packages/general/src/storage/StorageService.ts:35

`Static`[create]

[create](environment): StorageService
Parameters
- environment: Environment
Returns StorageService
- Defined in packages/general/src/storage/StorageService.ts:26