Class default<T>

Type parameters

T: object

Hierarchy

default

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new default<T>(filePath: string, defaultData?: T, options?: Options): default<T>

- Defined in index.ts:49
Init this class

Type parameters
- T: object
Parameters
- filePath: string
  
  the path of the JSON file
- Optional defaultData: T
  
  the default data of the JSON file
- Optional options: Options
  
  Some options of this class
Returns default<T>

Properties

Private _data

_data: T

data

data: T

Private Readonly filePath

filePath: string

Private Readonly options

options: Options

Methods

Private calcDiff

calcDiff(data: T, fileContent: T): T

- Defined in index.ts:137
To calculate the differences between the current data (saved in the JSON file) and the new data (user input)

Parameters
- data: T
  
  User input data
- fileContent: T
Returns T

Private dataSet

dataSet(target: T, props: string | symbol, value: any, receiver: any): boolean

- Defined in index.ts:126
This function will run when the data update

Parameters
- target: T
- props: string | symbol
- value: any
- receiver: any
Returns boolean
boolean

getData

getData(): T

- Defined in index.ts:145
To get a copy of data

Returns T
a copy of data

Private getFileContent

getFileContent(): Promise<false | T>

- Defined in index.ts:90
To get the content of the JSON file

Returns Promise<false | T>

Private getFileContentSync

getFileContentSync(): false | T

- Defined in index.ts:113
To get the content of the JSON file

Returns false | T
data or false

read

read(): Promise<boolean>

- Defined in index.ts:153
Update the data from JSON file manually

Returns Promise<boolean>
whether the update is successful

readSync

readSync(): boolean

- Defined in index.ts:173
Update the data from JSON file manually

Returns boolean
whether the update is successful

Private updateData

updateData(data: T): void

- Defined in index.ts:82
Use Proxy to rebind the data

Parameters
- data: T
  
  data
Returns void

updateFile

updateFile(): Promise<boolean>

- Defined in index.ts:207
To update the JSON file manually

Returns Promise<boolean>

updateFileSync

updateFileSync(): void

- Defined in index.ts:214
To update the JSON file manually

Returns void

write

write(): Promise<boolean>

- Defined in index.ts:186
To update the JSON file manually

Returns Promise<boolean>
if this function return true, it means the data is updated successfully

writeSync

writeSync(): void

- Defined in index.ts:200
To update the JSON file manually

Returns void

Generated using TypeDoc