Class WebLocalStorage<T>

web端 localStorage的封装

Type Parameters

T extends string = string

Hierarchy (View Summary)

AbstractStorage<T>
- WebLocalStorage

Index

Constructors

Properties

Methods

clearPrefixedStorageKeys clearStorage clearStorageSync getFullKey getKeys getStorage getStorageInfo getStorageInfoSync getStorageSync Keys parse removePrefix removeStorage removeStorageSync setStorage setStorageSync stringify

Constructors

constructor

new WebLocalStorage<T extends string = string>(
options?: StorageOptions,
): WebLocalStorage<T>
Type Parameters
- T extends string = string
Parameters
- Optionaloptions: StorageOptions
Returns WebLocalStorage<T>
Overrides AbstractStorage.constructor
- Defined in src/modules/storage.ts:110

Properties

`Protected`prefix

prefix: string

Methods

`Protected`clearPrefixedStorageKeys

clearPrefixedStorageKeys(storage: Storage): void
按当前实例的命名空间清理存储区键值。
Parameters
- storage: Storage
  要清理的存储对象
Returns void
无返回值
Inherited from AbstractStorage.clearPrefixedStorageKeys
- Defined in src/modules/storage.ts:54

clearStorage

clearStorage(): Promise<void>
异步清理localStorage；配置 prefix 时只清当前命名空间，否则清空整个存储区。

Returns Promise<void>
Promise 对象，完成后无返回值
Overrides AbstractStorage.clearStorage
- Defined in src/modules/storage.ts:165

clearStorageSync

clearStorageSync(): void
同步清理localStorage；配置 prefix 时只清当前命名空间，否则清空整个存储区，并清理缓存。

Returns void
无返回值
- Defined in src/modules/storage.ts:172

`Protected`getFullKey

getFullKey(key: T): string
获取带前缀的完整key
Parameters
- key: T
Returns string
Inherited from AbstractStorage.getFullKey
- Defined in src/modules/storage.ts:35

getKeys

getKeys(): T[]
Returns T[]
- Defined in src/modules/storage.ts:147

getStorage

getStorage(key: T): Promise<unknown>
Parameters
- key: T
Returns Promise<unknown>
Overrides AbstractStorage.getStorage
- Defined in src/modules/storage.ts:191

getStorageInfo

getStorageInfo(): Promise<StorageInfo>
获取存储相关信息异步

Returns Promise<StorageInfo>
Overrides AbstractStorage.getStorageInfo
- Defined in src/modules/storage.ts:157

getStorageInfoSync

getStorageInfoSync(): StorageInfo
获取存储相关信息

Returns StorageInfo
Overrides AbstractStorage.getStorageInfoSync
- Defined in src/modules/storage.ts:116

getStorageSync

getStorageSync(key: T): unknown
Parameters
- key: T
Returns unknown
Overrides AbstractStorage.getStorageSync
- Defined in src/modules/storage.ts:202

Keys

Keys(): T[]
Returns T[]
Deprecated
使用 getKeys() 替代
- Defined in src/modules/storage.ts:143

parse

parse(value: string): unknown
Parameters
- value: string
Returns unknown
Inherited from AbstractStorage.parse
- Defined in src/modules/storage.ts:93

`Protected`removePrefix

removePrefix(fullKey: string): string
从完整key中移除前缀
Parameters
- fullKey: string
Returns string
Inherited from AbstractStorage.removePrefix
- Defined in src/modules/storage.ts:42

removeStorage

removeStorage(key: T): Promise<void>
Parameters
- key: T
Returns Promise<void>
Overrides AbstractStorage.removeStorage
- Defined in src/modules/storage.ts:185

removeStorageSync

removeStorageSync(key: T): void
Parameters
- key: T
Returns void
Overrides AbstractStorage.removeStorageSync
- Defined in src/modules/storage.ts:178

setStorage

setStorage(key: T, value: unknown): Promise<void>
Parameters
- key: T
- value: unknown
Returns Promise<void>
Overrides AbstractStorage.setStorage
- Defined in src/modules/storage.ts:188

setStorageSync

setStorageSync(key: T, value: unknown): void
Parameters
- key: T
- value: unknown
Returns void
Overrides AbstractStorage.setStorageSync
- Defined in src/modules/storage.ts:195

stringify

stringify(value: unknown): string
Parameters
- value: unknown
Returns string
Inherited from AbstractStorage.stringify
- Defined in src/modules/storage.ts:90