@tsed/common
Version:
A TypeScript Framework on top of Express
21 lines (20 loc) • 782 B
TypeScript
import { IParamOptions } from "../../interfaces/IParamOptions";
import { ParamTypes } from "../../models/ParamTypes";
/**
* Register a new param. It use the paramType to extract value and give it to the next pipe.
*
* Given options allow to enable or disable following pipes:
*
* - useType: Add extra type for the json mapper,
* - expression: Get property from the returned value by the previous pipe.
* - useValidation: Apply validation from the returned value by the previous pipe.
* - useConverter: Apply json mapper from the returned value by the previous pipe.
*
* @param paramType
* @param options
* @decorator
* @operation
* @input
* @pipe
*/
export declare function UseParam(paramType: ParamTypes | string, options?: IParamOptions<any>): ParameterDecorator;