Members

inner __cfg

index.js, line 15

Properties:

Name	Type	Description
warning	Number	0|1 By default 1
methodName	String	By default 'searchable'

inner, constant _defaultOptionsValues

index.js, line 30

List of available options for a route

Properties:

Name	Type	Description
defaultLimit	Number	Display n items per page, By default 10
searchParams	Object	Default mongoose conditions
defaultFields	Object	Default fields to get
defaultQueryOptions	Object	Mongoose options { order... }

Methods

inner configure(params)

index.js, line 169

Configure RestList

Parameters:

Name	Type	Description
params	Object

Example

restList.configure({
   warning: 0,
   methodName: 'displayFields'
})

inner restList(router, model, routePath, Middlewares, options)

index.js, line 49

Set a new GET route in router object

• constraint : router must be set
• constraint : model must be set
• constraint : routePath must be set

Parameters:

Name	Type	Description
router	Router	Express Router object
model	Object	Mongoose model
routePath	String	Route path
Middlewares	Array	Array of middlewares
options	Object	Query options

Tutorials:

• how_to_use

Example

restList(router, Items, '/list_items')