List

List operation executes hook methods in the following sequence:

Hook	Parameters	Description
docPermissions	Mongoose document / plain document object global permissions	skips if option includePermissions set to false called after Mongoose execute the query runs on each document
decorate	plain document object global permissions	runs on each document object
decorateAll	plain document objects global permissions	runs on set of document objects

Configuration Example

modelRouter.docPermissions('list', function (docOrObject, globalPermissions) {
  const isMe = String(docOrObject._id) === String(this.user._id);

  return {
    canEdit: globalPermissions.isAdmin || isMe,
  };
});

modelRouter.decorate('list', function (docObject, globalPermissions) {
  docObject.decoratedBy = 'egose';
  return docObject;
});

modelRouter.decorateAll(function (docObjects, globalPermissions) {
  const filtered = docObjects.filter((doc) => doc.public);
  return filtered;
});