ParamMetadata Class

Module
import { ParamMetadata } from "@tsed/common"
Source/packages/common/src/filters/class/ParamMetadata.ts

Overview

class ParamMetadata extends Storable implements IParamOptions<;any>; {
    protected _expression: string | RegExp;
    protected _useConverter: boolean;
    protected _service: string | Type<;any>; | symbol;
    protected _required: boolean;
    expression: string | RegExp;
    service: Type<;any>; | symbol;
    useConverter: boolean;
    useValidation: boolean;
    required: boolean;
    allowedRequiredValues: any[];
    paramType: ParamTypes;
    isValidRequiredValue(value: any): boolean;
    isRequired(value: any): boolean;
    toJSON(): {
        service: string;
        name: string;
        expression: string | RegExp;
        required: boolean;
        use: string;
        baseType: string;
    };
}

Members

protected _expression: string | RegExp
protected _useConverter: boolean
protected _service: string | Type<;any>; | symbol
protected _required: boolean

Required entity.

expression: string | RegExp
service: Type<;any>; | symbol
useConverter: boolean
useValidation: boolean
required: boolean

Change the state of the required data.

allowedRequiredValues: any[]

Set the allowed values when the value is required.

paramType: ParamTypes
isValidRequiredValue(value: any): boolean

This method use EntityDescription.required and allowedRequiredValues to validate the value.

isRequired(value: any): boolean
toJSON(): {
     service: string;
     name: string;
     expression: string | RegExp;
     required: boolean;
     use: string;
     baseType: string;
 };