Class JsonDB

Index

Constructors

Methods

count delete exists filter find fromPath getData getIndex getIndexValue getObject getObjectDefault load push reload resetData save

Constructors

constructor

new JsonDB(config: JsonDBConfig): JsonDB
JSONDB Constructor
Parameters
- config: JsonDBConfig
  Configuration for the database
Returns JsonDB
- Defined in src/JsonDB.ts:29

Methods

count

count(dataPath: string): Promise<number>
Returns the number of element which constitutes the array
Parameters
- dataPath: string
Returns Promise<number>
Throws
- Defined in src/JsonDB.ts:206

delete

delete(dataPath: string): Promise<void>
Delete the data
Parameters
- dataPath: string
  path leading to the data
Returns Promise<void>
- Defined in src/JsonDB.ts:367

exists

exists(dataPath: string): Promise<boolean>
Check for existing datapath
Parameters
- dataPath: string
Returns Promise<boolean>
- Defined in src/JsonDB.ts:188

filter

filter<T>(rootPath: string, callback: FindCallback): Promise<T[] | undefined>
Find all specific entry in an array/object
Type Parameters
- T
Parameters
- rootPath: string
  base dataPath from where to start searching
- callback: FindCallback
  method to filter the result and find the wanted entry. Receive the entry and it's index.
Returns Promise<T[] | undefined>
Throws
- Defined in src/JsonDB.ts:262

find

find<T>(rootPath: string, callback: FindCallback): Promise<T | undefined>
Find a specific entry in an array/object
Type Parameters
- T
Parameters
- rootPath: string
  base dataPath from where to start searching
- callback: FindCallback
  method to filter the result and find the wanted entry. Receive the entry and it's index.
Returns Promise<T | undefined>
Throws
- Defined in src/JsonDB.ts:296

fromPath

fromPath(path: string, propertyName?: string): Promise<string>
Convert a router style path to a normal path By default propertyName to search is "id"
Parameters
- path: string
  router based path to a correct base path
- propertyName: string = 'id'
  name of the property to look for searchValue
Returns Promise<string>
- Defined in src/JsonDB.ts:443

getData

getData(dataPath: string): Promise<any>
Get the wanted data
Parameters
- dataPath: string
  path of the data to retrieve
Returns Promise<any>
- Defined in src/JsonDB.ts:146

getIndex

getIndex(
    dataPath: string,
    searchValue: string | number,
    propertyName?: string,
): Promise<number>
Returns the index of the object that meets the criteria submitted. Returns -1, if no match is found.
Parameters
- dataPath: string
  base dataPath from where to start searching
- searchValue: string | number
  value to look for in the dataPath
- propertyName: string = 'id'
  name of the property to look for searchValue
Returns Promise<number>
- Defined in src/JsonDB.ts:223

getIndexValue

getIndexValue(dataPath: string, searchValue: string | number): Promise<number>
Return the index of the value inside the array. Returns -1, if no match is found.
Parameters
- dataPath: string
  base dataPath from where to start searching
- searchValue: string | number
  value to look for in the dataPath
Returns Promise<number>
- Defined in src/JsonDB.ts:242

getObject

getObject<T>(dataPath: string): Promise<T>
Same as getData only here it's directly typed to your object
Type Parameters
- T
Parameters
- dataPath: string
  path of the data to retrieve
Returns Promise<T>
- Defined in src/JsonDB.ts:158

getObjectDefault

getObjectDefault<T>(dataPath: string, defaultValue?: T): Promise<T>
Same as getData but with your own object type and a possible default value when we can't find the data path
Type Parameters
- T
Parameters
- dataPath: string
  path of the data to retrieve
- OptionaldefaultValue: T
  value to use when the dataPath doesn't lead to data
Returns Promise<T>
Throws
- Defined in src/JsonDB.ts:169

load

load(): Promise<void>
Manually load the database It is automatically called when the first getData is done

Returns Promise<void>
Throws
- Defined in src/JsonDB.ts:405

push

push(dataPath: string, data: any, override?: boolean): Promise<void>
Pushing data into the database
Parameters
- dataPath: string
  path leading to the data
- data: any
  data to push
- override: boolean = true
  overriding or not the data, if not, it will merge them
Returns Promise<void>
Throws
- Defined in src/JsonDB.ts:327

reload

reload(): Promise<void>
Reload the database from the file

Returns Promise<void>
- Defined in src/JsonDB.ts:394

resetData

resetData(data: any): void
Only use this if you know what you're doing. It reset the full data of the database.
Parameters
- data: any
Returns void
- Defined in src/JsonDB.ts:387

save

save(force?: boolean): Promise<void>
Manually save the database By default you can't save the database if it's not loaded
Parameters
- Optionalforce: boolean
  force the save of the database
Returns Promise<void>
Throws
- Defined in src/JsonDB.ts:424

Class JsonDB

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns JsonDB

Methods

count

Parameters

Returns Promise<number>

Throws

delete

Parameters

Returns Promise<void>

exists

Parameters

Returns Promise<boolean>

filter

Type Parameters

Parameters

Returns Promise<T[] | undefined>

Throws

find

Type Parameters

Parameters

Returns Promise<T | undefined>

Throws

fromPath

Parameters

Returns Promise<string>

getData

Parameters

Returns Promise<any>

getIndex

Parameters

Returns Promise<number>

getIndexValue

Parameters

Returns Promise<number>

getObject

Type Parameters

Parameters

Returns Promise<T>

getObjectDefault

Type Parameters

Parameters

Returns Promise<T>

Throws

load

Returns Promise<void>

Throws

push

Parameters

Returns Promise<void>

Throws

reload

Returns Promise<void>

resetData

Parameters

Returns void

save

Parameters

Returns Promise<void>

Throws

Settings

On This Page