Interface Property

interface Property {
    default?: unknown;
    deprecated: boolean;
    description?: string;
    example?: unknown;
    extensions?: Tsoa.Extension[];
    format?: string;
    name: string;
    required: boolean;
    type: Tsoa.Type;
    validators: Partial<Record<Tsoa.ValidatorKey, {
        errorMsg?: string;
        value?: unknown;
    }>>;
}

Properties

default? deprecated description? example? extensions? format? name required type validators

Properties

Optional default

default?: unknown

deprecated

deprecated: boolean

Optional description

description?: string

Optional example

example?: unknown

Optional extensions

extensions?: Tsoa.Extension[]

Optional format

format?: string

name

name: string

required

required: boolean

type

type: Tsoa.Type

validators

validators: Partial<Record<Tsoa.ValidatorKey, {
    errorMsg?: string;
    value?: unknown;
}>>

Settings

Member Visibility

Theme

On This Page

defaultdeprecateddescriptionexampleextensionsformatnamerequiredtypevalidators

Generated using TypeDoc