DPDataBase.md

sapi-pro

---

sapi-pro / DPDataBase

Class: DPDataBase

Extends

• DataBase<DPValueTypes>

Constructors

Constructor

new DPDataBase(name, source?): DPDataBase

Parameters

name

string

source?

DPSource = world

Returns

DPDataBase

Overrides

DataBase.constructor

Properties

name

name: string

Inherited from

DataBase.name

---

type

type: DBTypes

Inherited from

DataBase.type

---

DBMap

static DBMap: Record<string, DataBase<any>> = {}

Inherited from

DataBase.DBMap

---

maxChunkBytes

static maxChunkBytes: number = 32767

Inherited from

DataBase.maxChunkBytes

Methods

clear()

clear(): void

Returns

void

Overrides

DataBase.clear

---

entries()

entries(): [string, DPValueTypes | undefined][]

Returns

[string, DPValueTypes | undefined][]

---

get()

get<T>(key): T | undefined

Type Parameters

T

T extends DPValueTypes = DPValueTypes

Parameters

key

string

Returns

T | undefined

Overrides

DataBase.get

---

getJSON()

getJSON<T>(key, guard?): T | undefined

获取JSON形式存储的对象，可选使用类型守卫进行校验

Type Parameters

T

T = unknown

Parameters

key

string

键名

guard?

ValueGuard<T>

可选类型守卫函数

Returns

T | undefined

解析后的数据，失败或校验不通过返回 undefined

---

getrealKeys()

getrealKeys(): string[]

获取所有键，包括list的的键,并保留DP前缀

Returns

string[]

---

keys()

keys(): string[]

获取所有键

Returns

string[]

Overrides

DataBase.keys

---

rm()

rm(key): void

Parameters

key

string

Returns

void

Overrides

DataBase.rm

---

set()

set(key, value): void

设置值（同步）

• 小数据直接写入
• 大字符串同步分片写入（可能造成卡顿）

Parameters

key

string

value

DPValueTypes

Returns

void

Overrides

DataBase.set

---

setAsync()

setAsync(key, value): Promise<void>

设置值（异步）

• 小数据直接写入
• 大字符串异步分片写入（避免卡顿）

Parameters

key

string

value

DPValueTypes

Returns

Promise<void>

---

setJSON()

setJSON(key, value): Promise<void>

以json形式存储一个对象

Parameters

key

string

value

object

Returns

Promise<void>

---

clearAllDP()

static clearAllDP(): void

Returns

void

---

getAllKeys()

static getAllKeys(): string[]

Returns

string[]

---

getByteCount()

static getByteCount(): number

Returns

number

---

getDB()

static getDB(name): DataBase<any> | undefined

Parameters

name

string

Returns

DataBase<any> | undefined

Inherited from

DataBase.getDB

---

getDBs()

static getDBs(): DataBase<any>[]

Returns

DataBase<any>[]

Inherited from

DataBase.getDBs