Class WebSessionStorage<T>

web端 sessionStorage的封装

Type Parameters

T extends string = string

Hierarchy (View Summary)

AbstractStorage<T>
- WebSessionStorage

Constructors

constructor

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

Properties

`Protected`prefix

prefix: string

Methods

autoSaveForm

autoSaveForm(formId: string, interval?: number): () => void
表单数据自动保存
Parameters
- formId: string
- interval: number = 5000
Returns () => void
- Defined in src/modules/storage.ts:513

cleanExpiredSnapshots

cleanExpiredSnapshots(maxAge?: number): void
清理过期的快照数据
Parameters
- maxAge: number = ...
Returns void
- Defined in src/modules/storage.ts:565

clearStorage

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

clearStorageSync

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

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

createSnapshot

createSnapshot(snapshotId: string, state: Record<string, unknown>): void
页面状态快照
Parameters
- snapshotId: string
- state: Record<string, unknown>
Returns void
- Defined in src/modules/storage.ts:548

`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:373

getStorage

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

getStorageInfo

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

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

getStorageInfoSync

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

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

getStorageSync

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

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

removeStorageSync

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

restoreFromLocalStorage

restoreFromLocalStorage(keys?: T[]): void
从 localStorage 恢复数据
Parameters
- Optionalkeys: T[]
Returns void
- Defined in src/modules/storage.ts:489

restoreSnapshot

restoreSnapshot(snapshotId: string): any
恢复页面状态快照
Parameters
- snapshotId: string
Returns any
- Defined in src/modules/storage.ts:558

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

setStorageSync

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

stringify

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

syncToLocalStorage

syncToLocalStorage(keys?: T[]): void
与 localStorage 同步数据
Parameters
- Optionalkeys: T[]
Returns void
- Defined in src/modules/storage.ts:476