ProviderBuilder

@tsed/di

Usage

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

See /packages/di/src/common/domain/ProviderBuilder.ts.

Overview

class ProviderBuilder<Token> {
    protected provider: Provider<Token>;
    constructor(options: ProviderOpts<Token>);
    static add<Keys extends keyof ClassProviderBuilder, Token extends Type>(property: Keys, method: (this: ClassProviderBuilder<Token>, ...args: Parameters<ClassProviderBuilder<Token>[Keys]>) => ReturnType<ClassProviderBuilder<Token>[Keys]>): typeof ProviderBuilder;
    scope(scope: Provider["scope"]): ProviderBuilder<Token>;
    path(path: Provider["path"]): ProviderBuilder<Token>;
    alias(alias: Provider["alias"]): ProviderBuilder<Token>;
    hooks(hooks: Provider["hooks"]): ProviderBuilder<Token>;
    deps(deps: Provider["deps"]): ProviderBuilder<Token>;
    imports(imports: Provider["imports"]): ProviderBuilder<Token>;
    configuration(configuration: Provider["configuration"]): ProviderBuilder<Token>;
    priority(priority: Provider["priority"]): ProviderBuilder<Token>;
    type(type: Provider["type"]): ProviderBuilder<Token>;
    children(children: Provider["children"]): ProviderBuilder<Token>;
    middlewares(middlewares: Provider["middlewares"]): ProviderBuilder<Token>;
    factory<FactoryReturn>(factory: (...args: unknown[]) => FactoryReturn): ProviderBuilder<FactoryTokenProvider<FactoryReturn>>;
    asyncFactory<FactoryReturn>(asyncFactory: (...args: unknown[]) => Promise<FactoryReturn>): ProviderBuilder<FactoryTokenProvider<FactoryReturn>>;
    value<Value>(value: Value): ProviderBuilder<FactoryTokenProvider<Value>>;
    class<TokenKlass>(k: Type<TokenKlass>): ProviderBuilder<TokenKlass>;
    store(): Store;
    inspect(): Provider<Token>;
    token(): Token;
    set(key: string, value: unknown): ProviderBuilder<Token>;
}

Description

Sets a value in the provider's store

Constructor

constructor(options: ProviderOpts<Token>);

Creates a new Provider Builder instance

protected provider

protected provider: Provider<Token>;

static add

static add<Keys extends keyof ClassProviderBuilder, Token extends Type>(property: Keys, method: (this: ClassProviderBuilder<Token>, ...args: Parameters<ClassProviderBuilder<Token>[Keys]>) => ReturnType<ClassProviderBuilder<Token>[Keys]>): typeof ProviderBuilder;

scope

scope(scope: Provider["scope"]): ProviderBuilder<Token>;

• scope (Provider["scope"]): - The scope to set for this provider

Sets the provider scope

path

path(path: Provider["path"]): ProviderBuilder<Token>;

• path (Provider["path"]): - The path to set for this provider

Sets the provider path

alias

alias(alias: Provider["alias"]): ProviderBuilder<Token>;

• alias (Provider["alias"]): - The alias to set for this provider

Sets the provider alias

hooks

hooks(hooks: Provider["hooks"]): ProviderBuilder<Token>;

• hooks (Provider["hooks"]): - The hooks to set for this provider

Sets the provider hooks

deps

deps(deps: Provider["deps"]): ProviderBuilder<Token>;

• deps (Provider["deps"]): - The dependencies to set for this provider

Sets the provider dependencies

imports

imports(imports: Provider["imports"]): ProviderBuilder<Token>;

• imports (Provider["imports"]): - The imports to set for this provider

Sets the provider imports

configuration

configuration(configuration: Provider["configuration"]): ProviderBuilder<Token>;

• configuration (Provider["configuration"]): - The configuration to set for this provider

Sets the provider configuration

priority

priority(priority: Provider["priority"]): ProviderBuilder<Token>;

• priority (Provider["priority"]): - The priority to set for this provider

Sets the provider priority

type

type(type: Provider["type"]): ProviderBuilder<Token>;

• type (Provider["type"]): - The type to set for this provider

Sets the provider type

children

children(children: Provider["children"]): ProviderBuilder<Token>;

• children (Provider["children"]): - The children to set for this provider

Sets the provider children

middlewares

middlewares(middlewares: Provider["middlewares"]): ProviderBuilder<Token>;

• middlewares (Provider["middlewares"]): - The middlewares to set for this provider

Sets the provider middlewares

factory

factory<FactoryReturn>(factory: (...args: unknown[]) => FactoryReturn): ProviderBuilder<FactoryTokenProvider<FactoryReturn>>;

• factory ((...args: unknown[]) => FactoryReturn): - Factory function that creates provider instances

Sets a factory function for the provider

asyncFactory

asyncFactory<FactoryReturn>(asyncFactory: (...args: unknown[]) => Promise<FactoryReturn>): ProviderBuilder<FactoryTokenProvider<FactoryReturn>>;

• asyncFactory ((...args: unknown[]) => Promise<FactoryReturn>): - Async factory function that creates provider instances

Sets an async factory function for the provider

value

value<Value>(value: Value): ProviderBuilder<FactoryTokenProvider<Value>>;

• value (Value): - Value to be provided

Sets a static value for the provider

class

class<TokenKlass>(k: Type<TokenKlass>): ProviderBuilder<TokenKlass>;

• k (Type<TokenKlass>): - Class type to be provided

Sets the class to be used by the provider

store

store(): Store;

Gets the provider's store

inspect

inspect(): Provider<Token>;

Gets the underlying provider instance

token

token(): Token;

Gets the provider's token

set

set(key: string, value: unknown): ProviderBuilder<Token>;

• key (string): - Key to store the value under

• value (unknown): - Value to store

Sets a value in the provider's store