API

access-controller

modnes Access Controller

Meta

• author: Luiz Henrique Canet Filho <me@luizca.net>

User

User object with optional roles property as array

Type: Object

Constraints

Constraints object with roles and/or functions property as array

Type: Object

constraintFunction

This is called when cheking functions

Type: Function

Parameters

• user User

Returns Boolean

AccessController

AccessController

hasAccess

Check if an user has access against constraints

Parameters

• user User User object
• constraints Constraints [description]

Returns Boolean

userHasRoles

Checks if the user has any of the roles

Parameters

• user User User object
• roles Array<string> Allowed roles

Returns Boolean

callFunctions

Check if all functions returns true

Parameters

• user User [description]
• functions Array<constraintFunction> [description]

Returns Boolean