Class ExtensionContainer

An extension container.

Hierarchy

ExtensionContainer

Implements

IExtensionContainer

Index

Constructors

constructor

new ExtensionContainer(options?: ExtensionExecutorOptions): ExtensionContainer
Creates an extension container.
Parameters
- Optional options: ExtensionExecutorOptions
  
  Options for an object that performs extensions of the specified type IExtensionExecutor.
Returns ExtensionContainer
- Defined in @tessa/application/src/extensions/extensionContainer.ts:30

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:61

Methods

dispose

dispose(): void
Releases all related objects.

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

initialize

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

registerExtension

registerExtension<E>(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>>[];
}): ExtensionContainer
Registers a specific extension in the container.

Returns
The current extension container.
Type Parameters
- E extends Extension<ExtensionContext, E>
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)
    - new (...params: unknown[]): E
      
      Parameters
      
      Rest ...params: unknown[]
      
      Returns E
  - Optional extensionName?: string
  - Optional extensionType?: string
  - Optional order?: number
  - Optional singleton?: boolean
  - Optional stage?: ExtensionStage
  - Optional when?: ExtensionRegisterPredicate<E, ExtractExtensionContext<E>> | ExtensionRegisterPredicate<E, ExtractExtensionContext<E>>[]
Returns ExtensionContainer
Implementation of IExtensionContainer.registerExtension
- Defined in @tessa/application/src/extensions/extensionContainer.ts:103

resolveExecutor

resolveExecutor<E>(extension: string | (new (...params: unknown[]) => 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.

Returns
An object that performs extensions of the specified type.
Type Parameters
- E extends Extension<ExtensionContext, E>
Parameters
- extension: string | (new (...params: unknown[]) => E)
  
  The type of extension to return the object for.
- options: null | ExtensionExecutorOptions = null
  
  Additional options for the returned object.
Returns IExtensionExecutor<E>
Implementation of IExtensionContainer.resolveExecutor
- Defined in @tessa/application/src/extensions/extensionContainer.ts:186

Class ExtensionContainer

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Optional options: ExtensionExecutorOptions

Returns ExtensionContainer

Accessors

isInitialized

Returns boolean

Methods

dispose

Returns void

initialize

Parameters

context: { diContainer: DiContainer; }

diContainer: DiContainer

Returns Promise<void>

registerExtension

Returns

Type Parameters

E extends Extension<ExtensionContext, E>

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>>[]; }

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

Parameters

Rest ...params: unknown[]

Returns E

Optional extensionName?: string

Optional extensionType?: string

Optional order?: number

Optional singleton?: boolean

Optional stage?: ExtensionStage

Optional when?: ExtensionRegisterPredicate<E, ExtractExtensionContext<E>> | ExtensionRegisterPredicate<E, ExtractExtensionContext<E>>[]

Returns ExtensionContainer

resolveExecutor

Returns

Type Parameters

E extends Extension<ExtensionContext, E>

Parameters

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

options: null | ExtensionExecutorOptions = null

Returns IExtensionExecutor<E>

`Optional` options: ExtensionExecutorOptions

context: {
diContainer: DiContainer;
}

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>>[];
}

`Rest` ...params: unknown[]

`Optional` extensionName?: string

`Optional` extensionType?: string

`Optional` order?: number

`Optional` singleton?: boolean

`Optional` stage?: ExtensionStage

`Optional` when?: ExtensionRegisterPredicate<E, ExtractExtensionContext<E>> | ExtensionRegisterPredicate<E, ExtractExtensionContext<E>>[]