Class: DoboModel

Constructor

new DoboModel()

Constructor

Source: lib/factory/model.js, line 241

Members

adapter :string

Model's adapter name

Type:

string

Source: lib/factory/model.js, line 254

Methods

(async, static) _simpleLookup(value, lookupValue, optionsopt) → {*|null|undefined}

Internal method to perform a simple lookup based on the provided value and lookupValue.

Parameters:

Name	Type	Attributes	Default	Description
`value`	string \| object \| Array			The value to look up
`lookupValue`	object			The lookup values to replace in the query
`options`	object	<optional>	{}	Additional options for the lookup

Source: lib/factory/model.js, line 391

Returns:

Returns the result of the lookup or null if not found or undefined if the value is not a string, object, or array

Type:: * | null | undefined

(static) action(name, …args) → {DoboAction}

Invoke a model's action. It will create a new instance of DoboAction and return it.

Parameters:

Name	Type	Attributes	Description
`name`	string		The name of the action to invoke
`args`	any	<repeatable>	Arguments to pass to the action

Source: lib/factory/model.js, line 265

Returns:

Returns an instance of DoboAction

Type:: DoboAction

(async, static) build(opts) → {DoboModel.TResultRecord|DoboModel.TRecord}

Build a model's definition based on its properties and rules.

Parameters:

Name	Type	Description
`opts`	DoboModel.TOptions	The options for building the model

Source: lib/factory/model/build.js, line 13

Returns:

Type:: DoboModel.TResultRecord | DoboModel.TRecord

(async, static) buildFromDbModel(optionsopt) → {object|boolean}

Build JOI model from database model's properties and rules

Parameters:

Name Type Attributes Default Description

options

object

{}

Options object

Properties

Name	Type	Attributes	Default	Description
`fields`	Array	<optional>	[]	If not empty, only these fields will be included in the JOI model
`rule`	object	<optional>	{}	Custom rules to override model's rules
`extFields`	Array	<optional>	[]	Additional fields to include in the JOI model
`partial`	boolean	<optional>	false	If `true`, only the fields present in the body will be validated

Source: lib/factory/model/validate.js, line 127

Returns:

Returns JOI model object or false if no properties to validate

Type:: object | boolean

(async, static) buildPropValues(prop, opts) → {Array.<DoboModel.TPropertyValue>}

Builds the values for a given property if prop.values is set:

If a string, it will be treated as a handler and executed to get the values.
If a function, it will be executed to get the values.
If an array, it will be used as is.

Values are returned as an array of DoboModel.TPropertyValues. If a request object is provided in the options, the text will be translated using the request's translation function.

Parameters:

Name	Type	Description
`prop`	object	The property definition
`opts`	DoboModel.TOptions	Additional options for building the property values

Source: lib/factory/model.js, line 430

Returns:

Returns an array of property values

Type:: Array.<DoboModel.TPropertyValue>

(async, static) clearRecord(optsopt) → {DoboAction|DoboModel.TResultRecord|DoboModel.TRecord}

Clears all records from the model's underlying data store.

If no arguments are provided, it automatically turns into a chainable DoboAction object.

Parameters:

Name	Type	Attributes	Default	Description
`opts`	DoboModel.TOptions	<optional>	{}	Options object.

Source: lib/factory/model/clear-record.js, line 14

Returns:

Type:: DoboAction | DoboModel.TResultRecord | DoboModel.TRecord

(async, static) countRecord(filteropt, optsopt) → {DoboAction|DoboModel.TResultRecord|DoboModel.TRecord}

Counts the number of records in the model's underlying data store that match the provided filter criteria.

If no arguments are provided, it automatically turns into a chainable DoboAction object.

Parameters:

Name	Type	Attributes	Default	Description
`filter`	DoboModel.TFilter	<optional>	{}	The filter criteria to apply when counting records.
`opts`	DoboModel.TOptions	<optional>	{}	Options object.

Source: lib/factory/model/count-record.js, line 15

Returns:

Type:: DoboAction | DoboModel.TResultRecord | DoboModel.TRecord

(async, static) createRecord(body, optsopt) → {DoboAction|DoboModel.TResultCreateRecord|DoboModel.TRecord}

Creates a new record in the model's underlying data store with the provided data.

If no arguments are provided, it automatically turns into a chainable DoboAction object.

Parameters:

Name	Type	Attributes	Description
`body`	object		The data for the new record to be created
`opts`	DoboModel.TOptions	<optional>	Options object

Source: lib/factory/model/create-record.js, line 19
See: DoboModel.THookBeforeCreateRecord
DoboModel.THookAfterCreateRecord

Returns:

Type:: DoboAction | DoboModel.TResultCreateRecord | DoboModel.TRecord

(async, static) drop(optsopt) → {DoboAction|DoboModel.TResult|boolean}

Drops the model from the underlying data store.

Parameters:

Name	Type	Attributes	Description
`opts`	DoboModel.TOptions	<optional>	Options object.

Source: lib/factory/model/drop.js, line 14
See: DoboModel.THookBeforeDropModel
DoboModel.THookAfterDropModel

Returns:

Type:: DoboAction | DoboModel.TResult | boolean

(async, static) findAllRecord(filter, optsopt) → {DoboAction|DoboModel.TResultFindRecord|Array.<DoboModel.TRecord>}

Finds all records from the model's underlying data store based on the provided filter.

Parameters:

Name	Type	Attributes	Description
`filter`	DoboModel.TFilter		The filter parameters for finding the records.
`opts`	DoboModel.TOptions	<optional>	Options object.

Source: lib/factory/model/find-all-record.js, line 103
See: DoboModel.THookBeforeFindAllRecord
DoboModel.THookAfterFindAllRecord

Returns:

Type:: DoboAction | DoboModel.TResultFindRecord | Array.<DoboModel.TRecord>

(async, static) findOneRecord(filter, optsopt) → {DoboAction|DoboModel.TResultFindRecord|Array.<DoboModel.TRecord>}

Finds a single record from the model's underlying data store based on the provided filter.

If no arguments are provided, it automatically turns into a chainable DoboAction object.

Parameters:

Name	Type	Attributes	Description
`filter`	DoboModel.TFilter		The filter parameters for finding the record.
`opts`	DoboModel.TOptions	<optional>	Options object.

Source: lib/factory/model/find-one-record.js, line 17
See: DoboModel.THookBeforeFindRecord

Returns:

Type:: DoboAction | DoboModel.TResultFindRecord | Array.<DoboModel.TRecord>

(async, static) findRecord(filteropt, optsopt) → {DoboAction|DoboModel.TResultFindRecord|Array.<DoboModel.TRecord>}

Finds records in the model's underlying data store that match the provided filter criteria.

If no arguments are provided, it automatically turns into a chainable DoboAction object.

Parameters:

Name	Type	Attributes	Default	Description
`filter`	DoboModel.TFilter	<optional>	{}	The filter criteria to apply when finding records.
`opts`	DoboModel.TOptions	<optional>	{}	Options object.

Source: lib/factory/model/find-record.js, line 31
See: DoboModel.THookBeforeFindRecord
DoboModel.THookAfterFindRecord

Returns:

Type:: DoboAction | DoboModel.TResultFindRecord | Array.<DoboModel.TRecord>

(static) getIndexes() → {Array.<object>}

Returns the model's indexes.

Source: lib/factory/model.js, line 355

Returns:

Returns an array of index objects defined in the model

Type:: Array.<object>

(static) getNonVirtualProperties(namesOnlyopt) → {Array.<(object|string)>}

Get the model's non-virtual properties.

Parameters:

Name	Type	Attributes	Default	Description
`namesOnly`	boolean	<optional>	false	If `true`, return only property names instead of full property objects

Source: lib/factory/model.js, line 344

Returns:

Returns an array of non-virtual properties or property names based on the namesOnly option

Type:: Array.<(object|string)>

(static) getProperties(optionsopt) → {Array.<(object|string)>}

Get the model's properties based on the given options.

Parameters:

Name Type Attributes Default Description

options

Object

{}

Options object

Properties

Name	Type	Attributes	Default	Description
`noVirtual`	boolean	<optional>	false	If `true`, exclude virtual properties
`namesOnly`	boolean	<optional>	false	If `true`, return only property names instead of full property objects

Source: lib/factory/model.js, line 319

Returns:

Returns an array of properties or property names based on the options

Type:: Array.<(object|string)>

(static) getProperty(name) → {Object|null}

Get a property by its name.

Parameters:

Name	Type	Description
`name`	string	The name of the property to retrieve

Source: lib/factory/model.js, line 306

Returns:

Returns the property object if found, otherwise undefined

Type:: Object | null

(async, static) getRecord(id, optsopt) → {DoboAction|DoboModel.TResultGetRecord|DoboModel.TRecord}

Gets a record from the model's underlying data store based on the provided ID.

If no arguments are provided, it automatically turns into a chainable DoboAction object.

Parameters:

Name	Type	Attributes	Description
`id`	string \| number		The ID of the record to be retrieved.
`opts`	DoboModel.TOptions	<optional>	Options object.

Source: lib/factory/model/get-record.js, line 17
See: DoboModel.THookBeforeGetRecord
DoboModel.THookAfterGetRecord

Returns:

Type:: DoboAction | DoboModel.TResultGetRecord | DoboModel.TRecord

(static) getVirtualProperties(namesOnlyopt) → {Array.<(object|string)>}

Get the model's virtual properties.

Parameters:

Name	Type	Attributes	Default	Description
`namesOnly`	boolean	<optional>	false	If `true`, return only property names instead of full property objects

Source: lib/factory/model.js, line 332

Returns:

Returns an array of virtual properties or property names based on the namesOnly option

Type:: Array.<(object|string)>

(static) hasProperty(name) → {boolean}

Checks if the model has a property with the given name.

Parameters:

Name	Type	Description
`name`	string	The name of the property to check

Source: lib/factory/model.js, line 366

Returns:

Returns true if the property exists, otherwise false

Type:: boolean

(async, static) isExists(optsopt) → {DoboAction|DoboModel.TResult|boolean}

Checks if the model exists in the underlying data store.

Parameters:

Name	Type	Attributes	Description
`opts`	DoboModel.TOptions	<optional>	Options object.

Source: lib/factory/model/exists.js, line 14
See: DoboModel.THookBeforeModelExists
DoboModel.THookAfterModelExists

Returns:

Type:: DoboAction | DoboModel.TResult | boolean

(async, static) removeRecord(id, optsopt) → {DoboAction|DoboModel.TResultRemoveRecord|DoboModel.TRecord}

Removes a record from the model's underlying data store based on the provided ID.

If no arguments are provided, it automatically turns into a chainable DoboAction object.

Parameters:

Name	Type	Attributes	Default	Description
`id`	string \| number			The ID of the record to be removed.
`opts`	DoboModel.TOptions	<optional>	{}	Options object.

Source: lib/factory/model/remove-record.js, line 17
See: DoboModel.THookBeforeRemoveRecord
DoboModel.THookAfterRemoveRecord

Returns:

Type:: DoboAction | DoboModel.TResultRemoveRecord | DoboModel.TRecord

(async, static) sanitizeBody(optionsopt) → {Object}

Sanitize the payload body based on the model's properties and rules.

Parameters:

Name Type Attributes Default Description

options

Object

{}

Options object

Properties

Name	Type	Attributes	Default	Description
`body`	Object	<optional>	{}	Body object to sanitize
`partial`	boolean	<optional>	false	If `true`, only the fields present in the body will be sanitized
`strict`	boolean	<optional>	false	If `true`, only the fields defined in the model's properties will be included in the sanitized body
`extFields`	Array	<optional>	[]	Additional fields to include in the sanitized body
`truncateString`	boolean	<optional>	false	If `true`, string fields will be truncated to their maximum length defined in the model's properties
`action`	string	<optional>		The action being performed (e.g., 'createRecord', 'updateRecord', etc.)
`allProps`	boolean	<optional>	false	If `true`, all properties including virtual ones will be considered for sanitization

Source: lib/factory/model/sanitize-body.js, line 16

Returns:

Returns sanitized body object

Type:: Object

(async, static) sanitizeFixture(paramsopt, optsopt) → {Object}

Sanitize a fixture object by resolving lookup values and ensuring proper data types.

Parameters:

Name Type Attributes Default Description

params

Object

{}

Parameters object

Properties

Name	Type	Attributes	Default	Description
`body`	Object	<optional>	{}	Body object to sanitize
`lookupValue`	Object	<optional>	{}	Lookup values for resolving references in the body
`noLookup`	boolean	<optional>	false	If `true`, skip lookup resolution

opts

DoboModel.TOptions

{}

Options object for additional configurations

Source: lib/factory/model/sanitize-fixture.js, line 13

Returns:

Returns sanitized body object

Type:: Object

(static) sanitizeId(id) → {string|number}

Sanitize the given ID based on the model's properties.

Parameters:

Name	Type	Description
`id`	string \| number	The ID to sanitize

Source: lib/factory/model.js, line 293

Returns:

Returns the sanitized ID

Type:: string | number

(async, static) sanitizeRecord(recordopt, optsopt) → {Object}

Sanitize a record object based on the model's properties and rules.

Parameters:

Name Type Attributes Default Description

record

Object

Record object

opts

DoboModel.TOptions

{}

Options object

Properties

Name	Type	Attributes	Default	Description
`fields`	Array	<optional>		If not empty, only these fields will be included in the sanitized record
`hidden`	Array.<string>	<optional>	[]	List of fields to hide from the sanitized record
`forceNoHidden`	boolean	<optional>	false	If `true`, force ALL fields to be picked, thus ignoring hidden fields. If an array, force all fields except those in the array to be picked.
`fmt`	boolean	<optional>	false	If `true`, add a `_fmt` property to the sanitized record with formatted values automatically based on the model's properties and rules
`req`	Object	<optional>		Request object, used for formatting values based on request context

Source: lib/factory/model/sanitize-record.js, line 15

Returns:

Returns sanitized record object

Type:: Object

(async, static) sanitizeRef(obj, fatalopt)

Sanitize a reference object based on the model's properties and rules.

Parameters:

Name	Type	Attributes	Default	Description
`obj`	*			The reference object to sanitize
`fatal`	boolean	<optional>	true	Whether to throw an error if sanitization fails

Source: lib/factory/model.js, line 282

(async, static) updateRecord(id, body, optsopt) → {DoboAction|DoboModel.TResultUpdateRecord|DoboModel.TRecord}

Updates an existing record in the model's underlying data store based on the provided ID and data.

If no arguments are provided, it automatically turns into a chainable DoboAction object.

Parameters:

Name	Type	Attributes	Description
`id`	string \| number		The ID of the record to be updated.
`body`	object		The data to update the record with.
`opts`	DoboModel.TOptions	<optional>	Options object.

Source: lib/factory/model/update-record.js, line 19
See: DoboModel.THookBeforeUpdateRecord
DoboModel.THookAfterUpdateRecord

Returns:

Type:: DoboAction | DoboModel.TResultUpdateRecord | DoboModel.TRecord

(async, static) upsertRecord(body, optsopt) → {DoboAction|DoboModel.TResultCreateRecord|DoboModel.TResultUpdateRecord|DoboModel.TRecord}

Upserts a record in the model's underlying data store. If a record with the specified ID exists, it updates that record; otherwise, it creates a new record.

If no arguments are provided, it automatically turns into a chainable DoboAction object.

Parameters:

Name	Type	Attributes	Description
`body`	object		The data for the record to be upserted.
`opts`	DoboModel.TOptions	<optional>	Options object.

Source: lib/factory/model/upsert-record.js, line 61
See: DoboModel.THookBeforeUpsertRecord
DoboModel.THookAfterUpsertRecord

Returns:

Type:: DoboAction | DoboModel.TResultCreateRecord | DoboModel.TResultUpdateRecord | DoboModel.TRecord

(async, static) validate(body, joiModel, optionsopt) → {Object}

Validate body object against JOI model

Parameters:

Name Type Attributes Default Description

body

Object

Body object to validate

joiModel

Object

JOI model

options

Object

{}

Options object

Properties

Name	Type	Attributes	Default	Description
`extFields`	Array	<optional>	[]
`partial`	boolean	<optional>	false	If `true`, only the fields present in the body will be validated
`params`	Object	<optional>	{}	Validation parameters. See config and JOI validate's options

Source: lib/factory/model/validate.js, line 263

Returns:

Type:: Object

Type Definitions

TFilter

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`query`	string \| Object	<optional>	{}	Query definition. See query-language for more
`limit`	number			Maximum number of records to return
`page`	number			Which page to return
`skip`	number			Records to skip
`sort`	DoboModel.TSort			Sort order info

Source: lib/factory/model/find-record.js, line 4
See: Dobo#recordFind
Dobo#recordFindOne
Dobo#recordFindAll

TOptions

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`noHook`	boolean	<optional>	false	If `true`, no model's hook will be executed
`noModelHook`	boolean	<optional>	false	If `true`, no model's hook will be executed
`noDynHook`	boolean	<optional>	false	If `true`, no dynamic 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
`noBodySanitizer`	boolean	<optional>	false	If `true`, accept data payload as is without sanitization
`noRecordSanitizer`	boolean	<optional>	false	If `true`, accept result 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 model's `maxLength`
`partial`	boolean	<optional>		If `true`, only updated values are saved. Otherwise replace all existing values with given payload. Defaults to `true` for `updateRecord`
`dataOnly`	boolean	<optional>	true	If `true` (default) returns only record's object. Otherwise DoboModel.TResult

Source: lib/factory/model.js, line 31

TPagination

Type:

Object

Properties

Name	Type	Attributes	Description
`limit`	number		Number of records per page
`page`	number		Page number
`skip`	number	<optional>	Records to skip. If not provided, it will be calculated based on `limit` and `page`

Source: lib/factory/model.js, line 71

TPropertyType

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 6

TPropertyValue

Property value type definition. Used for building property values in a model which is an array of this object type.

Type:

Object

Properties

Name	Type	Description
`value`	string	The actual value of the property
`text`	string	The display text for the property value, which can be translated based on the request context

Source: lib/factory/model.js, line 79

TRecord

The record returned from a model's action. It is an object where:

Key represents the property name
Value represents its value according to the property's data type

This record is then merged with DoboModel.TRecordFormatted and DoboModel.TRecordRef to form the final record returned from a model's action.

Type:

Object | DoboModel.TRecordFormatted | DoboModel.TRecordRef

Source: lib/factory/model.js, line 142

Example

{
  id: 1,
  item: "Laptop",
  createdAt: "2024-01-01T00:00:00.000Z",
  isActive: true,
  price: 2500.00,
  _fmt: {
    id: "1",
    item: "Laptop",
    createdAt: "Jan 1, 2024, 12:00 AM",
    isActive: "True",
    price: "2,500.00"
  },
  _ref: {
    user: {
      id: 1,
      name: "John Doe"
    }
  }
}

TRecordFormatted

Formatted version of a record's property values. It is an object where:

Key represents the property name
Value represents its formatted value according to the property's data type or formatting function. Data type is ALWAYS in string.

This record is then wrapped in a _fmt property.

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`_fmt`	Object	<optional>	{}	Wrapper

Source: lib/factory/model.js, line 88

Example

{
  _fmt: {
    id: "1",
    item: "Laptop",
    createdAt: "Jan 1, 2024, 12:00 AM",
    isActive: "True",
    price: "2,500.00"
  }
}

TRecordRef

Reference record related to a record's result. It is an object where:

Key represents the name of the referenced record. Normally, it is the referenced model's name in camelCase format.
Value represents its reference record. It can be an object or an array of objects, depending on the relationship type.

This record is then wrapped in a _ref property in the result object.

Type:

Object

Properties

Name Type Attributes Default Description

_ref

Object

{}

Wrapper

Properties

Name	Type	Attributes	Description
`.`	Object \| Array	<optional>	Reference record

Source: lib/factory/model.js, line 110

Example

{
  _ref: {
    user: {
      id: 1,
      name: "John Doe"
    },
    posts: [
      {
        id: 1,
        title: "Post Title"
      },
      {
        id: 2,
        title: "Another Post Title"
      }
    ]
  }
}

TResultCreateRecord

The result returned from a model's createRecord action if dataOnly is set to false.

Type:

Object

Properties

Name	Type	Description
`data`	DoboModel.TRecord	The data returned from the action

Source: lib/factory/model.js, line 201

TResultFindRecord

The result returned from a model's find* actions if dataOnly is set to false.

Type:

Object

Properties

Name	Type	Attributes	Description
`data`	Array.<DoboModel.TRecord>		The data returned from the action
`count`	number	<optional>	The total number of records found, if applicable
`cached`	boolean	<optional>	Indicates if the result was retrieved from cache, if applicable. Only available if `bajoCache` is used
`warnings`	Array	<optional>	Any warnings generated during the action, if applicable

Source: lib/factory/model.js, line 182

TResultGetRecord

The result returned from a model's getRecord action if dataOnly is set to false.

Type:

Object

Properties

Name	Type	Description
`data`	DoboModel.TRecord	The data returned from the action

Source: lib/factory/model.js, line 193

TResultRecord

The result returned from a model's action other than find*, {create|update|remove}Record if dataOnly is set to false.

Type:

Object

Properties

Name	Type	Description
`data`	Array.<DoboModel.TRecord>	The data returned from the action

Source: lib/factory/model.js, line 174

TResultRemoveRecord

The result returned from a model's removeRecord action if dataOnly is set to false.

Type:

Object

Properties

Name	Type	Description
`oldData`	DoboModel.TRecord	The removed data returned from the action

Source: lib/factory/model.js, line 218

TResultUpdateRecord

The result returned from a model's updateRecord action if dataOnly is set to false.

Type:

Object

Properties

Name	Type	Description
`data`	DoboModel.TRecord	The updated data returned from the action
`oldData`	DoboModel.TRecord	The previous data before the update

Source: lib/factory/model.js, line 209

TSort

Key value pairs used as sort order in pagination and sorting of records. It is an object where:

Key represents model's field name
Value represents its sort order

Type:

Object.<string, DoboModel.TSortOrder>

Source: lib/factory/model.js, line 56

Example

// to sort by firstName (ascending) and lastName (descending)
const sort = {
  firstName: 1,
  lastName: -1
}

TSortOrder

Sort order key used in pagination and sorting of records. It can be either:

1 for ascending order (the default, if none is provided) or
-1 for descending order.

Type:

string

Source: lib/factory/model.js, line 48

TValidator

All available validators to check against model's properties and rules

Type:

Object

Properties

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

Source: lib/factory/model/validate.js, line 82

TValidatorArray

List of available array validators to check against model's properties and rules

Type:

Array.<string>

Properties

Name	Type	Default
`0`	string	length
`1`	string	max
`2`	string	min

Source: lib/factory/model/validate.js, line 94

TValidatorBoolean

List of available boolean validators to check against model's properties and rules

Type:

Array.<string>

Properties

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

Source: lib/factory/model/validate.js, line 55

TValidatorDate

List of available date validators to check against model's properties and rules

Type:

Array.<string>

Properties

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

Source: lib/factory/model/validate.js, line 64

TValidatorNumber

List of available number validators to check against model's properties and rules

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: lib/factory/model/validate.js, line 39

TValidatorString

List of available string validators to check against model's properties and rules

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: lib/factory/model/validate.js, line 6

TValidatorTimestamp

List of available timestamp validators to check against model's properties and rules

Type:

Array.<string>

Properties

Name	Type	Default	Description
`0`	string	timestamp

Source: lib/factory/model/validate.js, line 75