Interface IExtensionContainer

ReadonlyisInitialized

Readonlyparent

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.

    • diContainer: DiContainer

      DI container.

  Returns Promise<void>

registerExtension

• registerExtension<E extends Extension<ExtensionContext>>(
      params: {
          extension: new (...params: unknown[]) => E;
          extensionName?: string;
          extensionType?: string;
          order?: number;
          singleton?: boolean;
          stage?: ExtensionStage;
          when?:
              | ExtensionRegisterPredicate<E, ExtractExtensionContext<E>>
              | ExtensionRegisterPredicate<E, ExtractExtensionContext<E>>[];
      },
  ): this

  Registers a specific extension in the container.

  Type Parameters

  • E extends Extension<ExtensionContext>

  Parameters

  • params: {
        extension: new (...params: unknown[]) => E;
        extensionName?: string;
        extensionType?: string;
        order?: number;
        singleton?: boolean;
        stage?: ExtensionStage;
        when?:
            | ExtensionRegisterPredicate<E, ExtractExtensionContext<E>>
            | ExtensionRegisterPredicate<E, ExtractExtensionContext<E>>[];
    }

    Registration parameters.

    • extension: new (...params: unknown[]) => E

      The extension that needs to be registered in the container.

    • OptionalextensionName?: string

      Имя регистрируемого расширения.

    • OptionalextensionType?: string

      Тип регистрируемого расширения.

    • Optionalorder?: number

      The order of execution, taking into account the type of extension and the stage of execution.

    • Optionalsingleton?: boolean

      A flag indicating the lifetime of an instance of extensions.

    • Optionalstage?: ExtensionStage

      The stage of the extension execution in the extension chain.

    • Optionalwhen?:
          | ExtensionRegisterPredicate<E, ExtractExtensionContext<E>>
          | ExtensionRegisterPredicate<E, ExtractExtensionContext<E>>[]

      Function or array of functions that accept the context of extension execution and allowing extensions to be performed only under certain conditions. If `true', then the lifetime of the extension instance will coincide with the lifetime of the container.

  Returns this

  The current extension container.

resolveExecutor

• resolveExecutor<E extends Extension<ExtensionContext>>(
      extension: string | AbstractNewable<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 | AbstractNewable<E>

    The type of extension to return the object for.
  • Optionaloptions: null | ExtensionExecutorOptions

    Additional options for the returned object.

  Returns IExtensionExecutor<E>

  An object that performs extensions of the specified type.