Class Editor

Hierarchy

NestedData
- Editor

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Editor(db?: knex, table?: string | string[], pkey?: string | string[]): Editor

- Defined in editor.ts:272
Parameters
- Default value db: knex = null
- Default value table: string | string[] = null
- Default value pkey: string | string[] = null
Returns Editor

Properties

Static Action

Action: Action = Action

Static version

version: string = "1.9.5"

Methods

data

data(): IDtResponse

- Defined in editor.ts:303
Returns IDtResponse

Data object

db

db(): knex
db(db: knex): Editor

- Defined in editor.ts:311
Returns knex

Knex db interface
- Defined in editor.ts:317
Parameters
- db: knex
Returns Editor

Self for chaining

dbTransaction

dbTransaction(): knex

- Defined in editor.ts:338
Returns knex

debug

debug(): boolean
debug(set: boolean): Editor
debug(message: any): Editor

- Defined in editor.ts:346
Returns boolean

Debug enabled (true) or not
- Defined in editor.ts:352
Parameters
- set: boolean
Returns Editor

Self for chaining
- Defined in editor.ts:358
Parameters
- message: any
Returns Editor

Self for chaining

field

field(field: Field): Editor
field(name: string): Field

- Defined in editor.ts:379
Parameters
- field: Field
Returns Editor

Editor instance
- Defined in editor.ts:385
Parameters
- name: string
Returns Field

Field instance

fields

fields(): Field[]
fields(fields: Field[]): Editor

- Defined in editor.ts:405
Returns Field[]

Array of fields
- Defined in editor.ts:411
Parameters
- Rest fields: Field[]
Returns Editor

Self for chaining

idPrefix

idPrefix(): string
idPrefix(idPrefix: string): Editor

- Defined in editor.ts:432
Returns string

id prefix
- Defined in editor.ts:438
Parameters
- idPrefix: string
Returns Editor

Self for chaining

inData

inData(): IDtRequest

- Defined in editor.ts:454
Returns IDtRequest

Data that has been passed into {@link Editor.process()}

join

join(): Mjoin[]
join(join: Mjoin[]): Editor

- Defined in editor.ts:471
Returns Mjoin[]

Array of Mjoin instances
- Defined in editor.ts:477
Parameters
- Rest join: Mjoin[]
Returns Editor

Self for chaining.

leftJoin

leftJoin(table: string, field1: string, operator: string, field2: string): Editor

- Defined in editor.ts:520
Parameters
- table: string
- field1: string
- operator: string
- field2: string
Returns Editor

Self for chaining

leftJoinRemove

leftJoinRemove(): boolean
leftJoinRemove(remove: boolean): Editor

- Defined in editor.ts:535
Returns boolean

Value
- Defined in editor.ts:543
Parameters
- remove: boolean
Returns Editor

Self for chaining

on

on(name: string, callback: Function): Editor

- Defined in editor.ts:561
Parameters
- name: string
- callback: Function
Returns Editor

Self for chaining.

pkey

pkey(): string[]
pkey(pkey: string | string[]): Editor

- Defined in editor.ts:688
Returns string[]

Array of column names
- Defined in editor.ts:695
Parameters
- pkey: string | string[]
Returns Editor

Self for chaining.

pkeyToObject

pkeyToObject(value: string, flat?: boolean, pkey?: string[]): object

- Defined in editor.ts:763
Parameters
- value: string
- Default value flat: boolean = false
- Default value pkey: string[] = null
Returns object

Array of field values that the id was made up of

pkeyToValue

pkeyToValue(row: object, flat?: boolean): string

- Defined in editor.ts:720
Parameters
- row: object
- Default value flat: boolean = false
Returns string

The created primary key value.

process

process(data: IDtRequest, files?: IUpload): Promise<Editor>

- Defined in editor.ts:798
Parameters
- data: IDtRequest
- Default value files: IUpload = null
Returns Promise<Editor>

Promise that is fulfilled when Editor has completed its processing - result is the Editor instance.

readTable

readTable(): string[]
readTable(table: string | string[]): Editor

- Defined in editor.ts:599
Returns string[]

Configured read table name
- Defined in editor.ts:608
Parameters
- table: string | string[]
Returns Editor

Self for chaining

schema

schema(): string
schema(schema: string): Editor

- Defined in editor.ts:579
Returns string

Schema
- Defined in editor.ts:585
Parameters
- schema: string
Returns Editor

Self for chaining

table

table(): string[]
table(table: string | string[]): Editor

- Defined in editor.ts:634
Returns string[]

Configured table name
- Defined in editor.ts:640
Parameters
- table: string | string[]
Returns Editor

Self for chaining

transaction

transaction(): boolean
transaction(transaction: boolean): Editor

- Defined in editor.ts:665
Returns boolean

true is transactions are enabled, false otherwise.
- Defined in editor.ts:671
Parameters
- transaction: boolean
Returns Editor

Self for chaining

tryCatch

tryCatch(): boolean
tryCatch(tryCatch: boolean): Editor

- Defined in editor.ts:851
Returns boolean

Try / catch status.
- Defined in editor.ts:857
Parameters
- tryCatch: boolean
Returns Editor

Self for chaining.

validate

validate(errors: IDtError[], http: IDtRequest): Promise<boolean>

- Defined in editor.ts:882
Parameters
- errors: IDtError[]
- http: IDtRequest
Returns Promise<boolean>

true if the data is valid, false if not.

validator

validator(): IGlobalValidator[]
validator(fn: IGlobalValidator): Editor

- Defined in editor.ts:923
Returns IGlobalValidator[]

Global validator
- Defined in editor.ts:930
Parameters
- fn: IGlobalValidator
Returns Editor

Self for chaining

where

where(): any[]
where(cond: any[]): Editor

- Defined in editor.ts:944
Returns any[]

Knex where conditions.
- Defined in editor.ts:952
Parameters
- Rest cond: any[]
Returns Editor

Self for chaining.

whereClear

whereClear(): this

- Defined in editor.ts:967
Returns this

Self for chaining.

write

write(writeVal: any): false | true | this

- Defined in editor.ts:977
Parameters
- writeVal: any
Returns false | true | this

Static action

action(http: IDtRequest): Action

- Defined in editor.ts:227
Parameters
- http: IDtRequest
Returns Action

Indicates what action the request is

Generated using TypeDoc