preston (master)

# Model(restifier, model)

Constructor.

Parameters

# Model.applyModifiers(request)

Applies the modifiers of this model onto a request.

Parameters

# Model.applyTransforms(req, doc, cb)

Applies all of the transforms defined on this model on a document.

Parameters

# Model.filter(name, filter)

Adds a filter to this model. Filters are user-defined functions that modify the query. They work very similarly to AngularJS filters. They can be chained and take parameters, allowing immense flexibility for developers to add features to APIs. Filters are called like this: GET /people?filter=children They can also be chained like this: GET /people?filter=children | proximity 5

Parameters

# Model.getUriBases()

Gets the URI bases of the model.

# Model.limit(num)

Modifies the limit parameter. Internally, this applies a {@link modifyParam} that restricts the limit parameter to be no greater than what is given here.

Parameters

# Model.middleware()

Creates a middleware of this model. It is preferable to use {@link RestAPI#middleware} as that function provides the necessary error handling and invalid method middlewares.

# Model.modifyParam(param, modifier)

Modifies a query parameter. Modifiers alter the query parameters that will be passed to the pipeline. Modifiers are applied before any logic is called. To modify a parameter, pass the name of the parameter you wish to modify and a callback that returns the modified value of the parameter.

Parameters

# Model.printRoutes()

Prints the routes corresponding to this model.

# Model.serve(router)

Serves this model on a RESTful API. Don't use this method; use the middleware instead via {@link RestAPI#middleware}.

Parameters

# Model.submodel(field, correspondsTo, model)

Makes a field a submodel, meaning that field has its own routes for query/crud. Note that you cannot create a submodel of a submodel.

Parameters

# Model.transform(transformer)

Adds a transformer to this model. Transformers change the returned results. One transformer is built in, the restricted transformer, and cannot be changed.

Parameters

# Model.transformPopulate(field, transformer)

Adds a population transformer to this model. Population transformers are transformers that operate on populated fields. They can be used to make your application more secure by removing fields you don't want people to see.

Parameters

# Model.use(route, middleware)

Uses a middleware on a certain route. These middlewares are called in the order that they are added to this model.

Parameters

# RestAPI()

Represents a RESTful API powered by Restifier.

# RestAPI.addModels(mongs)

Adds multiple models to this RestAPI.

Parameters

# RestAPI.asFunction()

Creates a setup function for this RestAPI.

# RestAPI.finish()

Should be called after the app has been created.

# RestAPI.middleware()

Creates middleware that encompasses all registered models. This is equivalent to calling model.middleware() for each individual model, plus calling restifier.initialize() and restifier.finish().

# RestAPI.model(mong)

Adds a model to this RestAPI.

Parameters

# RestAPI.modelsMiddleware(mongs)

Creates a middleware out of multiple models.

Parameters

# RestAPI.printRoutes()

Prints all routes corresponding to this RestAPI.

# RestAPI.setup()

Gateway function that can add model(s) or return initialization middleware depending on the arguments passed to it.

# RestAPI.use()

Applies middleware to this RestAPI. Uses express.Router#use.

# restifier()

The main function. Wraps {@link RestAPI#setup}.

# restifier.api()

Factory function to create a new {@link RestAPI}.

# exports.default()

The default route that will be called if nothing else is.

# exports.query(model)

The query route.

Parameters