Class TJSWebStorage

Provides the base Storage API store manager. It is recommended to use TJSLocalStorage & TJSSessionStorage for standard browser local and session storage use cases. TJSWebStorage exists to provide additional customization options for custom Storage API compatible storage instances and custom serialization configuration.

Hierarchy (view full)

Constructors

constructor

Methods

getItem getStore setItem swapItemBoolean

Constructors

constructor

  • new TJSWebStorage(storageStores): TJSWebStorage

  • Parameters

    • storageStores: StorageStores

      Provides a complete set of storage API store helper functions and the associated storage API instance and serializations strategy.

    Returns TJSWebStorage

Methods

getItem

  • getItem(key, defaultValue?): any

  • Get value from the storage API.

    Parameters

    • key: string

      Key to lookup in storage API.

    • Optional defaultValue: any

      A default value to return if key not present in session storage.

    Returns any

    Value from session storage or if not defined any default value provided.

getStore

  • getStore<T>(key, defaultValue?, storageStores?): Writable<T>

  • Returns the backing Svelte store for the given key; potentially sets a default value if the key is not already set.

    Type Parameters

    • T

    Parameters

    • key: string

      Key to lookup in storage API.

    • Optional defaultValue: T

      A default value to return if key not present in session storage.

    • Optional storageStores: StorageStores

      Additional store creation options.

    Returns Writable<T>

    The Svelte store for this key.

setItem

  • setItem(key, value): void

  • Sets the value for the given key in storage API.

    Parameters

    • key: string

      Key to lookup in storage API.

    • value: any

      A value to set for this key.

    Returns void

swapItemBoolean

  • swapItemBoolean(key, defaultValue?): boolean

  • Convenience method to swap a boolean value stored in storage API.

    Parameters

    • key: string

      Key to lookup in storage API.

    • Optional defaultValue: boolean

      A default value to return if key not present in session storage.

    Returns boolean

    The boolean swap for the given key.

Settings

Member Visibility

Theme

On This Page