Class Storage

Provides access to the Web Storage.

Hierarchy

EventTarget
- Storage

Implements

Disposable
Iterable<[string, any], void, void>

Index

Properties

`Static` `Readonly`changeEvent

changeEvent: "webstorage:change"

The change event type.

Accessors

keys

get keys(): Set<string>
The keys of this storage.

Returns Set<string>
- Defined in src/Storage.ts:38

length

get length(): number
The number of entries in this storage.

Returns number
- Defined in src/Storage.ts:46

Methods

[dispose]

"[dispose]"(): void
Releases any resources associated with this object.

Returns void
Implementation of Disposable.[dispose]
- Defined in src/Storage.ts:71

[iterator]

"[iterator]"(): Iterator<[string, any], void, void>
Returns a new iterator that allows iterating the entries of this storage.

Returns Iterator<[string, any], void, void>
An iterator for the entries of this storage.
Implementation of Iterable.[iterator]
- Defined in src/Storage.ts:79

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

clear

clear(): void
Removes all entries from this storage.

Returns void
- Defined in src/Storage.ts:86

delete

delete<T>(key: string): null | T
Removes the value associated with the specified key.
Type Parameters
- T
Parameters
- key: string
  The storage key.
Returns null | T
The value associated with the key before it was removed.
- Defined in src/Storage.ts:95

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

dispose

dispose(): void
Cancels the subscription to the global storage events.

Returns void
- Defined in src/Storage.ts:105

get

get<T>(key: string): null | T
Gets the deserialized value associated with the specified key.
Type Parameters
- T
Parameters
- key: string
  The storage key.
Returns null | T
The storage value, or null if the key does not exist or the value cannot be deserialized.
- Defined in src/Storage.ts:114

has

has(key: string): boolean
Gets a value indicating whether this storage contains the specified key.
Parameters
- key: string
  The storage key.
Returns boolean
true if this storage contains the specified key, otherwise false.
- Defined in src/Storage.ts:124

onChange

onChange(listener: (event: StorageEvent) => void): this
Registers a function that will be invoked whenever the change event is triggered.
Parameters
- listener: (event: StorageEvent) => void
  The event handler to register.
Returns this
This instance.
- Defined in src/Storage.ts:133

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

set

set(key: string, value: unknown): this
Serializes and associates a given value with the specified key.
Parameters
- key: string
  The storage key.
- value: unknown
  The storage value.
Returns this
This instance.
- Defined in src/Storage.ts:144

`Static`local

local(options?: StorageOptions): Storage
Creates a new local storage service.
Parameters
- options: StorageOptions = {}
  An object providing values to initialize the service.
Returns Storage
The newly created service.
- Defined in src/Storage.ts:55

`Static`session

session(options?: StorageOptions): Storage
Creates a new session storage service.
Parameters
- options: StorageOptions = {}
  An object providing values to initialize the service.
Returns Storage
The newly created service.
- Defined in src/Storage.ts:64

Class Storage

Hierarchy

Implements

Index

Properties

Accessors

Methods

Properties

Static ReadonlychangeEvent

Accessors

keys

Returns Set<string>

length

Returns number

Methods

[dispose]

Returns void

[iterator]

Returns Iterator<[string, any], void, void>

addEventListener

Parameters

Returns void

clear

Returns void

delete

Type Parameters

Parameters

Returns null | T

dispatchEvent

Parameters

Returns boolean

dispose

Returns void

get

Type Parameters

Parameters

Returns null | T

has

Parameters

Returns boolean

onChange

Parameters

Returns this

removeEventListener

Parameters

Returns void

set

Parameters

Returns this

Staticlocal

Parameters

Returns Storage

Staticsession

Parameters

Returns Storage

Settings

On This Page

`Static` `Readonly`changeEvent

`Static`local

`Static`session