Nestjs ACL Documentation

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AclRulesCreator

AclRulesCreator<Data, Source, Context>: (options: AclRulesCreatorOptions<Data, Source, Context>) => AclRule[] | Promise<AclRule[]>

The signature of a acl rule creator

Type parameters

Data = any
Source = any
Context: AclContext = any

Type declaration

- (options: AclRulesCreatorOptions<Data, Source, Context>): AclRule[] | Promise<AclRule[]>
- Parameters
  - options: AclRulesCreatorOptions<Data, Source, Context>
  Returns AclRule[] | Promise<AclRule[]>

CheckReturnType

CheckReturnType: (boolean | Error | undefined) | Promise<boolean | Error | undefined>

Variables

Const OPTIONS_TOKEN

OPTIONS_TOKEN: "nestjs-acl-options" = 'nestjs-acl-options'

Const ROLES_BUILDER_TOKEN

ROLES_BUILDER_TOKEN: "nestjs-acl-roles" = 'nestjs-acl-roles'

Functions

InjectOptions

InjectOptions(): (target: object, key: string | symbol, index?: number) => void

- Defined in src/decorators.ts:15
A nestjs param decorator to inject the options into providers

Returns (target: object, key: string | symbol, index?: number) => void
- - (target: object, key: string | symbol, index?: number): void
  - Parameters
    - target: object
    - key: string | symbol
    - Optional index: number
    Returns void

InjectRolesBuilder

InjectRolesBuilder(): (target: object, key: string | symbol, index?: number) => void

- Defined in src/decorators.ts:8
A nestjs param decorator to inject the role builder instance into providers

Returns (target: object, key: string | symbol, index?: number) => void
- - (target: object, key: string | symbol, index?: number): void
  - Parameters
    - target: object
    - key: string | symbol
    - Optional index: number
    Returns void