rolemodel  

> Easily juggle roles in your project

Install

``
$ npm install rolemodel
`

Usage

`js
const rolemodel = require('rolemodel');

rolemodel('unicorns');
//=> 'unicorns & rainbows'
`

API

$3

Return: Role

Create role model.

#### name

Type: string

Simple name of the role.

Example:

`js
const Example = roleExample([], {})

const FooBar = roleFooBar([], {})

const num = 1
const Demo1 = roleDemo${num}([], {})
`

#### impl

Type: Role[] Array of the Roles

Parent roles which rules inherited from.
Rules concats from all parents.

Example:

`js
const First = roleFirst([], { foo: true })

const Second = roleSecond([First], { bar: true })
// Second has all rules from First { foo: true, bar: true }
const Third = roleThird([], { baz: true })

const Total = roleTotal([Second, Third], { daf: true })
// Total has all rules from First, Second, Third { foo: true, bar: true, baz: true, daf: true }
`

#### rules

Type: object

Any object of rules with boolean as values.
Rules in current role overwrites rules in parent roles.

Example:

`js
const Basic = roleBasic([], {
post: {
create: false,
update: false,
delete: false,
moderationAccept: false,
moderationDecline: false,
},
})

const User = roleUser([Basic], {
post: {
create: true,
update: true,
},
})

const Moderator = roleModerator([Basic], {
post: {
moderationAccept: true,
moderationDecline: true,
},
})

const Admin = roleAdmin([User], {
post: {
delete: true,
},
})
`

$3

#### .is(name)

Return: boolean

Method check name of the role.

##### name

Type: string

Expected name of the role

Example:

`js
const Role = roleRole([], {})

Role.is('Role') // true
Role.is('Foo') // false
`

#### .can(name)

Return: boolean

Check if role has true right.

##### name

Type: string

Name of the target rule.
If rule not found returns false.


Example:

`js
const Example = roleExample([], { foo: true, bar: { baz: true } })

Example.can('foo') // true
Example.can('bar.baz') // true
Example.can('DemoDemoDemo') // false


const Child = roleChild([Example], { demo: true, bar: { foo: true } })

Child.can('foo') // true
Child.can('bar.baz') // true
Child.can('bar.foo') // true
Child.can('demo') // true
Child.can('FFFFFFF') // false
`

#### .has(name)

Return: boolean

Check if role has right with any value.
If rule not found returns false.

##### name

Type: string

Name of the target rule.

Example:

`js
const Example = roleExample([], { bar: { baz: true, demo: false } })

Example.has('foo') // false
Example.has('bar.baz') // true
Example.has('bar.demo') // true
Example.has('DemoDemoDemo') // false


const Child = roleChild([Example], { bar: { foo: true } })

Child.has('foo') // false
Child.has('bar.baz') // true
Child.has('bar.foo') // true
Child.has('demo') // false
Child.has('FFFFFFF') // false
``

License

MIT © Sergey Sova