Module: Hook

Available hooks for Dobo's operations. You can use these hooks to customize the behavior of the model's CRUD operations.

For any of the hooks below, you can also use the modelName in camelCase format to create a model-specific hook. If you choose to use this format, you must omit the first parameter (model) so that the hook function handler syntax will become like this:

dobo.{modelName}:beforeCreateRecord (body, options)
dobo.{modelName}:afterCreateRecord (body, options)
dobo.{modelName}:beforeFindRecord (filter, options)
dobo.{modelName}:afterFindRecord (filter, result, options)
...

You can use both formats simultaneously if you want. In that case, they will be executed in this order:

dobo:beforeCreateRecord (model, body, options)
dobo.{modelName}:beforeCreateRecord (body, options)
...
dobo.{modelName}:afterCreateRecord (body, result, options)
dobo:afterCreateRecord (model, body, result, options)

For both formats, there are their counterparts that run deep inside the adapter. Only use these hooks if you know what you are doing.

Their syntax is similar to the above, with one exception: you need to put suffix .adapter after dobo:

dobo.adapter:beforeAdapterCreateRecord (model, body, options)
dobo.adapter.{modelName}:beforeAdapterCreateRecord (body, options)

Source: extend/bajo/hook-docs.js, line 1

Methods

(async, static) dobo:afterCountRecord(model, filter, result, options)

Hook that is called after counting records.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`filter`	DoboModel.TFilter	The filter criteria that was applied when counting records
`result`	DoboModel.TResultCountRecord	The result of the count operation
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 200

(async, static) dobo:afterCreateRecord(model, body, result, options)

Hook that is called after creating a record.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`body`	object	The body payload to be created
`result`	DoboModel.TResultRecord	The result of the create operation
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 47

(async, static) dobo:afterFindAllRecord(model, filter, result, options)

Hook that is called after finding all records.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`filter`	DoboModel.TFilter	The filter criteria applied when finding all records
`result`	DoboModel.TResultFindAllRecord	The result of the find all operation
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 123

(async, static) dobo:afterFindOneRecord(model, filter, result, options)

Hook that is called after finding one record.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`filter`	DoboModel.TFilter	The filter criteria applied when finding one record
`result`	DoboModel.TResultFindOneRecord	The result of the find one operation
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 98

(async, static) dobo:afterFindRecord(model, filter, result, options)

Hook that is called after finding records.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`filter`	DoboModel.TFilter	The filter criteria applied when finding records
`result`	DoboModel.TResultFindRecord	The result of the find operation
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 72

(async, static) dobo:afterGetRecord(model, id, result, options)

Hook that is called after getting a record by ID.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`id`	string \| number	The ID of the record that was retrieved
`result`	DoboModel.TResultGetRecord	The result of the get operation
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 225

(async, static) dobo:afterRemoveRecord(model, id, result, options)

Hook that is called after removing a record.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`id`	string \| number	The ID of the record that was removed
`result`	DoboModel.TResultRemoveRecord	The result of the remove operation
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 175

(async, static) dobo:afterUpdateRecord(model, id, body, result, options)

Hook that is called after updating a record.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`id`	string \| number	The ID of the record that was updated
`body`	object	The body payload that was updated
`result`	DoboModel.TResultUpdateRecord	The result of the update operation
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 149

(async, static) dobo:beforeCountRecord(model, filter, options)

Hook that is called before counting records.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`filter`	DoboModel.TFilter	The filter criteria to apply when counting records
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 188

(async, static) dobo:beforeCreateRecord(model, body, options)

Hook that is called before creating a record.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`body`	object	The body payload to be created
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 35

(async, static) dobo:beforeFindAllRecord(model, filter, options)

Hook that is called before finding all records.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`filter`	DoboModel.TFilter	The filter criteria to apply when finding all records
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 111

(async, static) dobo:beforeFindOneRecord(model, filter, result, options)

Hook that is called before finding one record.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`filter`	DoboModel.TFilter	The filter criteria to apply when finding one record
`result`	DoboModel.TResultFindRecord	The result of the find operation
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 85

(async, static) dobo:beforeFindRecord(model, filter, options)

Hook that is called before finding records.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`filter`	DoboModel.TFilter	The filter criteria to apply when finding records
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 60

(async, static) dobo:beforeGetRecord(model, id, options)

Hook that is called before getting a record by ID.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`id`	string \| number	The ID of the record to be retrieved
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 213

(async, static) dobo:beforeRemoveRecord(model, id, options)

Hook that is called before removing a record.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`id`	string \| number	The ID of the record to be removed
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 163

(async, static) dobo:beforeUpdateRecord(model, id, body, options)

Hook that is called before updating a record.

Parameters:

Name	Type	Description
`model`	DoboModel	The model instance
`id`	string \| number	The ID of the record to be updated
`body`	object	The body payload to be updated
`options`	DoboModel.TOptions	The options object

Source: extend/bajo/hook-docs.js, line 136