Class ExtensionContainer

constructor

• new ExtensionContainer(
      options?: ExtensionExecutorOptions,
      parent?: null | IExtensionContainer,
  ): ExtensionContainer

  Creates an extension container.

  Parameters

  • Optionaloptions: ExtensionExecutorOptions

    Options for an object that performs extensions of the specified type IExtensionExecutor.

  • parent: null | IExtensionContainer = null

  Returns ExtensionContainer

ReadonlyonLazyChunkAdded

isInitialized

• get isInitialized(): boolean

  Indicates that the container has been initialized. Adding new extensions is not possible.

  Returns boolean

parent

• get parent(): null | IExtensionContainer

  Parent extension container.

  Returns null | IExtensionContainer

asLazy

• asLazy<M, T extends undefined | string | AbstractNewable = undefined>(
      chunkLoader: () => Promise<M>,
      extensionType?: T,
  ): IExtensionContainerAsync<M, T>

  Returns a lazy version of the container.

  Type Parameters

  • M
  • T extends undefined | string | AbstractNewable = undefined

  Parameters

  • chunkLoader: () => Promise<M>

    Chunk loading method.

  • OptionalextensionType: T

  Returns IExtensionContainerAsync<M, T>

createChild

• createChild(): IExtensionContainer

  Creates child extension container.

  Returns IExtensionContainer

dispose

• dispose(): void

  Releases all related objects.

  Returns void

getExtensions

• getExtensions<E extends Extension<ExtensionContext>>(
      extensionType: string,
  ): IExtensionInstance<E>[]

  Returns registered extensions list with specified type.

  Type Parameters

  • E extends Extension<ExtensionContext>

  Parameters

  • extensionType: string

    Type of extensions.

  Returns IExtensionInstance<E>[]

initialize

• initialize(context: { diContainer: DiContainer }): Promise<void>

  Initializes the extension container.

  Parameters

  • context: { diContainer: DiContainer }

    Initialization context.

  Returns Promise<void>

registerExtension

• registerExtension<E extends Extension<ExtensionContext>>(
      params: ExtensionContainerRegisterParams<E>,
  ): this

  Registers a specific extension in the container.

  Type Parameters

  • E extends Extension<ExtensionContext>

  Parameters

  • params: ExtensionContainerRegisterParams<E>

    Registration parameters.

  Returns this

  The current extension container.

resolveExecutor

• resolveExecutor<E extends Extension<ExtensionContext>>(
      extension: string | Newable<E>,
      options?: null | ExtensionExecutorOptions,
  ): IExtensionExecutor<E>

  Returns an object that performs extensions of the specified type. The method never returns `null'. If the extension type has not been registered in the container, then the method does not throw an exception, but returns an object that does not perform actions.

  Type Parameters

  • E extends Extension<ExtensionContext>

  Parameters

  • extension: string | Newable<E>

    The type of extension to return the object for.

  • options: null | ExtensionExecutorOptions = null

    Additional options for the returned object.

  Returns IExtensionExecutor<E>

  An object that performs extensions of the specified type.

resolveExecutorAsync

• resolveExecutorAsync<E extends Extension<ExtensionContext>>(
      extension: string | Newable<E>,
      options?: null | ExtensionExecutorOptions,
  ): Promise<IExtensionExecutor<E>>

  Returns an object that performs extensions of the specified type. The method never returns `null'. If the extension type has not been registered in the container, then the method does not throw an exception, but returns an object that does not perform actions.

  Type Parameters

  • E extends Extension<ExtensionContext>

  Parameters

  • extension: string | Newable<E>

    The type of extension to return the object for.

  • options: null | ExtensionExecutorOptions = null

    Additional options for the returned object.

  Returns Promise<IExtensionExecutor<E>>

  An object that performs extensions of the specified type.