UNPKG

@nestjs/common/decorators/core/optional.decorator.d.ts

Version:

428 BTypeScriptView Raw

1/**
* Parameter decorator for an injected dependency marking the
* dependency as optional.
*
* For example:
* ```typescript
* constructor(@Optional() @Inject('HTTP_OPTIONS')private readonly httpClient: T) {}
* ```
*
* @see [Optional providers](https://docs.nestjs.com/providers#optional-providers)
*
* @publicApi
*/
14export declare function Optional(): (target: object, key: string | symbol, index?: number) => void;

1	`/**`
2	`* Parameter decorator for an injected dependency marking the`
3	`* dependency as optional.`
4	`*`
5	`* For example:`
6	* ```typescript
7	`* constructor(@Optional() @Inject('HTTP_OPTIONS')private readonly httpClient: T) {}`
8	* ```
9	`*`
10	`* @see [Optional providers](https://docs.nestjs.com/providers#optional-providers)`
11	`*`
12	`* @publicApi`
13	`*/`
14	`export declare function Optional(): (target: object, key: string \| symbol, index?: number) => void;`