Class LocalStorageMap<K, V>

A map that stores data in local storage with prefixed keys. Note that this does not preserve insertion order.

Type Parameters

K extends string
V extends string

Hierarchy

SyncMapBatchAdapter<K, V>
- LocalStorageMap

Implements

MaybeAsyncMap<K, V>
MaybeAsyncMapBatch<K, V>
Map<K, V>
Iterable<[K, V]>
KeyValueIterable<K, V>

Index

Constructors

Properties

Accessors

[toStringTag] size

Methods

[iterator] clear decodeKey delete deleteMany encodeKey entries forEach get getMany getValue has hasMany keys set setMany updateMany values

Constructors

constructor

new LocalStorageMap<K, V>(prefix?, storage?): LocalStorageMap<K, V>
Type Parameters
- K extends string
- V extends string
Parameters
- prefix: string = ''
  Unique prefix for keys.
- storage: Storage = window.localStorage
  The underlying storage.
Returns LocalStorageMap<K, V>
Overrides SyncMapBatchAdapter<K, V>.constructor
- Defined in collections/src/impl/storagemap.ts:13

Properties

`Protected` `Readonly` prefix

prefix: string = ''

Unique prefix for keys.

`Protected` `Readonly` storage

storage: Storage = window.localStorage

The underlying storage.

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Implementation of Map.[toStringTag]
- Defined in collections/src/impl/storagemap.ts:101

size

get size(): number
Returns the size of this map. Note that this is a heavy operation that loops through the storage to count the number of keys with matching prefix.

Returns number
Implementation of Map.size
- Defined in collections/src/impl/storagemap.ts:27

Methods

[iterator]

[iterator](): IterableIterator<[K, V]>
Returns IterableIterator<[K, V]>
Implementation of Map.[iterator]
- Defined in collections/src/impl/storagemap.ts:97

clear

clear(): void
Returns void
Implementation of Map.clear
- Defined in collections/src/impl/storagemap.ts:55

`Private` decodeKey

decodeKey(key): undefined | K
Parameters
- key: null | string
Returns undefined | K
- Defined in collections/src/impl/storagemap.ts:109

delete

delete(key): boolean
Deletes an entry by key from the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: K
Returns boolean
Implementation of MaybeAsyncMap.delete
Overrides SyncMapBatchAdapter.delete
- Defined in collections/src/impl/storagemap.ts:48

deleteMany

deleteMany(keys, options?): IterableIterator<undefined | CodedError<K, unknown>>
Deletes the values with given keys.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns IterableIterator<undefined | CodedError<K, unknown>>
Implementation of MaybeAsyncMapBatch.deleteMany
Inherited from SyncMapBatchAdapter.deleteMany
- Defined in collections/src/impl/batchmap.ts:41

`Private` encodeKey

encodeKey(key): string
Parameters
- key: K
Returns string
- Defined in collections/src/impl/storagemap.ts:105

entries

entries(): IterableIterator<[K, V]>
Queries key-value pairs by given criteria.

Returns IterableIterator<[K, V]>
Implementation of KeyValueIterable.entries
- Defined in collections/src/impl/storagemap.ts:88

forEach

forEach(callbackfn, thisArg?): void
Parameters
- callbackfn: ((value, key, map) => void)
  - - (value, key, map): void
    - Parameters
      value: V
      key: K
      map: LocalStorageMap<K, V>
      Returns void
- Optional thisArg: unknown
Returns void
Implementation of Map.forEach
- Defined in collections/src/impl/storagemap.ts:64

get

get(key): undefined | V
Gets a value by key from the map.
Parameters
- key: K
Returns undefined | V
Implementation of MaybeAsyncMap.get
Overrides SyncMapBatchAdapter.get
- Defined in collections/src/impl/storagemap.ts:35

getMany

getMany(keys, options?): IterableIterator<undefined | V>
Gets the list of data identified by given keys.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns IterableIterator<undefined | V>
Implementation of MaybeAsyncMapBatch.getMany
Inherited from SyncMapBatchAdapter.getMany
- Defined in collections/src/impl/batchmap.ts:11

`Private` getValue

getValue(keyString): undefined | V
Parameters
- keyString: null | string
Returns undefined | V
- Defined in collections/src/impl/storagemap.ts:116

has

has(key): boolean
Returns whether a key exists in the map.
Parameters
- key: K
Returns boolean
Implementation of MaybeAsyncMap.has
Overrides SyncMapBatchAdapter.has
- Defined in collections/src/impl/storagemap.ts:39

hasMany

hasMany(keys, options?): IterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns IterableIterator<boolean>
Implementation of MaybeAsyncMapBatch.hasMany
Inherited from SyncMapBatchAdapter.hasMany
- Defined in collections/src/impl/batchmap.ts:18

keys

keys(): IterableIterator<K>
Queries keys by given criteria.

Returns IterableIterator<K>
Implementation of KeyValueIterable.keys
- Defined in collections/src/impl/storagemap.ts:70

set

set(key, value): LocalStorageMap<K, V>
Sets an entry in the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: K
- value: V
Returns LocalStorageMap<K, V>
Implementation of MaybeAsyncMap.set
Overrides SyncMapBatchAdapter.set
- Defined in collections/src/impl/storagemap.ts:43

setMany

setMany(entries, options?): IterableIterator<undefined | CodedError<K, unknown>>
Sets given list of entries.
Parameters
- entries: Iterable<[K, V]>
- Optional options: AbortOptions
Returns IterableIterator<undefined | CodedError<K, unknown>>
Implementation of MaybeAsyncMapBatch.setMany
Inherited from SyncMapBatchAdapter.setMany
- Defined in collections/src/impl/batchmap.ts:25

updateMany

updateMany(entries, options?): IterableIterator<undefined | Error>
Sets or deletes given list of entries.
Parameters
- entries: Iterable<[K, V?]>
- Optional options: AbortOptions
Returns IterableIterator<undefined | Error>
Implementation of MaybeAsyncMapBatch.updateMany
Inherited from SyncMapBatchAdapter.updateMany
- Defined in collections/src/impl/batchmap.ts:57

values

values(): IterableIterator<V>
Queries values by given criteria.

Returns IterableIterator<V>
Implementation of KeyValueIterable.values
- Defined in collections/src/impl/storagemap.ts:79

Generated using TypeDoc