Class Provider<T>

A named object that provides a value.

Type Parameters

T = unknown

Index

Constructors

Accessors

Methods

Constructors

constructor

new Provider<T = unknown>(
    name: string,
    factory: Factory<T>,
    tags?: string[],
    logger?: Logger,
): Provider<T>
Creates a new Provider.
Type Parameters
- T = unknown
Parameters
- name: string
  The name of the component.
- factory: Factory<T>
  A function that returns the component.
- tags: string[] = []
  An optional array of string tags for the component.
- logger: Logger = nullLogger
  The logger instance.
Returns Provider<T>

Accessors

name

get name(): string

Returns string
The component name.

tags

get tags(): Set<string>

Returns Set<string>
The tags for the component.

Methods

provide

provide(container: Container): Promise<T>
Instantiates the component.

If the factory function itself throws an Error or a rejected promise, this result is cached and the factory will not be invoked a second time.
Parameters
- container: Container
  The container object.
Returns Promise<T>
the component as produced by the factory function.