UseOpts

@tsed/di

Usage

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

See /packages/di/src/common/decorators/useOpts.ts.

Overview

function UseOpts(options: {
    [key: string]: any;
}): Function;

Description

Pass custom options to an injected provider.

Supplies configuration options when injecting a provider that accepts @Opts. Works with constructor parameters and property injection.

Usage

import {Injectable, Opts, UseOpts} from "@tsed/di";

@Injectable()
class MyConfigurableService {
  source: string;

  constructor(@Opts options: any = {}) {
    this.source = options.source;
  }
}

@Injectable()
class MyService1 {
  // Constructor parameter with options
  constructor(@UseOpts({source: 'Service1'}) service: MyConfigurableService) {
    console.log(service.source); // "Service1"
  }
}

@Injectable()
class MyService2 {
  // Property injection with options
  @Inject(MyConfigurableService)
  @UseOpts({source: 'Service2'})
  service: MyConfigurableService;
}

Warning

The injected provider must use @Opts to receive these options. Using @Opts automatically sets the provider scope to INSTANCE.

[key: string]

[key: string]: any;