Class LiteStorage<T>

轻量的本地文件持久性数据存储。主要用于简单的配置信息持久化

Example

const stor = await new LiteStorage({ uuid: 'test1' }).ready();

// 示例1： 读取缓存
const config = stor.get();
console.log(config);
// 缓存操作
// 存入
stor.save(config);

stor.getItem('key1');
stor.setItem('key2', { a: 1 });
stor.removeItem('key2');
stor.clear();

Type Parameters

T extends object = Record<string, unknown>

Index

Constructors

constructor

new LiteStorage<T extends object = Record<string, unknown>>(
options?: LSOptions<Record<string, unknown>>,
): LiteStorage<T>
Type Parameters
- T extends object = Record<string, unknown>
Parameters
- Optionaloptions: LSOptions<Record<string, unknown>>
Returns LiteStorage<T>
- Defined in src/node/LiteStorage.ts:64

Accessors

config

get config(): {
    filepath: string;
    initial: T;
    singleMode: boolean;
    uuid: string;
    version: string;
}
Returns {
    filepath: string;
    initial: T;
    singleMode: boolean;
    uuid: string;
    version: string;
}
- filepath: string
  缓存文件保存的路径
- initial: T
  默认初始值
- singleMode: boolean
  是否仅考虑单进程模式读写（内存）。默认为 false，每次保持前都会重载数据
- uuid: string
  存储类型的唯一标记，用于区分多个不同类型的存储。默认为 defaults
- version: string
  缓存版本。当版本不匹配时将清空已有数据
- Defined in src/node/LiteStorage.ts:94

length

get length(): number
Returns number
- Defined in src/node/LiteStorage.ts:91

Methods

clear

clear(isAll?: boolean): Promise<LiteStorage<T>>
清理缓存
Parameters
- isAll: boolean = false
  是否清空全部缓存（即移除缓存文件重新初始化）。默认为 false，只清空当前 uuid 约束下的缓存数据
Returns Promise<LiteStorage<T>>
- Defined in src/node/LiteStorage.ts:226

del

del(key: keyof T): Promise<LiteStorage<T>>
移除一项数据。同 removeItem 方法
Parameters
- key: keyof T
Returns Promise<LiteStorage<T>>
- Defined in src/node/LiteStorage.ts:193

get

get(raw?: boolean): T
以 options.uuid 为 key 获取数据
Parameters
- raw: boolean = false
  是否返回原始数据（不进行深拷贝）。默认为 false
Returns T
- Defined in src/node/LiteStorage.ts:184

getAll

getAll(): LSCache<T>
获取全量缓存的原始数据

Returns LSCache<T>
- Defined in src/node/LiteStorage.ts:189

getItem

getItem<K extends string | number | symbol>(key: K): T[K]
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns T[K]
- Defined in src/node/LiteStorage.ts:204

ready

ready(): Promise<LiteStorage<T>>
Returns Promise<LiteStorage<T>>
- Defined in src/node/LiteStorage.ts:97

reload

reload(): Promise<LiteStorage<T>>
从文件中重载数据至内存。在多进程、多线程模式下，需读取最新数据时，可手动调用

Returns Promise<LiteStorage<T>>
- Defined in src/node/LiteStorage.ts:144

removeItem

removeItem(key: keyof T): Promise<LiteStorage<T>>
移除一项数据
Parameters
- key: keyof T
Returns Promise<LiteStorage<T>>
- Defined in src/node/LiteStorage.ts:210

save

save(
    value?: T,
    mode?: "merge" | "cover",
    reload?: boolean,
): Promise<LiteStorage<T>>
主动保存
Parameters
- Optionalvalue: T
- mode: "merge" | "cover" = 'merge'
- reload: boolean = true
Returns Promise<LiteStorage<T>>
- Defined in src/node/LiteStorage.ts:102

set

set(value: T, mode?: "merge" | "cover"): Promise<LiteStorage<T>>
以 options.uuid 为 key 设置数据
Parameters
- value: T
- mode: "merge" | "cover" = 'merge'
Returns Promise<LiteStorage<T>>
- Defined in src/node/LiteStorage.ts:163

setItem

setItem<K extends string | number | symbol>(
    key: K,
    value: T[K] extends object ? Partial<any[any]> : T[K],
    mode?: "merge" | "cover",
): Promise<LiteStorage<T>>
设置并保存一个数据项。提示：setItem、removeItem 都会触发文件读写，应避免密集高频调用
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
- value: T[K] extends object ? Partial<any[any]> : T[K]
- mode: "merge" | "cover" = 'cover'
Returns Promise<LiteStorage<T>>
- Defined in src/node/LiteStorage.ts:197

`Static`getInstance

getInstance<T extends object>(
options?: LSOptions<Record<string, unknown>>,
): LiteStorage<T>
Type Parameters
- T extends object
Parameters
- Optionaloptions: LSOptions<Record<string, unknown>>
Returns LiteStorage<T>
- Defined in src/node/LiteStorage.ts:48

Class LiteStorage<T>

Example

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LiteStorage<T>

Accessors

config

Returns { filepath: string; initial: T; singleMode: boolean; uuid: string; version: string;}

filepath: string

initial: T

singleMode: boolean

uuid: string

version: string

length

Returns number

Methods

clear

Parameters

Returns Promise<LiteStorage<T>>

del

Parameters

Returns Promise<LiteStorage<T>>

get

Parameters

Returns T

getAll

Returns LSCache<T>

getItem

Type Parameters

Parameters

Returns T[K]

ready

Returns Promise<LiteStorage<T>>

reload

Returns Promise<LiteStorage<T>>

removeItem

Parameters

Returns Promise<LiteStorage<T>>

save

Parameters

Returns Promise<LiteStorage<T>>

set

Parameters

Returns Promise<LiteStorage<T>>

setItem

Type Parameters

Parameters

Returns Promise<LiteStorage<T>>

StaticgetInstance

Type Parameters

Parameters

Returns LiteStorage<T>

Settings

On This Page

Returns {
filepath: string;
initial: T;
singleMode: boolean;
uuid: string;
version: string;
}

`Static`getInstance