ProviderOpts

@tsed/di

Usage

import { ProviderOpts } from "@tsed/di";

See /packages/di/src/common/interfaces/ProviderOpts.ts.

Overview

interface ProviderOpts<T = any> {
    token: TokenProvider<T>;
    alias?: TokenProvider;
    type?: TokenProvider | ProviderType;
    instance?: T;
    deps?: TokenProvider[];
    useClass?: Type<T>;
    useFactory?: Function;
    useAsyncFactory?: Function;
    useValue?: any;
    scope?: ProviderScope;
    hooks?: Record<string, (instance: T, ...args: any[]) => Promise<any> | any>;
    [key: string]: any;
}

Description

Configuration options for registering a provider in the DI container.

Defines how a provider should be created, managed, and resolved by the injector. Supports multiple creation strategies including class instantiation, factory functions, and predefined values.

Usage

// Using a class
const opts1: ProviderOpts = {
  token: MyService,
  useClass: MyService
};

// Using a factory
const opts2: ProviderOpts = {
  token: "CONFIG",
  useFactory: () => loadConfig()
};

// Using a value
const opts3: ProviderOpts = {
  token: "API_KEY",
  useValue: "secret-key"
};

token

token: TokenProvider<T>;

An injection token. (Typically an instance of Type or InjectionToken, but can be any).

alias

alias?: TokenProvider;

Create alias token to retrieve the instance provider.

type

type?: TokenProvider | ProviderType;

Provider type

instance

instance?: T;

Instance build by the injector

deps

deps?: TokenProvider[];

Define dependencies to build the provider

useClass

useClass?: Type<T>;

Class to instantiate for the token.

useFactory

useFactory?: Function;

Provide a function to build the provider

useAsyncFactory

useAsyncFactory?: Function;

Provide an async function to build the provider

useValue

useValue?: any;

Provide predefined value

scope

scope?: ProviderScope;

Scope used by the injector to build the provider.

hooks: Record

hooks?: Record<string, (instance: T, ...args: any[]) => Promise<any> | any>;

hooks to intercept custom events

[key: string]

[key: string]: any;