Skip to Content
API ReferenceInterfacesInterface: AuthgearModuleAsyncOptions

@authgear/nestjs


@authgear/nestjs / AuthgearModuleAsyncOptions

Interface: AuthgearModuleAsyncOptions

Defined in: src/authgear.interfaces.ts:23 

Options accepted by AuthgearModule.forRootAsync().

Extends

  • Pick<ModuleMetadata, "imports">

Properties

global?

optional global: boolean

Defined in: src/authgear.interfaces.ts:28 

Register AuthgearAuthGuard as a global APP_GUARD. Default false.


imports?

optional imports: (DynamicModule | Type<any> | Promise<DynamicModule> | ForwardReference<any>)[]

Defined in: node_modules/@nestjs/common/interfaces/modules/module-metadata.interface.d.ts:18

Optional list of imported modules that export the providers which are required in this module.

Inherited from

Pick.imports


inject?

optional inject: any[]

Defined in: src/authgear.interfaces.ts:30 

Providers to inject into useFactory.


useFactory()

useFactory: (…args) => AuthgearModuleOptions | Promise<AuthgearModuleOptions>

Defined in: src/authgear.interfaces.ts:32 

Factory returning the runtime options.

Parameters

args

any[]

Returns

AuthgearModuleOptions | Promise<AuthgearModuleOptions>