Global

Methods

(async) factory(pkgName) → {class}

Plugin factory

Parameters:

Name	Type	Description
`pkgName`	string	NPM package name

Source: index.js, line 117

Returns:

Type:: class

Type Definitions

TPropType

Type:

Object

Properties

Name Type Default Description

integer

Object

Properties

Name	Type	Attributes	Default	Description
`validator`	string	<optional>	number

smallint

Object

Properties

Name	Type	Attributes	Default	Description
`validator`	string	<optional>	number

text

Object

Properties

Name	Type	Attributes	Default
`validator`	string	<optional>	string
`textType`	string	<optional>	string
`values`	Array.<string>	<optional>	['text', 'mediumtext', 'longtext']

string

Object

Properties

Name	Type	Attributes	Default
`validator`	string	<optional>	string
`maxLength`	maxLength	<optional>	255
`minLength`	minLength	<optional>	0

float

Object

Properties

Name	Type	Attributes	Default	Description
`validator`	string	<optional>	number

double

Object

Properties

Name	Type	Attributes	Default	Description
`validator`	string	<optional>	number

boolean

Object

Properties

Name	Type	Attributes	Default	Description
`validator`	string	<optional>	boolean

datetime

Object

Properties

Name	Type	Attributes	Default	Description
`validator`	string	<optional>	date

date

Object

Properties

Name	Type	Attributes	Default	Description
`validator`	string	<optional>	date

time

Object

Properties

Name	Type	Attributes	Default	Description
`validator`	string	<optional>	date

timestamp

Object

Properties

Name	Type	Attributes	Default	Description
`validator`	string	<optional>	timestamp

object Object {}

array Object {}

Source: index.js, line 38

TRecordCountOptions

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`dataOnly`	boolean	<optional>	true	If `true` (default) returns array of records. Otherwise TFindRecordResult
`noCache`	boolean	<optional>	true	If `true` (default), result set won't be cached. This will overwrite model's `cacheable` property. Only applicable if bajo-cache is loaded
`noHook`	boolean	<optional>	false	If `true`, no model's hook will be executed
`noFeatureHook`	boolean	<optional>	false	If `true`, no model's feature hook will be executed

Source: method/record/count.js, line 4
See: Dobo#recordCount

TRecordCreateOptions

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`dataOnly`	boolean	<optional>	true	If `true` (default) returns record's object. Otherwise TRecordCreateResult
`noHook`	boolean	<optional>	false	If `true`, no model's hook will be executed
`noFeatureHook`	boolean	<optional>	false	If `true`, no model's feature hook will be executed
`noValidation`	boolean	<optional>	false	If `true`, no validation of data payload performed
`noCheckUnique`	boolean	<optional>	false	If `true`, no unique validation for ID performed
`noSanitize`	boolean	<optional>	false	If `true`, accept data payload as is without sanitization
`noResult`	boolean	<optional>	false	If `true`, returns nothing
`truncateString`	boolean	<optional>	true	If `true` (default), string is truncated to its schema's `maxLemngth`
`fields`	boolean	<optional>	[]	If not empty, return only these fields EXCLUDING hidden fields
`hidden`	boolean	<optional>	[]	Additional fields to hide, in addition the one set in model's schema
`forceNoHidden`	boolean	<optional>	false	If `true`, hidden fields will be ignored and ALL fields will be returned

Source: method/record/create.js, line 9
See: Dobo#recordCreate

TRecordFilter

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`query`	string \| Object	<optional>	{}	Query definition. See query-language for more
`limit`	number			Max number of records per page
`page`	number			Which page is the returned records currently at
`skip`	number			Records to skip
`sort`	TRecordSort			Sort order info

Source: method/record/find.js, line 5
See: Dobo#recordFind
Dobo#recordFindOne
Dobo#recordFindAll

TRecordFindOptions

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`dataOnly`	boolean	<optional>	true	If `true` (default) returns array of records. Otherwise TFindRecordResult
`count`	boolean	<optional>	false	If `true` and `dataOnly` is also `true`, the total number of records found will be returned
`noCache`	boolean	<optional>	true	If `true` (default), result set won't be cached. This will overwrite model's `cacheable` property. Only applicable if bajo-cache is loaded
`noHook`	boolean	<optional>	false	If `true`, no model's hook will be executed
`noFeatureHook`	boolean	<optional>	false	If `true`, no model's feature hook will be executed
`fields`	boolean	<optional>	[]	If not empty, return only these fields EXCLUDING hidden fields
`hidden`	boolean	<optional>	[]	Additional fields to hide, in addition the one set in model's schema
`forceNoHidden`	boolean	<optional>	false	If `true`, hidden fields will be ignored and ALL fields will be returned

Source: method/record/find.js, line 30
See: Dobo#recordFind
Dobo#recordFindOne
Dobo#recordFindAll

TRecordFindResult

Type:

Object

Properties

Name	Type	Description
`data`	Array.<Object>	Array of returned records
`success`	boolean	Whether operation is successfull or failed
`page`	number	Which page is the returned records currently at
`limit`	number	Max number of records per page
`count`	number	Total number of records returned
`pages`	number	Total number of pages returned

Source: method/record/find.js, line 17
See: Dobo#recordFind
Dobo#recordFindAll
Dobo#recordGet

TRecordGetOptions

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`dataOnly`	boolean	<optional>	true	If `true` (default) returns array of records. Otherwise TFindRecordResult
`count`	boolean	<optional>	false	If `true` and `dataOnly` is also `true`, the total number of records found will be returned
`noCache`	boolean	<optional>	true	If `true` (default), result set won't be cached. This will overwrite model's `cacheable` property. Only applicable if bajo-cache is loaded
`noHook`	boolean	<optional>	false	If `true`, no model's hook will be executed
`noFeatureHook`	boolean	<optional>	false	If `true`, no model's feature hook will be executed
`fields`	boolean	<optional>	[]	If not empty, return only these fields EXCLUDING hidden fields
`hidden`	boolean	<optional>	[]	Additional fields to hide, in addition the one set in model's schema
`forceNoHidden`	boolean	<optional>	false	If `true`, hidden fields will be ignored and ALL fields will be returned

Source: method/record/get.js, line 13
See: Dobo#recordGet

TRecordGetResult

Type:

Object

Properties

Name	Type	Description
`data`	Object	Returned record
`success`	boolean	Whether operation is successfull or failed

Source: method/record/get.js, line 5
See: Dobo#recordGet
Dobo#recordFindOne

TRecordPagination

Type:

Object

Properties

Name	Type	Description
`limit`	number	Number of records per page
`page`	number	Page number
`skip`	number	Records to skip
`sort`	TRecordSort	Sort order

Source: index.js, line 30

TRecordRemoveOptions

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`dataOnly`	boolean	<optional>	true	If `true` (default) returns deleted record. Otherwise TRecordRemoveResult
`noHook`	boolean	<optional>	false	If `true`, no model's hook will be executed
`noFeatureHook`	boolean	<optional>	false	If `true`, no model's feature hook will be executed
`noResult`	boolean	<optional>	false	If `true`, returns nothing
`fields`	boolean	<optional>	[]	If not empty, return only these fields EXCLUDING hidden fields
`hidden`	boolean	<optional>	[]	Additional fields to hide, in addition the one set in model's schema
`forceNoHidden`	boolean	<optional>	false	If `true`, hidden fields will be ignored and ALL fields will be returned

Source: method/record/remove.js, line 5
See: Dobo#recordRemove

TRecordSort

Key value pairs used as sort information:

Key represent model's field name
value represent its sort order: 1 for ascending order, and -1 for descending order

Example: to sort by firstName (ascending) and lastName (descending)

const sort = {
  firstName: 1,
  lastName: -1
}

Type:

Object.<string, TRecordSortKey>

Source: index.js, line 14

TRecordSortKey

Type:

string

Source: index.js, line 10

TRecordUpdateOptions

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`dataOnly`	boolean	<optional>	true	If `true` (default) returns record's object. Otherwise TRecordUpdateResult
`noHook`	boolean	<optional>	false	If `true`, no model's hook will be executed
`noFeatureHook`	boolean	<optional>	false	If `true`, no model's feature hook will be executed
`noValidation`	boolean	<optional>	false	If `true`, no validation of data payload performed
`noCheckUnique`	boolean	<optional>	false	If `true`, no unique validation for ID performed
`noSanitize`	boolean	<optional>	false	If `true`, accept data payload as is without sanitization
`noResult`	boolean	<optional>	false	If `true`, returns nothing
`truncateString`	boolean	<optional>	true	If `true` (default), string is truncated to its schema's `maxLemngth`
`partial`	boolean	<optional>	true	If `true` (default), only updated values are saved. Otherwise replace all existing values with given payload
`fields`	boolean	<optional>	[]	If not empty, return only these fields EXCLUDING hidden fields
`hidden`	boolean	<optional>	[]	Additional fields to hide, in addition the one set in model's schema
`forceNoHidden`	boolean	<optional>	false	If `true`, hidden fields will be ignored and ALL fields will be returned

Source: method/record/update.js, line 8
See: Dobo#recordUpdate

TValidator

Type:

Object

Properties

Name	Type	Description
`string`	TValidatorString
`number`	TValidatorNumber
`boolean`	TValidatorBoolean
`date`	TValidatorDate
`timestamp`	TValidatorTimestamp

Source: method/validate.js, line 72

TValidatorBoolean

Type:

Array.<string>

Properties

Name	Type	Default
`0`	string	falsy
`1`	string	sensitive
`2`	string	truthy

Source: method/validate.js, line 51

TValidatorDate

Type:

Array.<string>

Properties

Name	Type	Default
`0`	string	greater
`1`	string	iso
`2`	string	less
`2`	string	max
`2`	string	min

Source: method/validate.js, line 58

TValidatorNumber

Type:

Array.<string>

Properties

Name	Type	Default
`0`	string	great
`1`	string	less
`2`	string	max
`3`	string	min
`4`	string	multiple
`5`	string	negative
`6`	string	port
`7`	string	positive
`8`	string	sign
`9`	string	unsafe

Source: method/validate.js, line 37

TValidatorString

Type:

Array.<string>

Properties

Name	Type	Default
`0`	string	alphanum
`1`	string	base64
`2`	string	case
`3`	string	creditCard
`4`	string	dataUri
`5`	string	email
`6`	string	guid
`7`	string	uuid
`8`	string	hex
`9`	string	hostname
`10`	string	insenstive
`11`	string	ip
`12`	string	isoDate
`13`	string	isoDuration
`14`	string	length
`15`	string	lowercase
`16`	string	max
`17`	string	min
`18`	string	normalize
`19`	string	pattern
`20`	string	regex
`21`	string	replace
`22`	string	token
`23`	string	trim
`24`	string	truncate
`25`	string	upercase
`26`	string	uri

Source: method/validate.js, line 6

TValidatorTimestamp

Type:

Array.<string>

Properties

Name	Type	Default	Description
`0`	string	timestamp

Source: method/validate.js, line 67