Class Controller

Controller

Description

A controller class for handling database queries using Objection.js models.

Index

Constructors

Properties

Methods

delete deleteWhere error findTypeString insert list selectById selectOne selectOneActive success successMerge update

Constructors

constructor

new Controller(SqliteModel, options?): Controller
Parameters
- SqliteModel: typeof Model
  The Objection.js model.
- options: {
  searchIn?: string[];
  } = {}
  Additional options for the controller.
  - OptionalsearchIn?: string[]
    Columns to search in by default.
Returns Controller
- Defined in controller.ts:24

Properties

Model

Model: typeof Model

qcolumns

qcolumns: undefined | string[]

Methods

delete

delete(param0, queryBuilder?): Promise<IStatusCode>
Deletes records by ID(s).
Parameters
- param0: IIds
  The ID or IDs of records to delete.
- OptionalqueryBuilder: any
  Optional query builder instance.
Returns Promise<IStatusCode>
The promise of the resulting data.
- Defined in controller.ts:296

deleteWhere

deleteWhere(whereData, queryBuilder?): Promise<IStatusCode>
Deletes records based on where clause.
Parameters
- whereData: WhereMethod<any>
  Criteria for delete operation.
- OptionalqueryBuilder: any
  Optional query builder instance.
Returns Promise<IStatusCode>
The promise of the resulting data.
- Defined in controller.ts:279

`Protected`error

error(errorObj?, status?, code?): IStatusCode
Formats an error response object.
Parameters
- OptionalerrorObj: any
  The error object or message.
- Optionalstatus: number = 500
  The HTTP status code.
- Optionalcode: number = 0
  Additional status code.
Returns IStatusCode
The error response object.
- Defined in controller.ts:348

findTypeString

findTypeString(ModelIn?): string[]
Finds string type columns in the model's JSON schema.
Parameters
- ModelIn: typeof Model = ...
  The model to inspect. Defaults to this.Model.
Returns string[]
A list of string type column names.
- Defined in controller.ts:35

insert

insert(data, queryBuilder?): Promise<IStatusCode>
Inserts one or multiple records.
Parameters
- data: object | object[]
  The data to insert.
- OptionalqueryBuilder: any
  Optional query builder instance.
Returns Promise<IStatusCode>
The promise of the resulting data.
- Defined in controller.ts:245

list

list(dataSearch, queryBuilder?): Promise<IStatusCode>
Lists records based on search criteria.
Parameters
- dataSearch: ISearch
  The search criteria.
- OptionalqueryBuilder: any
  Optional query builder instance.
Returns Promise<IStatusCode>
The promise of the resulting data.
- Defined in controller.ts:54

selectById

selectById(param0, queryBuilder?): Promise<IStatusCode>
Selects a record by its ID.
Parameters
- param0: IIds
  The ID or IDs to select.
- OptionalqueryBuilder: any
  Optional query builder instance.
Returns Promise<IStatusCode>
The promise of the resulting data.
- Defined in controller.ts:187

selectOne

selectOne(find, queryBuilder?): Promise<IStatusCode>
Selects one record based on given criteria without considering active state.
Parameters
- find: object
  Criteria to find the record.
- OptionalqueryBuilder: any
  Optional query builder instance.
Returns Promise<IStatusCode>
The promise of the resulting data.
- Defined in controller.ts:225

selectOneActive

selectOneActive(find, queryBuilder?): Promise<IStatusCode>
Selects one active record based on given criteria.
Parameters
- find: object
  Criteria to find the record.
- OptionalqueryBuilder: any
  Optional query builder instance.
Returns Promise<IStatusCode>
The promise of the resulting data.
- Defined in controller.ts:206

`Protected`success

success(data?, status?, code?): IStatusCode
Formats a successful response object.
Parameters
- Optionaldata: any
  The data to return in the response.
- Optionalstatus: number = 200
  The HTTP status code.
- Optionalcode: number = 0
  Additional status code.
Returns IStatusCode
The success response object.
- Defined in controller.ts:314

`Protected`successMerge

successMerge(data?, status?, code?): IStatusCode
Merges additional data into a successful response object.
Parameters
- Optionaldata: any
  The data to return in the response.
- Optionalstatus: number = 200
  The HTTP status code.
- Optionalcode: number = 0
  Additional status code.
Returns IStatusCode
The merged success response object.
- Defined in controller.ts:331

update

update(data, queryBuilder?): Promise<IStatusCode>
Updates records using an upsert operation.
Parameters
- data: object | object[]
  The data for upsert.
- OptionalqueryBuilder: any
  Optional query builder instance.
Returns Promise<IStatusCode>
The promise of the resulting data.
- Defined in controller.ts:262