Class DataModel

Abstract data model

Hierarchy

DataModel

Index

Constructors

Properties

Methods

_hasChanged delete increment init insert save toJSON toObject

Constructors

constructor

new DataModel(source: string, table: string, primaryKey: string): DataModel
Constructor
Parameters
- source: string
  
  Name of the data source
- table: string
  
  Name of the table
- primaryKey: string
  
  Name of the primary key
Returns DataModel
- Defined in bean.ts:37

Properties

`Private` dao

dao: DataAccessObject

Methods

_hasChanged

_hasChanged(prop: string): boolean
Checks if a property changed

Returns
true if the property changed
Parameters
- prop: string
  
  Name of the property
Returns boolean
- Defined in bean.ts:53

delete

delete(): Promise<boolean>
Deletes the model from the database

Returns Promise<boolean>
- Defined in bean.ts:73

increment

increment(field: never, inc: number): Promise<void>
Atomic increment
Parameters
- field: never
  
  The field to increment
- inc: number
  
  The amount to increment
Returns Promise<void>
- Defined in bean.ts:95

init

init(): void
Initializes the data access object.

Returns void
- Defined in bean.ts:44

insert

insert(): Promise<void>
Inserts a new entry in the database.

Returns Promise<void>
- Defined in bean.ts:83

save

save(condition?: DataFilter<DataModel>): Promise<boolean>
Saves the changes of this model on the database.
Parameters
- Optional condition: DataFilter<DataModel>
  
  Optional. Only saves if a condition is reached.
Returns Promise<boolean>
- Defined in bean.ts:63

toJSON

toJSON(options?: ObjectSerializeOptions<DataModel>): string
Serializes the bean as JSON

Returns
The JSON string
Parameters
- Optional options: ObjectSerializeOptions<DataModel>
  
  Filtering options for properties
Returns string
- Defined in bean.ts:136

toObject

toObject(options?: ObjectSerializeOptions<DataModel>): any
Turns the bean into a plain object

Returns
The plain object
Parameters
- Optional options: ObjectSerializeOptions<DataModel>
  
  Filtering options for properties
Returns any
- Defined in bean.ts:107

Generated using TypeDoc