Interface IExtensionContainer

An extension container.

interface IExtensionContainer {
    isInitialized: boolean;
    onLazyChunkAdded: EventHandler<{ chunkLoader: () => Promise<unknown> }>;
    parent: null | IExtensionContainer;
    asLazy<M, T extends undefined | string | AbstractNewable = undefined>(
        chunkLoader: () => Promise<M>,
        extensionType?: T,
    ): IExtensionContainerAsync<M, T>;
    createChild(): IExtensionContainer;
    dispose(): void;
    getExtensions<E extends Extension<ExtensionContext>>(
        extensionType: string,
    ): IExtensionInstance<E>[];
    initialize(context: { diContainer: DiContainer }): Promise<void>;
    registerExtension<E extends Extension<ExtensionContext>>(
        params: ExtensionContainerRegisterParams<E>,
    ): this;
    resolveExecutor<E extends Extension<ExtensionContext>>(
        extension: string | AbstractNewable<E>,
        options?: null | ExtensionExecutorOptions,
    ): IExtensionExecutor<E>;
    resolveExecutorAsync<E extends Extension<ExtensionContext>>(
        extension: string | AbstractNewable<E>,
        options?: null | ExtensionExecutorOptions,
    ): Promise<IExtensionExecutor<E>>;
}

Implemented by

ExtensionContainer

Index

Properties

isInitialized onLazyChunkAdded parent

Methods

asLazy createChild dispose getExtensions initialize registerExtension resolveExecutor resolveExecutorAsync

Properties

`Readonly`isInitialized

isInitialized: boolean

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

`Readonly`onLazyChunkAdded

onLazyChunkAdded: EventHandler<{ chunkLoader: () => Promise<unknown> }>

Invokes when a lazy chunk has been added to the container.

`Readonly`parent

parent: null | IExtensionContainer

Parent extension container.

Methods

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

createChild

createChild(): IExtensionContainer
Creates child extension container.

Returns IExtensionContainer
- Defined in @tessa/application/src/extensions/extensionTypes.ts:67

dispose

dispose(): void
Releases all related objects.

Returns void
- Defined in @tessa/application/src/extensions/extensionTypes.ts:33

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>[]
- Defined in @tessa/application/src/extensions/extensionTypes.ts:72

initialize

initialize(context: { diContainer: DiContainer }): Promise<void>
Initializes the extension container.
Parameters
- context: { diContainer: DiContainer }
  Initialization context.
  - diContainer: DiContainer
    DI container.
Returns Promise<void>
- Defined in @tessa/application/src/extensions/extensionTypes.ts:26

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

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

resolveExecutorAsync

resolveExecutorAsync<E extends Extension<ExtensionContext>>(
extension: string | AbstractNewable<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 | AbstractNewable<E>
  The type of extension to return the object for.
- Optionaloptions: null | ExtensionExecutorOptions
  Additional options for the returned object.
Returns Promise<IExtensionExecutor<E>>
An object that performs extensions of the specified type.
- Defined in @tessa/application/src/extensions/extensionTypes.ts:60