Class JsonDB

Hierarchy

JsonDB

Index

Constructors

Properties

config data loaded

Methods

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

Constructors

constructor

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

Properties

`Private` `Readonly` config

config: JsonDBConfig

`Private` data

data: KeyValue = {}

`Private` loaded

loaded: boolean = false

Methods

count

count(dataPath): 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): 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): Promise<boolean>
Check for existing datapath
Parameters
- dataPath: string
Returns Promise<boolean>
- Defined in src/JsonDB.ts:188

filter

filter<T>(rootPath, callback): Promise<undefined | T[]>
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<undefined | T[]>

Throws
- Defined in src/JsonDB.ts:262

find

find<T>(rootPath, callback): Promise<undefined | T>
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<undefined | T>

Throws
- Defined in src/JsonDB.ts:296

fromPath

fromPath(path, propertyName?): 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

`Private` getArrayData

getArrayData(dataPath): Promise<any>
Parameters
- dataPath: string
Returns Promise<any>
- Defined in src/JsonDB.ts:246

getData

getData(dataPath): 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, searchValue, propertyName?): 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, searchValue): 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): 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, defaultValue?): 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
- Optional defaultValue: T
  
  value to use when the dataPath doesn't lead to data
Returns Promise<T>

Throws
- Defined in src/JsonDB.ts:169

`Private` getParentData

getParentData(dataPath, create): Promise<DBParentData>
Parameters
- dataPath: string
- create: boolean
Returns Promise<DBParentData>
- Defined in src/JsonDB.ts:130

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

`Private` processDataPath

processDataPath(dataPath): DataPath
Process datapath into different parts
Parameters
- dataPath: string
Returns DataPath
- Defined in src/JsonDB.ts:37

push

push(dataPath, data, override?): 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): 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

`Private` retrieveData

retrieveData(dataPath, create?): Promise<any>
Parameters
- dataPath: DataPath
- create: boolean = false
Returns Promise<any>
- Defined in src/JsonDB.ts:50

save

save(force?): Promise<void>
Manually save the database By default you can't save the database if it's not loaded
Parameters
- Optional force: boolean
  
  force the save of the database
Returns Promise<void>

Throws
- Defined in src/JsonDB.ts:424

Generated using TypeDoc