Storage

The Storage class encapsulates the access to data objects over WebStorageAPI.

Import
the javascript logo
import { Storage } from "@schukai/monster/source/data/datasource/storage.mjs";
Source
the git logo
Package
the npm logo
Since
1.22.0

Exported

Storage, storageObjectSymbol

Derived from

Datasource

Options

The Options listed in this section are defined directly within the class. This class is derived from several parent classes. Therefore, it inherits Options from these parent classes. If you cannot find a specific Options in this list, we recommend consulting the documentation of the Datasource.

Option
Type
Default
Description
key
string
undefined
ey

Properties

The Properties listed in this section are defined directly within the class. This class is derived from several parent classes. Therefore, it inherits Properties from these parent classes. If you cannot find a specific Properties in this list, we recommend consulting the documentation of the Datasource.

Methods

The methods listed in this section are defined directly within the class. This class is derived from several parent classes. Therefore, it inherits methods from these parent classes. If you cannot find a specific method in this list, we recommend consulting the documentation of the Datasource.

Constructor

constructor(key)
Parameters
  • key {string}: LocalStorage Key
Throws
  • {TypeError} value is not a string

Structural methods

getClone()
Returns
  • {Storage}

Static methods

[instanceSymbol]()2.1.0
Returns
  • {symbol}
This method is called by the instanceof operator.

Other methods

[storageObjectSymbol]()
Returns
  • {external:Storage}
Throws
  • {Error} this method must be implemented by derived classes.
read()
Returns
  • {Promise}
Throws
  • {Error} the options does not contain a valid json definition
  • {TypeError} value is not a object
  • {Error} the data cannot be read
write()
Returns
  • {Storage}
Throws
  • {Error} the data cannot be written

Events

This component does not fire any public events. It may fire events that are inherited from its parent classes.

The current width of the area is too small to display the content correctly.