Class Container

A simplistic asynchronous dependency injection container.

Hierarchy

EventTarget
- Container

Index

Constructors

Methods

addEventListener dispatchEvent get getAll getAllTagged getNames has removeEventListener

Constructors

constructor

new Container(
providers: Map<string, Provider<unknown>>,
logger?: Logger,
): Container
Create a new Container.
Parameters
- providers: Map<string, Provider<unknown>>
  A Map of providers by name.
- logger: Logger = nullLogger
  The logger instance, default: no logs
Returns Container
Overrides EventTarget.constructor

Methods

addEventListener

addEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: EventListenerOrEventListenerObject | null
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from EventTarget.addEventListener

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent

get

get<T = any>(name: string): Promise<T>
Gets a named component from the container.
Type Parameters
- T = any
Parameters
- name: string
  The component name.
Returns Promise<T>
A promise that resolves to the registered component

Throws
if no component is registered with the provided name.

getAll

getAll<T = any>(
names: ArrayLike<string> | Iterable<string, any, any>,
): Promise<T[]>
Gets multiple named components from the container.
Type Parameters
- T = any
Parameters
- names: ArrayLike<string> | Iterable<string, any, any>
  The component names.
Returns Promise<T[]>
A Promise that resolves to the registered components

Throws
if no component is registered with one of the provided names.

getAllTagged

getAllTagged<T = any>(tag: string): Promise<T[]>
Gets any components registered under a specific tag.
Type Parameters
- T = any
Parameters
- tag: string
  The tag.
Returns Promise<T[]>
A Promise that resolves to the tagged components.

getNames

getNames(): string[]
Gets the names of all registered components.

Returns string[]
The registered component names.

has

has(name: string): boolean
Checks if the container holds a named component.

If this method returns true, invoking get with the same parameter will not throw a RangeError.
Parameters
- name: string
  The component name.
Returns boolean
Whether the component exists in the container

removeEventListener

removeEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: EventListenerOrEventListenerObject | null
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from EventTarget.removeEventListener