Class WebLocalStorage<T>

web端 localStorage的封装

Type Parameters

T extends string = string

Hierarchy (View Summary)

AbstractStorage<T>
- WebLocalStorage

Index

Constructors

Properties

Methods

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:84

Properties

`Protected`prefix

prefix: string

Methods

clearStorage

clearStorage(): Promise<void>
Returns Promise<void>
Overrides AbstractStorage.clearStorage
- Defined in src/modules/storage.ts:135

clearStorageSync

clearStorageSync(): void
清理localStorage，并清理缓存

Returns void
- Defined in src/modules/storage.ts:141

`Protected`getFullKey

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

getKeys

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

getStorage

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

getStorageInfo

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

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

getStorageInfoSync

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

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

getStorageSync

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

Keys

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

parse

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

`Protected`removePrefix

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

removeStorage

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

removeStorageSync

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

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:157

setStorageSync

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

stringify

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