Interface IDynamicModuleDefinition

Readonlysubscribe

addImport

• addImport(moduleOrBlueprint: ModuleOrBlueprint, addToExports?: boolean): void

  Can be used to import a new moduleOrBlueprint into the current Module.

  Parameters

  • moduleOrBlueprint: ModuleOrBlueprint

    Either the Module or the ModuleBlueprint to be imported.
  • OptionaladdToExports: boolean

    When set to true it'll also export the moduleOrBlueprint. (defaults to false)

  Returns void

addImportLazy

• addImportLazy(
      lazyCb: AsyncMethod<IProviderModule>,
      addToExports?: boolean,
  ): Promise<void>

  Can be used to lazily import a new module into the current Module.

  Note: This is useful when you want to lazy import a module from within another file.

  addImportLazy(async () => import('./lazy.module'));
  Copy

  Parameters

  • lazyCb: AsyncMethod<IProviderModule>

    An async callback which will resolve the Module to be imported.
  • OptionaladdToExports: boolean

    When set to true it'll also export the module. (defaults to false)

  Returns Promise<void>

addProvider

• addProvider<T>(provider: DependencyProvider<T>, addToExports?: boolean): void

  Can be used to bind a new provider to the Module's container.

  Type Parameters

  • T

  Parameters

  • provider: DependencyProvider<T>

    The Provider to add.
  • OptionaladdToExports: boolean

    When set to true it'll also export the module. (defaults to false)

  Returns void

addProviderLazy

• addProviderLazy<T>(
      lazyCb: AsyncMethod<DependencyProvider<T>>,
      addToExports?: boolean,
  ): Promise<void>

  Can be used to lazily bind a new provider to the Module's container.

  Note: This is useful when you want to lazy import a provider from within another file.

  addImportLazy(async () => import('./lazy.provider'));
  Copy

  Type Parameters

  • T

  Parameters

  • lazyCb: AsyncMethod<DependencyProvider<T>>

    An async callback which will resolve the Provider to add.
  • OptionaladdToExports: boolean

    When set to true it'll also export the module. (defaults to false)

  Returns Promise<void>

removeFromExports

• removeFromExports(exportDefinition: ExportDefinition): boolean

  Can be used to remove a Module or Provider from the exports definition of this module.

  Note: Consumers which already consumed the exportDefinition may still old a reference onto it.

  Parameters

  • exportDefinition: ExportDefinition

    The ExportDefinition to be removed.

  Returns boolean

removeImport

• removeImport(moduleOrId: IProviderModule | ModuleIdentifier): boolean

  Can be used to remove an import from the current Module. It'll also automatically remove it from the exports definition.

  Note: You can always add it back with the addImport or addImportLazy methods.

  Parameters

  • moduleOrId: IProviderModule | ModuleIdentifier

    Either the module reference itself or its id.

  Returns boolean

removeProvider

• removeProvider<T>(
      providerOrIdentifier:
          | string
          | symbol
          | Function
          | Class<T>
          | ProviderClassToken<T>
          | ProviderValueToken<T>
          | ProviderFactoryToken<T>,
  ): boolean

  Can be used to remove a provider from the current Module's container. It'll also automatically remove it from the exports definition.

  Note: You can always add it back with the addProvider or addProviderLazy methods.

  Type Parameters

  • T

  Parameters

  • providerOrIdentifier:
        | string
        | symbol
        | Function
        | Class<T>
        | ProviderClassToken<T>
        | ProviderValueToken<T>
        | ProviderFactoryToken<T>

    Either the provider reference itself or its { provide } property value.

  Returns boolean