injectable

@tsed/di

Usage

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

See /packages/di/src/types/common/fn/injectable.ts.

Overview

const injectable: <Token extends import("../index.js").TokenProvider>(token: Token, options?: Partial<import("../index.js").ProviderOpts<import("@tsed/core").Type<any>>>) => {
    alias: (value: string) => any & {
        inspect(): Provider<any>;
        store(): import("@tsed/core").Store;
        token(): Token;
        factory(f: (...args: unknown[]) => unknown): any & any;
        asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
        value(v: unknown): any & any;
        class(c: import("@tsed/core").Type<any>): any & any;
    };
    type: (value: string | symbol | Function | import("@tsed/core").Type<any> | import("@tsed/core").AbstractType<any>) => any & {
        inspect(): Provider<any>;
        store(): import("@tsed/core").Store;
        token(): Token;
        factory(f: (...args: unknown[]) => unknown): any & any;
        asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
        value(v: unknown): any & any;
        class(c: import("@tsed/core").Type<any>): any & any;
    };
    deps: (value: import("../index.js").TokenProvider[]) => any & {
        inspect(): Provider<any>;
        store(): import("@tsed/core").Store;
        token(): Token;
        factory(f: (...args: unknown[]) => unknown): any & any;
        asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
        value(v: unknown): any & any;
        class(c: import("@tsed/core").Type<any>): any & any;
    };
    scope: (value: import("../index.js").ProviderScope) => any & {
        inspect(): Provider<any>;
        store(): import("@tsed/core").Store;
        token(): Token;
        factory(f: (...args: unknown[]) => unknown): any & any;
        asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
        value(v: unknown): any & any;
        class(c: import("@tsed/core").Type<any>): any & any;
    };
    hooks: (value: Record<string, import("../domain/Provider.js").ProviderHookCallback<any>>) => any & {
        inspect(): Provider<any>;
        store(): import("@tsed/core").Store;
        token(): Token;
        factory(f: (...args: unknown[]) => unknown): any & any;
        asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
        value(v: unknown): any & any;
        class(c: import("@tsed/core").Type<any>): any & any;
    };
    imports: (value: (import("../index.js").TokenProvider | [import("../index.js").TokenProvider])[]) => any & {
        inspect(): Provider<any>;
        store(): import("@tsed/core").Store;
        token(): Token;
        factory(f: (...args: unknown[]) => unknown): any & any;
        asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
        value(v: unknown): any & any;
        class(c: import("@tsed/core").Type<any>): any & any;
    };
    priority: (value: number) => any & {
        inspect(): Provider<any>;
        store(): import("@tsed/core").Store;
        token(): Token;
        factory(f: (...args: unknown[]) => unknown): any & any;
        asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
        value(v: unknown): any & any;
        class(c: import("@tsed/core").Type<any>): any & any;
    };
    path: (value: string) => any & {
        inspect(): Provider<any>;
        store(): import("@tsed/core").Store;
        token(): Token;
        factory(f: (...args: unknown[]) => unknown): any & any;
        asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
        value(v: unknown): any & any;
        class(c: import("@tsed/core").Type<any>): any & any;
    };
    configuration: (value: Partial<TsED.Configuration>) => any & {
        inspect(): Provider<any>;
        store(): import("@tsed/core").Store;
        token(): Token;
        factory(f: (...args: unknown[]) => unknown): any & any;
        asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
        value(v: unknown): any & any;
        class(c: import("@tsed/core").Type<any>): any & any;
    };
} & {
    inspect(): Provider<any>;
    store(): import("@tsed/core").Store;
    token(): Token;
    factory(f: (...args: unknown[]) => unknown): {
        alias: (value: string) => any & any;
        type: (value: string | symbol | Function | import("@tsed/core").Type<any> | import("@tsed/core").AbstractType<any>) => any & any;
        deps: (value: import("../index.js").TokenProvider[]) => any & any;
        scope: (value: import("../index.js").ProviderScope) => any & any;
        hooks: (value: Record<string, import("../domain/Provider.js").ProviderHookCallback<any>>) => any & any;
        imports: (value: (import("../index.js").TokenProvider | [import("../index.js").TokenProvider])[]) => any & any;
        priority: (value: number) => any & any;
        path: (value: string) => any & any;
        configuration: (value: Partial<TsED.Configuration>) => any & any;
    } & any;
    asyncFactory(f: (...args: unknown[]) => Promise<unknown>): {
        alias: (value: string) => any & any;
        type: (value: string | symbol | Function | import("@tsed/core").Type<any> | import("@tsed/core").AbstractType<any>) => any & any;
        deps: (value: import("../index.js").TokenProvider[]) => any & any;
        scope: (value: import("../index.js").ProviderScope) => any & any;
        hooks: (value: Record<string, import("../domain/Provider.js").ProviderHookCallback<any>>) => any & any;
        imports: (value: (import("../index.js").TokenProvider | [import("../index.js").TokenProvider])[]) => any & any;
        priority: (value: number) => any & any;
        path: (value: string) => any & any;
        configuration: (value: Partial<TsED.Configuration>) => any & any;
    } & any;
    value(v: unknown): {
        alias: (value: string) => any & any;
        type: (value: string | symbol | Function | import("@tsed/core").Type<any> | import("@tsed/core").AbstractType<any>) => any & any;
        deps: (value: import("../index.js").TokenProvider[]) => any & any;
        scope: (value: import("../index.js").ProviderScope) => any & any;
        hooks: (value: Record<string, import("../domain/Provider.js").ProviderHookCallback<any>>) => any & any;
        imports: (value: (import("../index.js").TokenProvider | [import("../index.js").TokenProvider])[]) => any & any;
        priority: (value: number) => any & any;
        path: (value: string) => any & any;
        configuration: (value: Partial<TsED.Configuration>) => any & any;
    } & any;
    class(c: import("@tsed/core").Type<any>): {
        alias: (value: string) => any & any;
        type: (value: string | symbol | Function | import("@tsed/core").Type<any> | import("@tsed/core").AbstractType<any>) => any & any;
        deps: (value: import("../index.js").TokenProvider[]) => any & any;
        scope: (value: import("../index.js").ProviderScope) => any & any;
        hooks: (value: Record<string, import("../domain/Provider.js").ProviderHookCallback<any>>) => any & any;
        imports: (value: (import("../index.js").TokenProvider | [import("../index.js").TokenProvider])[]) => any & any;
        priority: (value: number) => any & any;
        path: (value: string) => any & any;
        configuration: (value: Partial<TsED.Configuration>) => any & any;
    } & any;
};

alias:

alias: (value: string) => any & {
     inspect(): Provider<any>;
     store(): import("@tsed/core").Store;
     token(): Token;
     factory(f: (...args: unknown[]) => unknown): any & any;
     asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
     value(v: unknown): any & any;
     class(c: import("@tsed/core").Type<any>): any & any;
 };

type:

type: (value: string | symbol | Function | import("@tsed/core").Type<any> | import("@tsed/core").AbstractType<any>) => any & {
     inspect(): Provider<any>;
     store(): import("@tsed/core").Store;
     token(): Token;
     factory(f: (...args: unknown[]) => unknown): any & any;
     asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
     value(v: unknown): any & any;
     class(c: import("@tsed/core").Type<any>): any & any;
 };

deps:

deps: (value: import("../index.js").TokenProvider[]) => any & {
     inspect(): Provider<any>;
     store(): import("@tsed/core").Store;
     token(): Token;
     factory(f: (...args: unknown[]) => unknown): any & any;
     asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
     value(v: unknown): any & any;
     class(c: import("@tsed/core").Type<any>): any & any;
 };

scope:

scope: (value: import("../index.js").ProviderScope) => any & {
     inspect(): Provider<any>;
     store(): import("@tsed/core").Store;
     token(): Token;
     factory(f: (...args: unknown[]) => unknown): any & any;
     asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
     value(v: unknown): any & any;
     class(c: import("@tsed/core").Type<any>): any & any;
 };

hooks:

hooks: (value: Record<string, import("../domain/Provider.js").ProviderHookCallback<any>>) => any & {
     inspect(): Provider<any>;
     store(): import("@tsed/core").Store;
     token(): Token;
     factory(f: (...args: unknown[]) => unknown): any & any;
     asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
     value(v: unknown): any & any;
     class(c: import("@tsed/core").Type<any>): any & any;
 };

imports:

imports: (value: (import("../index.js").TokenProvider | [import("../index.js").TokenProvider])[]) => any & {
     inspect(): Provider<any>;
     store(): import("@tsed/core").Store;
     token(): Token;
     factory(f: (...args: unknown[]) => unknown): any & any;
     asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
     value(v: unknown): any & any;
     class(c: import("@tsed/core").Type<any>): any & any;
 };

priority:

priority: (value: number) => any & {
     inspect(): Provider<any>;
     store(): import("@tsed/core").Store;
     token(): Token;
     factory(f: (...args: unknown[]) => unknown): any & any;
     asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
     value(v: unknown): any & any;
     class(c: import("@tsed/core").Type<any>): any & any;
 };

path:

path: (value: string) => any & {
     inspect(): Provider<any>;
     store(): import("@tsed/core").Store;
     token(): Token;
     factory(f: (...args: unknown[]) => unknown): any & any;
     asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
     value(v: unknown): any & any;
     class(c: import("@tsed/core").Type<any>): any & any;
 };

configuration:

configuration: (value: Partial<TsED.Configuration>) => any & {
     inspect(): Provider<any>;
     store(): import("@tsed/core").Store;
     token(): Token;
     factory(f: (...args: unknown[]) => unknown): any & any;
     asyncFactory(f: (...args: unknown[]) => Promise<unknown>): any & any;
     value(v: unknown): any & any;
     class(c: import("@tsed/core").Type<any>): any & any;
 };

} & {

inspect

inspect(): Provider<any>;

store

store(): import("@tsed/core").Store;

token

token(): Token;

factory

factory(f: (...args: unknown[]) => unknown): {
     alias: (value: string) => any & any;
     type: (value: string | symbol | Function | import("@tsed/core").Type<any> | import("@tsed/core").AbstractType<any>) => any & any;
     deps: (value: import("../index.js").TokenProvider[]) => any & any;
     scope: (value: import("../index.js").ProviderScope) => any & any;
     hooks: (value: Record<string, import("../domain/Provider.js").ProviderHookCallback<any>>) => any & any;
     imports: (value: (import("../index.js").TokenProvider | [import("../index.js").TokenProvider])[]) => any & any;
     priority: (value: number) => any & any;
     path: (value: string) => any & any;
     configuration: (value: Partial<TsED.Configuration>) => any & any;
 } & any;

asyncFactory

asyncFactory(f: (...args: unknown[]) => Promise<unknown>): {
     alias: (value: string) => any & any;
     type: (value: string | symbol | Function | import("@tsed/core").Type<any> | import("@tsed/core").AbstractType<any>) => any & any;
     deps: (value: import("../index.js").TokenProvider[]) => any & any;
     scope: (value: import("../index.js").ProviderScope) => any & any;
     hooks: (value: Record<string, import("../domain/Provider.js").ProviderHookCallback<any>>) => any & any;
     imports: (value: (import("../index.js").TokenProvider | [import("../index.js").TokenProvider])[]) => any & any;
     priority: (value: number) => any & any;
     path: (value: string) => any & any;
     configuration: (value: Partial<TsED.Configuration>) => any & any;
 } & any;

value

value(v: unknown): {
     alias: (value: string) => any & any;
     type: (value: string | symbol | Function | import("@tsed/core").Type<any> | import("@tsed/core").AbstractType<any>) => any & any;
     deps: (value: import("../index.js").TokenProvider[]) => any & any;
     scope: (value: import("../index.js").ProviderScope) => any & any;
     hooks: (value: Record<string, import("../domain/Provider.js").ProviderHookCallback<any>>) => any & any;
     imports: (value: (import("../index.js").TokenProvider | [import("../index.js").TokenProvider])[]) => any & any;
     priority: (value: number) => any & any;
     path: (value: string) => any & any;
     configuration: (value: Partial<TsED.Configuration>) => any & any;
 } & any;

class

class(c: import("@tsed/core").Type<any>): {
     alias: (value: string) => any & any;
     type: (value: string | symbol | Function | import("@tsed/core").Type<any> | import("@tsed/core").AbstractType<any>) => any & any;
     deps: (value: import("../index.js").TokenProvider[]) => any & any;
     scope: (value: import("../index.js").ProviderScope) => any & any;
     hooks: (value: Record<string, import("../domain/Provider.js").ProviderHookCallback<any>>) => any & any;
     imports: (value: (import("../index.js").TokenProvider | [import("../index.js").TokenProvider])[]) => any & any;
     priority: (value: number) => any & any;
     path: (value: string) => any & any;
     configuration: (value: Partial<TsED.Configuration>) => any & any;
 } & any;