Class StorageWrap<T>

本地存储包装类。

Type Parameters

T extends object = object

Hierarchy

StorageWrap
- ExpiresPlugin

Index

Constructors

Properties

_options _plugins _storage available

Methods

_doGetting _doRemoving _doSetting get getAsJSON handleGetting handleRemoving handleSetting remove set setAsJSON

Constructors

constructor

new StorageWrap<T>(storageType, options?): StorageWrap<T>
本地存储包装类。
Type Parameters
- T extends object = object
Parameters
- storageType: StorageType
- options: IStorageOptions = ...
Returns StorageWrap<T>

Since
2.0.0
- Defined in storage-wrap.ts:45

Properties

`Protected` `Readonly` _options

_options: IStorageOptions

存储包装的选项。

`Protected` `Readonly` _plugins

_plugins: StorageWrap<object>[] = []

存储所有插件。

`Protected` `Readonly` _storage

_storage: SimpleWrap

使用的存储对象。

`Readonly` available

available: boolean

当前存储对象是否有效（如果获取存储对象出现异常，则无效）。

Methods

`Protected` _doGetting

_doGetting(params): void
执行 get 操作的函数。
Parameters
- params: IGettingParams
  
  get 操作的参数。
Returns void

Since
2.0.0
- Defined in storage-wrap.ts:91

`Protected` _doRemoving

_doRemoving(params): void
执行 remove 操作的函数。
Parameters
- params: IRemovingParams
  
  remove 操作的参数。
Returns void

Since
2.0.0
- Defined in storage-wrap.ts:189

`Protected` _doSetting

_doSetting(params): void
执行 set 操作的函数。
Parameters
- params: ISettingParams<T>
  
  set 操作的参数。
Returns void

Since
2.0.0
- Defined in storage-wrap.ts:140

get

get(key): ItemValue
获取指定存储项的值。
Parameters
- key: string
  
  存储项键名。
Returns ItemValue
存储项的值。
- Defined in storage-wrap.ts:112

getAsJSON

getAsJSON(key): unknown
获取指定存储项的值并解析为 JSON。
Parameters
- key: string
  
  存储项键名。
Returns unknown
解析结果。
- Defined in storage-wrap.ts:127

handleGetting

handleGetting(params): void
用于在插件机制中处理 get 操作。
Parameters
- params: IGettingParams
  
  get 操作的参数。
Returns void

Since
2.0.0
- Defined in storage-wrap.ts:100

handleRemoving

handleRemoving(params): void
用于在插件机制中处理 remove 操作。
Parameters
- params: IRemovingParams
  
  remove 操作的参数。
Returns void

Since
2.0.0
- Defined in storage-wrap.ts:198

handleSetting

handleSetting(params): void
用于在插件机制中处理 set 操作。
Parameters
- params: ISettingParams<T>
  
  set 操作的参数。
Returns void

Since
2.0.0
- Defined in storage-wrap.ts:149

remove

remove(key): void
移除存储项。
Parameters
- key: string
  
  存储项键名。
Returns void
- Defined in storage-wrap.ts:209

set

set(key, value, options?): void
写入指定存储项的值。
Parameters
- key: string
  
  存储项键名。
- value: string
  
  存储项的值。
- Optional options: T
  
  写入操作的选项。
  
  Optional
Returns void
- Defined in storage-wrap.ts:162

setAsJSON

setAsJSON(key, value, options?): void
把指定值序列化为 JSON 字符串后写入到指定存储项。
Parameters
- key: string
  
  存储项键名。
- value: unknown
  
  存储项的值。
- Optional options: T
  
  写入操作的选项。
  
  Optional
Returns void
- Defined in storage-wrap.ts:178

Generated using TypeDoc