Class JsonDB

Represents a simple JSON file database.

Hierarchy

JsonDB

Index

Constructors

Properties

data filepath indents

Methods

cloneDeep delete get getSafe has save set setFilepath

Constructors

constructor

new JsonDB(filepath, indents?): JsonDB
Creates a new instance of the JsonDB class.
Parameters
- filepath: string
  
  The filepath where the data file is stored or to be stored.
- indents: number = 0
Returns JsonDB
- Defined in packages/util/src/db/JsonDB.ts:21

Properties

`Protected` data

data: JsonObject

The data stored in the JSON database.

`Protected` filepath

filepath: string

The filepath where the data file is stored or to be stored.

`Protected` indents

indents: number = 0

Methods

`Protected` cloneDeep

cloneDeep<T>(obj): T
Creates a deep clone of an object.
Type Parameters
- T extends JsonValue
Parameters
- obj: T
  
  The object to clone.
Returns T
The cloned object.
- Defined in packages/util/src/db/JsonDB.ts:134

delete

delete(prefix?, save?): void
Deletes a value from the JSON database.
Parameters
- Optional prefix: string
  
  Object path prefix as dot-separated keys.
- save: boolean = true
  
  Whether to save the data to the JSON file.
Returns void
- Defined in packages/util/src/db/JsonDB.ts:111

get

get<T>(prefix?): T
Gets a value from the JSON database.
Type Parameters
- T = JsonValue
Parameters
- Optional prefix: string
  
  Object path prefix as dot-separated keys.
Returns T
The value associated with the key.

Throws
An error if no entry is found at the specified key.
- Defined in packages/util/src/db/JsonDB.ts:72

getSafe

getSafe<T>(prefix?): undefined | T
Gets a value from the JSON database safely.
Type Parameters
- T = JsonValue
Parameters
- Optional prefix: string
  
  Object path prefix as dot-separated keys.
Returns undefined | T
The value associated with the key, or undefined if no entry is found.
- Defined in packages/util/src/db/JsonDB.ts:83

has

has(prefix?): boolean
Checks if a key exists in the JSON database.
Parameters
- Optional prefix: string
  
  Object path prefix as dot-separated keys.
Returns boolean
True if the key exists, false otherwise.
- Defined in packages/util/src/db/JsonDB.ts:101

save

save(indents?): Promise<void>
Saves the data to the JSON file.
Parameters
- indents: number = ...
Returns Promise<void>
- Defined in packages/util/src/db/JsonDB.ts:28

set

set(prefix?, value?, save?): void
Sets a value in the JSON database.
Parameters
- Optional prefix: string
  
  Object path prefix as dot-separated keys.
- value: JsonValue = {}
  
  The value to set.
- save: boolean = true
  
  Whether to save the data to the JSON file.
Returns void
- Defined in packages/util/src/db/JsonDB.ts:48

setFilepath

setFilepath(filepath, save?): void
Sets the filepath of the JSON file.
Parameters
- filepath: string
  
  The new filepath.
- save: boolean = true
Returns void
- Defined in packages/util/src/db/JsonDB.ts:36

Generated using TypeDoc