Skip to content

Class: RbacModule ​

Defined in: packages/nestjs/src/module.ts:43

Registers rbac-evolution in a Nest application (global module).

ts
@Module({
  imports: [
    RbacModule.forRoot({
      rbac,
      getSubject: (ctx) => {
        const user = ctx.switchToHttp().getRequest().user
        return user ? { type: 'user', id: user.id } : null
      },
    }),
  ],
})
export class AppModule {}

Constructors ​

Constructor ​

ts
new RbacModule(): RbacModule;

Returns ​

RbacModule

Methods ​

forRoot() ​

ts
static forRoot<T>(config): DynamicModule;

Defined in: packages/nestjs/src/module.ts:44

Type Parameters ​

Type ParameterDefault type
T extends RbacTypeConfigDefaultRbacTypes

Parameters ​

ParameterType
configRbacModuleConfig<T>

Returns ​

DynamicModule


forRootAsync() ​

ts
static forRootAsync<T>(config): DynamicModule;

Defined in: packages/nestjs/src/module.ts:50

Like forRoot, with options built by a factory (e.g. from a ConfigService).

Type Parameters ​

Type ParameterDefault type
T extends RbacTypeConfigDefaultRbacTypes

Parameters ​

ParameterType
configRbacModuleAsyncConfig<T>

Returns ​

DynamicModule

Released under the MIT License. Inspired by spatie/laravel-permission.