Class WebStore

constructor

• new WebStore(storage?: "local" | "session"): WebStore

  Parameters

  • storage: "local" | "session" = STORAGE.Local

  Returns WebStore

[toStringTag]

Staticlocal

• get local(): WebStore

  Lazy getter for the localStorage wrapper instance.

  Returns WebStore

  The WebStore instance for localStorage

Staticsession

• get session(): WebStore

  Lazy getter for the sessionStorage wrapper instance.

  Returns WebStore

  The WebStore instance for sessionStorage

clear

• clear(): WebStore

  Clear all items from this storage instance.

  Returns WebStore

  The WebStore instance for chaining

del

• del(...keys: PropertyKey[]): WebStore

  Delete specific keys from storage.

  Parameters

  • ...keys: PropertyKey[]

    The keys to remove

  Returns WebStore

  The WebStore instance for chaining

entries

• entries<T>(...keys: PropertyKey[]): [PropertyKey, T][]

  Get an array of [key, value] entries currently in storage.

  Type Parameters

  • T

  Parameters

  • ...keys: PropertyKey[]

    Optional keys to filter the entries by

  Returns [PropertyKey, T][]

  An array of key-value tuples

from

• from(store: Property<any>): WebStore

  Populate the storage from an existing object map.

  Parameters

  • store: Property<any>

    The object/dictionary to populate from

  Returns WebStore

  The WebStore instance for chaining

get

• get<T>(key: PropertyKey, dflt?: T): T | null

  Retrieve a value from storage, optionally providing a default.

  Type Parameters

  • T

  Parameters

  • key: PropertyKey

    The property key to retrieve

  • Optionaldflt: T

    An optional default value if the key does not exist

  Returns T | null

  The parsed object from storage, or the default/null if not found

keys

• keys(...keys: PropertyKey[]): PropertyKey[]

  Get an array of keys currently in storage. If specific keys are provided, filters by those.

  Parameters

  • ...keys: PropertyKey[]

    Optional keys to filter by

  Returns PropertyKey[]

  An array of string/symbol keys

set

• set(key?: PropertyKey, obj?: unknown, opt?: { merge: boolean }): WebStore

  Store or merge a value into storage for a given key.

  Parameters

  • Optionalkey: PropertyKey

    The property key to set. If nullish, clears the store.

  • Optionalobj: unknown

    The value to store

  • opt: { merge: boolean } = ...

    Options (merge behavior)

  Returns WebStore

  The WebStore instance for chaining

values

• values<T>(...keys: PropertyKey[]): T[]

  Get an array of values currently in storage.

  Type Parameters

  • T

  Parameters

  • ...keys: PropertyKey[]

    Optional keys to retrieve values for

  Returns T[]

  An array of parsed values