tsoa-next / tsoa-next / Tsoa / Parameter

Interface: Parameter

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

Extended by

• ResParameter
• ArrayParameter

Properties

$ref?

optional $ref?: BaseSchema<unknown>;

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

---

default?

optional default?: unknown;

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

---

deprecated

deprecated: boolean;

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

---

description?

optional description?: string;

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

---

example?

optional example?: Example[];

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

---

exampleLabels?

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

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

---

externalValidator?

optional externalValidator?: ExternalValidatorDescriptor;

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

---

in

in: 
  | "request"
  | "body"
  | "path"
  | "query"
  | "header"
  | "res"
  | "formData"
  | "queries"
  | "body-prop"
  | "request-prop";

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

---

name

name: string;

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

---

parameterIndex?

optional parameterIndex?: number;

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

---

parameterName

parameterName: string;

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

---

required?

optional required?: boolean;

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

---

title?

optional title?: string;

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

---

type

type: Type;

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

---

validationStrategy?

optional validationStrategy?: ValidationStrategy;

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

---

validators

validators: Validators;

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