Class DynamicModuleDefinition

constructor

• new DynamicModuleDefinition(
      providerModule: ProviderModule,
  ): DynamicModuleDefinition

  Parameters

  • providerModule: ProviderModule

  Returns DynamicModuleDefinition

Readonlyevent$

ReadonlymoduleDef

moduleContainer

• get moduleContainer(): ModuleContainer

  Returns ModuleContainer

subscribe

• get subscribe(): (
      callback: SignalCallback<DefinitionEvent>,
      invokeImmediately?: boolean,
  ) => () => void

  Can be used to subscribe in real-time to the definition changes.

  Returns (
      callback: SignalCallback<DefinitionEvent>,
      invokeImmediately?: boolean,
  ) => () => void

  • • (
          callback: SignalCallback<DefinitionEvent>,
          invokeImmediately?: boolean,
      ): () => void

    • Can be used to subscribe to the emitted values of this Signal.

      Parameters

      • callback: SignalCallback<DefinitionEvent>

        The callback which will be invoked when a new value is emitted.
      • OptionalinvokeImmediately: boolean

        When set to true it'll invoke the provided callback immediately with the latest value available. (defaults to false)

      Returns () => void

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.
  • addToExports: boolean = false

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

  Returns void

addImportLazy

• addImportLazy(
      lazyCb: AsyncMethod<ProviderModule>,
      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<ProviderModule>

    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.
  • addToExports: boolean = false

    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>

dispose

• dispose(): void

  Returns void

emitEventSafely

• emitEventSafely(event: DefinitionEvent): void

  Parameters

  • event: DefinitionEvent

  Returns void

getImportedModuleById

• getImportedModuleById(id: ModuleIdentifier): undefined | ProviderModule

  Parameters

  • id: ModuleIdentifier

  Returns undefined | ProviderModule

getProviderByIdentifier

• getProviderByIdentifier<T>(
      identifier: ProviderIdentifier<T>,
  ): undefined | DependencyProvider<T>

  Type Parameters

  • T

  Parameters

  • identifier: ProviderIdentifier<T>

  Returns undefined | DependencyProvider<T>

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