tsoa-next / tsoa-next / TsoaRoute / ParameterSchema

Interface: ParameterSchema

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:72

Runtime schema for a route parameter.

Extends

• PropertySchema

Properties

additionalProperties?

optional additionalProperties?: boolean | PropertySchema;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:67

Inherited from

PropertySchema.additionalProperties

---

array?

optional array?: PropertySchema;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:61

Inherited from

PropertySchema.array

---

dataType?

optional dataType?: TypeStringLiteral;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:56

Inherited from

PropertySchema.dataType

---

default?

optional default?: unknown;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:66

Inherited from

PropertySchema.default

---

enums?

optional enums?: (string | number | boolean | null)[];

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:62

Inherited from

PropertySchema.enums

---

externalValidator?

optional externalValidator?: ExternalValidatorDescriptor;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:60

Inherited from

PropertySchema.externalValidator

---

in

in: string;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:75

---

name

name: string;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:74

---

nestedProperties?

optional nestedProperties?: object;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:68

Index Signature

[name: string]: PropertySchema

Inherited from

PropertySchema.nestedProperties

---

parameterIndex?

optional parameterIndex?: number;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:73

---

ref?

optional ref?: string;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:57

Inherited from

PropertySchema.ref

---

required?

optional required?: boolean;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:58

Inherited from

PropertySchema.required

---

subSchemas?

optional subSchemas?: PropertySchema[];

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:64

Inherited from

PropertySchema.subSchemas

---

type?

optional type?: PropertySchema;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:63

Inherited from

PropertySchema.type

---

validationStrategy?

optional validationStrategy?: ValidationStrategy;

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:59

Inherited from

PropertySchema.validationStrategy

---

validators?

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

Defined in: packages/runtime/src/routeGeneration/tsoa-route.ts:65

Inherited from

PropertySchema.validators