Options

Global Options

Global options can be passed on to the express-mongoose-acl object itself.

• globalPermissions: see Quick Start - Global Permissions
• permissionField: the global permission field name, default to _permissions
• idParam: the name of Route parameter that is used to capture the document ID, default to id

Model Router Options

Router options can be passed on to the instance constructor or to the each setter methods.

• baseUrl
• listHardLimit
• permissionSchema: see Quick Start - Permission Schema
• permissionField
• mandatoryFields
• docPermissions: see Quick Start - Document Permissions
• routeGuard: see Quick Start - Route Guard
• baseQuery: see Quick Start - Base Query
• validate: see Middleware - Validate
• prepare: see Middleware - Prepare
• transform: see Middleware - Transform
• decorate: see Middleware - Decorate
• decorateAll: see Middleware - Decorate All

• identifier: this option defines how id param is used to find the target document, defaults to _id field; there is more than one way to define the relation:

  • string: Mongoose document field key
  • function: Function returns a Mongoose query to find the target document.

userRouter.identifier(function (id) {
  return { $or: [{ _id: id }, { code: id }] };
});