Class CacheStorage

Cache storage wrapper

A simple wrapper around the Storage API with a TTL (Time To Live) per item.
Uses JSON.stringify and JSON.parse to serialize and deserialize data.
Uses Date.getTime() to calculate the expiration time.

Param

The storage instance (e.g., localStorage or sessionStorage).

Param

Optional key prefix

Hierarchy

CacheStorage

Implements

ICacheStorage

Index

Constructors

Properties

#keyPrefix #storage

Methods

getItem removeItem setItem

Constructors

constructor

new CacheStorage(storage, keyPrefix?): CacheStorage
Create a new CacheStorage instance
Parameters
- storage: Storage
  
  storage instance
- Optional keyPrefix: string
  
  Optional key prefix for storage keys
Returns CacheStorage

Throws
CacheStorageError

Properties

`Private` #keyPrefix

#keyPrefix: string

`Private` #storage

#storage: Storage

Methods

getItem

getItem<T>(key): null | T
Get an item from the storage if not expired
Type Parameters
- T = unknown
Parameters
- key: string
  
  key
Returns null | T

Implementation of ICacheStorage.getItem

removeItem

removeItem(key): void
Remove an item from the storage
Parameters
- key: string
  
  key
Returns void

Implementation of ICacheStorage.removeItem

setItem

setItem(key, data, ttl): void
Save an item in the storage with a ttl
Parameters
- key: string
  
  key
- data: unknown
  
  data to store
- ttl: number
  
  time to live in milliseconds
Returns void

Implementation of ICacheStorage.setItem

Generated using TypeDoc