nestjs-eve-auth docs

Class: EveAuthModule

Main module of nestjs-eve-auth library.

Provides configuration to the library and exports its public API. You can import this simply in your application's root module or encapsulate it in another module.

Hierarchy

  • ConfigurableEveAuthModule

    ↳ EveAuthModule

Constructors

constructor

• new EveAuthModule(): EveAuthModule

Returns

EveAuthModule

Inherited from

ConfigurableEveAuthModule.constructor

Defined in

lib/node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12

Properties

forRoot

▪ Static forRoot: (options: EveAuthModuleOptions & Partial<{}>) => DynamicModule

Type declaration

▸ (options): DynamicModule

Configure nestjs-eve-auth and return the module for importing in a Nest.js module definition. See configuration docsopen in new window.

Parameters
NameType
optionsEveAuthModuleOptions & Partial<{}>
Returns

DynamicModule

Inherited from

ConfigurableEveAuthModule.forRoot

forRootAsync

▪ Static forRootAsync: (options: ConfigurableModuleAsyncOptions<EveAuthModuleOptions, "create"> & Partial<{}>) => DynamicModule

Type declaration

▸ (options): DynamicModule

Configure nestjs-eve-auth asynchronously and return the module for importing in a Nest.js module definition. See configuration docsopen in new window.

Parameters
NameType
optionsConfigurableModuleAsyncOptions<EveAuthModuleOptions, "create"> & Partial<{}>
Returns

DynamicModule

Inherited from

ConfigurableEveAuthModule.forRootAsync