From 46f6911ef83004df7a95ad4b0da624b810e85577 Mon Sep 17 00:00:00 2001 From: Julien Fontanet Date: Tue, 7 Jun 2016 16:27:05 +0200 Subject: [PATCH] feat(README): add usage --- packages/xo-acl-resolver/README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/packages/xo-acl-resolver/README.md b/packages/xo-acl-resolver/README.md index 6904d5bae..371fa5483 100644 --- a/packages/xo-acl-resolver/README.md +++ b/packages/xo-acl-resolver/README.md @@ -12,7 +12,29 @@ Installation of the [npm package](https://npmjs.org/package/xo-acl-resolver): ## Usage -**TODO** +```js +import check from 'xo-acl-resolver' + +// This object contains a list of permissions returned from +// xo-server's acl.getCurrentPermissions. +const permissions = { /* ... */ } + +// This function should returns synchronously an object from an id. +const getObject = id => { /* ... */ } + +// For a single object: +if (check(permissions, getObject, objectId, permission)) { + console.log(`${permission} set for object ${objectId}`) +} + +// For multiple objects/permissions: +if (check(permissions, getObject, [ + [ object1Id, permission1 ], + [ object12d, permission2 ], +])) { + console.log('all permissions checked') +} +``` ## Development