generic-model-bookshelf 0.4.3

generic-model-bookshelf

0.4.3

GenericModel ▸
QueryBuilderUtils ▸
- Static members
- .OPERATORS
- .getAttrsOperators
- .getAttrOperators
- .getOperatorObject

Need help reading this?

GenericModel

Generic model for bookshelf ORM

new GenericModel()

Extends bookshelf.Model

Static Members

▸ DEFAULT_GENERIC_MODEL_PARAMS

A mix of bookshelf and custom options (override this with the desired one)

DEFAULT_GENERIC_MODEL_PARAMS

Type: Object

Properties

idAttribute ((string | Array<string>)) : The id attr name(s)

hasTimestamps (Boolean) : Whether it has created_at, updated_at, deleted_at, restored_at or not

▸ DEFAULT_GENERIC_MODEL_PARAMS

The default GenericModel params

DEFAULT_GENERIC_MODEL_PARAMS

Type: GenericModelParams

Properties

idAttribute (string?)

hasTimestamps (Boolean?)

▸ GENERIC_MODEL_PARAMS

A mix of bookshelf and custom options (override this with the desired one)

GENERIC_MODEL_PARAMS

Type: GenericModelParams

▸ MODEL_PARAMS

The GenericModel params used internally

MODEL_PARAMS

Type: GenericModelParams

▸ GET_ALL_DEFAULT_PARAMS

The default filter params for [.getAll]GenericModel.getAll

GET_ALL_DEFAULT_PARAMS

Type: Object

▸ GET_ALL_DEFAULT_FETCH_OPTIONS

The default fetch for [.getAll]GenericModel.getAll

GET_ALL_DEFAULT_FETCH_OPTIONS

Type: Object

▸ COUNT_DEFAULT_PARAMS

The default filter params for [.getCount]GenericModel.getCount

COUNT_DEFAULT_PARAMS

Type: Object

▸ getAll(params, fetchOptions)

Returns the list of objects

getAll(params: Object, fetchOptions: Object): Promise<Array>

Parameters

params (Object) The params object to filter the attrs

Name	Description
params.page `Number`	The `page` itens
params.pageSize `Number`	The `page` size
params.orderBy `(Object \| string)`	The `attrName` to order for (asc) or an object, `attrName: 'ASC \| DESC'`
params.distinct `Array`	The `distinct` attrs to group
params.genericSearch `string`	The `genericSearch` text

fetchOptions

(Object
            = {})

The bookshelf fetch options (@see https://bookshelfjs.org/api.html#Model-instance-fetch )

Returns

Promise<Array>: The resulted list

▸ getCount(params)

Returns the count of objects

getCount(params: Object): Number

Parameters

params (Object) The params object to filter the attrs

Returns

Number: The count value

▸ getOne(params, fetchOptions)

Return one object

getOne(params: Object, fetchOptions: Object): Object

Parameters

params

(Object
            = {})

The params object to filter the attrs

fetchOptions

(Object
            = {})

The bookshelf fetch options (@see https://bookshelfjs.org/api.html#Model-instance-fetch )

Returns

Object: The object found

▸ findById(id, options = {})

Returns the model by id

findById(id: any, options: Object?): Promise<Object>

Parameters

id (any) The id attr

options

(Object?
            = {})

The bookshelf fetch options

Returns

Promise<Object>: The model

▸ isPersisted(id)

Returns whether it's persisted or not

isPersisted(id: (string | Number | Object)): Boolean

Parameters

id ((string | Number | Object)) The id value

Returns

Boolean: Whether it's persisted or not

▸ _getQueryAll(params, queryBuilder)

Returns the default queryBuilder query

_getQueryAll(params: Object, queryBuilder: Object): Object

Parameters

params (Object) The params object

Name	Description
params.genericSearch `string`	The `generic search` text

queryBuilder (Object) The knex queryBuilder object

Returns

Object: The knex queryBuilder object

▸ _getQueryGenericSearch(genericSearch, queryBuilder)

Returns the queryBuilder query for generic search

_getQueryGenericSearch(genericSearch: string, queryBuilder: Object): Object

Parameters

genericSearch (string) The generic search text

queryBuilder (Object) The knex queryBuilder object

Returns

Object: The knex queryBuilder object

QueryBuilderUtils

Contains a set of sql query builder utils

new QueryBuilderUtils()

Static Members

▸ OPERATORS

The list of operators

OPERATORS

Type: Object

Properties

operator (Object) : The operator object

operator.name string
The operator's name
operator.operator string
The operator value (ie. =, >=, in, etc)

▸ getAttrsOperators(attrNames)

Returns a list of attrNames concatened with each operator QueryBuilderUtils.OPERATORS

getAttrsOperators(attrNames: (Array | string)): Array

Parameters

attrNames ((Array | string)) The list of attr names

Returns

Array: The list of attrsOperators

Example

const attrNames = ['la', 'le', 'li']

QueryBuilderUtils.getAttrsOperators(attrNames)
// ['la_start', 'la_end', ..., 'le_end', 'le_like', ..., 'li_likeIgnoreCase', 'li_in', ...]

QueryBuilderUtils.getAttrsOperators('la')
// ['la_start', 'la_end', 'la_like', 'la_likeIgnoreCase', ...]

▸ getAttrOperators(attrName)

Returns a list of attrName concatened with each operator QueryBuilderUtils.OPERATORS

getAttrOperators(attrName: string): Array

Parameters

attrName (string) The attr name

Returns

Array: The list of attrOperators

Example

const attrName = 'la'

QueryBuilderUtils.getAttrOperators('la')
// ['la_start', 'la_end', 'la_like', 'la_likeIgnoreCase', ...]

QueryBuilderUtils.getAttrOperators(null)
// []

▸ getOperatorObject(attr)

Returns the [operator object]QueryBuilderUtils.OPERATORS

getOperatorObject(attr: string): Object

Parameters

attr (string) The attrName with _operator at the end

Returns

Object: The [ operator object] QueryBuilderUtils.OPERATORS