Class Module

Hierarchy

Module

Callable

Module(metadata: ModuleMetadata): ClassDecorator

- Defined in common/decorators/modules/module.decorator.ts:33
Defines the module
- imports - the set of the 'imported' modules
- controllers - the list of controllers (e.g. HTTP controllers)
- providers - the list of providers that belong to this module. They can be injected between themselves.
- exports - the set of components, which should be available for modules, which imports this module
Parameters
- metadata: ModuleMetadata
Returns ClassDecorator

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Module(_metatype: Type<any>, _scope: Type<any>[], container: NestContainer): Module

- Defined in core/injector/module.ts:62
Parameters
- _metatype: Type<any>
- _scope: Type<any>[]
- container: NestContainer
Returns Module

Properties

Private _controllers

_controllers: any = new Map<string,InstanceWrapper<Controller>>()

Private _exports

_exports: any = new Set<string | symbol>()

Private _id

_id: string

Private _imports

_imports: any = new Set<Module>()

Private _injectables

_injectables: any = new Map<any, InstanceWrapper<Injectable>>()

Private _metatype

_metatype: Type<any>

Private _providers

_providers: any = new Map<any, InstanceWrapper<Injectable>>()

Private _scope

_scope: Type<any>[]

Private container

container: NestContainer

Accessors

components

get components(): Map<string, InstanceWrapper<Injectable>>

- Defined in core/injector/module.ts:99
Left for backward-compatibility reasons

Returns Map<string, InstanceWrapper<Injectable>>

controllers

get controllers(): Map<string, InstanceWrapper<Controller>>

- Defined in core/injector/module.ts:114
Returns Map<string, InstanceWrapper<Controller>>

exports

get exports(): Set<string | symbol>

- Defined in core/injector/module.ts:118
Returns Set<string | symbol>

id

get id(): string

- Defined in core/injector/module.ts:73
Returns string

imports

get imports(): Set<Module>

- Defined in core/injector/module.ts:85
Returns Set<Module>

injectables

get injectables(): Map<string, InstanceWrapper<Injectable>>

- Defined in core/injector/module.ts:110
Returns Map<string, InstanceWrapper<Injectable>>

instance

get instance(): NestModule

- Defined in core/injector/module.ts:122
Returns NestModule

metatype

get metatype(): Type<any>

- Defined in core/injector/module.ts:130
Returns Type<any>

providers

get providers(): Map<any, InstanceWrapper<Injectable>>

- Defined in core/injector/module.ts:81
Returns Map<any, InstanceWrapper<Injectable>>

relatedModules

get relatedModules(): Set<Module>

- Defined in core/injector/module.ts:92
Left for backward-compatibility reasons

Returns Set<Module>

routes

get routes(): Map<string, InstanceWrapper<Controller>>

- Defined in core/injector/module.ts:106
Left for backward-compatibility reasons

Returns Map<string, InstanceWrapper<Controller>>

scope

get scope(): Type<any>[]

- Defined in core/injector/module.ts:77
Returns Type<any>[]

Methods

addController

addController(controller: Type<Controller>): void

- Defined in core/injector/module.ts:348
Parameters
- controller: Type<Controller>
Returns void

addCoreProviders

addCoreProviders(container: NestContainer): void

- Defined in core/injector/module.ts:134
Parameters
- container: NestContainer
Returns void

addCustomClass

addCustomClass(provider: CustomClass, collection: Map<string, InstanceWrapper>): void

- Defined in core/injector/module.ts:248
Parameters
- provider: CustomClass
- collection: Map<string, InstanceWrapper>
Returns void

addCustomExportedProvider

addCustomExportedProvider(provider: CustomFactory | CustomValue | CustomClass): any

- Defined in core/injector/module.ts:320
Parameters
- provider: CustomFactory | CustomValue | CustomClass
Returns any

addCustomFactory

addCustomFactory(provider: CustomFactory, collection: Map<string, InstanceWrapper>): void

- Defined in core/injector/module.ts:284
Parameters
- provider: CustomFactory
- collection: Map<string, InstanceWrapper>
Returns void

addCustomProvider

addCustomProvider(provider: CustomFactory | CustomValue | CustomClass, collection: Map<string, any>): string

- Defined in core/injector/module.ts:213
Parameters
- provider: CustomFactory | CustomValue | CustomClass
- collection: Map<string, any>
Returns string

addCustomValue

addCustomValue(provider: CustomValue, collection: Map<string, InstanceWrapper>): void

- Defined in core/injector/module.ts:266
Parameters
- provider: CustomValue
- collection: Map<string, InstanceWrapper>
Returns void

addExportedProvider

addExportedProvider(provider: ProviderMetatype | string | symbol | DynamicModule): any

- Defined in core/injector/module.ts:303
Parameters
- provider: ProviderMetatype | string | symbol | DynamicModule
Returns any

addInjectable

addInjectable<T>(injectable: Type<T>, host?: Type<T>): string

- Defined in core/injector/module.ts:166
Type parameters
- T: Injectable
Parameters
- injectable: Type<T>
- Optional host: Type<T>
Returns string

addModuleAsProvider

addModuleAsProvider(): void

- Defined in core/injector/module.ts:153
Returns void

addModuleRef

addModuleRef(): void

- Defined in core/injector/module.ts:139
Returns void

addProvider

addProvider(provider: ProviderMetatype): string

- Defined in core/injector/module.ts:189
Parameters
- provider: ProviderMetatype
Returns string

addRelatedModule

addRelatedModule(module: any): void

- Defined in core/injector/module.ts:362
Parameters
- module: any
Returns void

createModuleReferenceType

createModuleReferenceType(): any

- Defined in core/injector/module.ts:399
Returns any

Private getClassScope

getClassScope(provider: ProviderMetatype): Scope

- Defined in core/injector/module.ts:428
Parameters
- provider: ProviderMetatype
Returns Scope

getProviderByKey

getProviderByKey<T>(name: string | symbol): InstanceWrapper<T>

- Defined in core/injector/module.ts:395
Type parameters
- T
Parameters
- name: string | symbol
Returns InstanceWrapper<T>

getProviderStaticToken

getProviderStaticToken(provider: string | symbol | Type<any>): string | symbol

- Defined in core/injector/module.ts:387
Parameters
- provider: string | symbol | Type<any>
Returns string | symbol

hasInjectable

hasInjectable(token: string | symbol | Type<any>): boolean

- Defined in core/injector/module.ts:382
Parameters
- token: string | symbol | Type<any>
Returns boolean

hasProvider

hasProvider(token: string | symbol | Type<any>): boolean

- Defined in core/injector/module.ts:377
Parameters
- token: string | symbol | Type<any>
Returns boolean

isCustomClass

isCustomClass(provider: any): boolean

- Defined in core/injector/module.ts:232
Parameters
- provider: any
Returns boolean

isCustomFactory

isCustomFactory(provider: any): boolean

- Defined in core/injector/module.ts:240
Parameters
- provider: any
Returns boolean

isCustomProvider

isCustomProvider(provider: ProviderMetatype): boolean

- Defined in core/injector/module.ts:207
Parameters
- provider: ProviderMetatype
Returns boolean

isCustomValue

isCustomValue(provider: any): boolean

- Defined in core/injector/module.ts:236
Parameters
- provider: any
Returns boolean

isDynamicModule

isDynamicModule(exported: any): boolean

- Defined in core/injector/module.ts:244
Parameters
- exported: any
Returns boolean

replace

replace(toReplace: string | symbol | Type<any>, options: any): string

- Defined in core/injector/module.ts:366
Parameters
- toReplace: string | symbol | Type<any>
- options: any
Returns string

validateExportedProvider

validateExportedProvider(token: string | symbol): string | symbol

- Defined in core/injector/module.ts:330
Parameters
- token: string | symbol
Returns string | symbol

Generated using TypeDoc