Class ExtensionContainer

An extension container.

Implements

IExtensionContainer

Index

Constructors

Accessors

isInitialized parent

Methods

createChild dispose getExtensions initialize registerExtension resolveExecutor

Constructors

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
- Defined in @tessa/application/src/extensions/extensionContainer.ts:31

Accessors

isInitialized

get isInitialized(): boolean
Indicates that the container has been initialized. Adding new extensions is not possible.

Returns boolean
Implementation of IExtensionContainer.isInitialized
- Defined in @tessa/application/src/extensions/extensionContainer.ts:69

parent

get parent(): null | IExtensionContainer
Parent extension container.

Returns null | IExtensionContainer
Implementation of IExtensionContainer.parent
- Defined in @tessa/application/src/extensions/extensionContainer.ts:73

Methods

createChild

createChild(): IExtensionContainer
Creates child extension container.

Returns IExtensionContainer
Implementation of IExtensionContainer.createChild
- Defined in @tessa/application/src/extensions/extensionContainer.ts:241

dispose

dispose(): void
Releases all related objects.

Returns void
Implementation of IExtensionContainer.dispose
- Defined in @tessa/application/src/extensions/extensionContainer.ts:101

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>[]
Implementation of IExtensionContainer.getExtensions
- Defined in @tessa/application/src/extensions/extensionContainer.ts:245

initialize

initialize(context: { diContainer: DiContainer }): Promise<void>
Initializes the extension container.
Parameters
- context: { diContainer: DiContainer }
  Initialization context.
Returns Promise<void>
Implementation of IExtensionContainer.initialize
- Defined in @tessa/application/src/extensions/extensionContainer.ts:81

registerExtension

registerExtension<E extends Extension<ExtensionContext>>(
    params: {
        extension: Newable<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: Newable<E>;
      extensionName?: string;
      extensionType?: string;
      order?: number;
      singleton?: boolean;
      stage?: ExtensionStage;
      when?:
          | ExtensionRegisterPredicate<E, ExtractExtensionContext<E>>
          | ExtensionRegisterPredicate<E, ExtractExtensionContext<E>>[];
  }
  Registration parameters.
Returns this
The current extension container.
Implementation of IExtensionContainer.registerExtension
- Defined in @tessa/application/src/extensions/extensionContainer.ts:113

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.
Implementation of IExtensionContainer.resolveExecutor
- Defined in @tessa/application/src/extensions/extensionContainer.ts:198