Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AclService

Hierarchy

  • AclService

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected globalOptions

globalOptions: AclModuleOptions & {} = {}

A key/value pair object of the global options to pass to rule creator during check. All rules would be able to read those object keys

Protected log

log: Debugger = ...

The log function

Protected options

options: AclModuleOptions

Protected Readonly rolesBuilder

rolesBuilder: AccessControl

Protected rules

rules: Map<string, AclRulesCreator<any, any, any>> = ...

A Map of AclRules

Methods

check

  • This method will check that each rules returned are granted.

    throws

    Error|ForbiddenException If access is not granted

    Type parameters

    • D = any

    • S = any

    Parameters

    Returns Promise<{ data?: D; rule?: AclRule }>

getRolesBuilder

Protected isValidRule

  • isValidRule(rule: AclRule): Promise<undefined | boolean | Error>

  • Check if an AclRule is valid

    Parameters

    Returns Promise<undefined | boolean | Error>

registerRules

setGlobalOptions