tsoa-next / @tsoa-next/runtime / Tsoa / ResParameter

Interface: ResParameter

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:93

Extends

• Parameter

Properties

$ref?

optional $ref?: BaseSchema<unknown>;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:90

Inherited from

Parameter.$ref

---

default?

optional default?: unknown;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:83

Inherited from

Parameter.default

---

deprecated

deprecated: boolean;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:87

Inherited from

Parameter.deprecated

---

description

description: string;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:95

Overrides

Parameter.description

---

example?

optional example?: Example[];

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:77

Inherited from

Parameter.example

---

exampleLabels?

optional exampleLabels?: (string | undefined)[];

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:99

Overrides

Parameter.exampleLabels

---

examples?

optional examples?: Example[];

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:98

---

externalValidator?

optional externalValidator?: ExternalValidatorDescriptor;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:86

Inherited from

Parameter.externalValidator

---

headers?

optional headers?: HeaderType;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:100

---

in

in: "res";

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:94

Overrides

Parameter.in

---

name

name: string;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:80

Inherited from

Parameter.name

---

parameterIndex?

optional parameterIndex?: number;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:75

Inherited from

Parameter.parameterIndex

---

parameterName

parameterName: string;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:76

Inherited from

Parameter.parameterName

---

produces?

optional produces?: string[];

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:96

---

required?

optional required?: boolean;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:81

Inherited from

Parameter.required

---

schema?

optional schema?: Type;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:97

---

title?

optional title?: string;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:89

Inherited from

Parameter.title

---

type

type: Type;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:82

Inherited from

Parameter.type

---

validationStrategy?

optional validationStrategy?: ValidationStrategy;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:85

Inherited from

Parameter.validationStrategy

---

validators

validators: Validators;

Defined in: packages/runtime/src/metadataGeneration/tsoa.ts:84

Inherited from

Parameter.validators