Class: Data<Bounded>

Defined in: src/betterdiscord/api/data.ts:27

Data is a simple utility class for the management of plugin data. An instance is available on BdApi.

Type Parameters

Type Parameter
Bounded extends boolean

Methods

delete()

delete(...args: [...(Bounded extends false ? [pluginName: string] : [])[], string]): void;

Defined in: src/betterdiscord/api/data.ts:87

Deletes a piece of stored data. This is different than saving null or undefined.

Parameters

Parameter	Type
...args	[...(Bounded extends false ? [pluginName: string] : [])[], string]

Returns

void

---

load()

load<T>(...args: [...(Bounded extends false ? [pluginName: string] : [])[], string]): T;

Defined in: src/betterdiscord/api/data.ts:57

Loads previously stored data.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
...args	[...(Bounded extends false ? [pluginName: string] : [])[], string]

Returns

T

The stored data

---

recache()

recache(...args: Bounded extends true ? [] : [string]): Promise<boolean>;

Defined in: src/betterdiscord/api/data.ts:76

Recaches JSON-serializable save file.

Parameters

Parameter	Type
...args	Bounded extends true ? [] : [string]

Returns

Promise<boolean>

success Did the data recache

Warning

⚠️ Use of the recaching is discouraged!

Recache loads can block the filesystem and significantly degrade performance. Use this method only for debugging or testing purposes. Avoid frequent recaching in production environments.

---

save()

save<T>(...args: [...(Bounded extends false ? [pluginName: string] : [])[], string, T]): void;

Defined in: src/betterdiscord/api/data.ts:42

Saves JSON-serializable data.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
...args	[...(Bounded extends false ? [pluginName: string] : [])[], string, T]

Returns

void