tsoa-next / tsoa-next / TsoaRoute / PropertySchema

Interface: PropertySchema

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

Schema fragment used to validate a single property or nested value at runtime.

Extended by

• ParameterSchema

Properties

additionalProperties?

optional additionalProperties?: boolean | PropertySchema;

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

---

array?

optional array?: PropertySchema;

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

---

dataType?

optional dataType?: TypeStringLiteral;

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

---

default?

optional default?: unknown;

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

---

enums?

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

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

---

externalValidator?

optional externalValidator?: ExternalValidatorDescriptor;

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

---

nestedProperties?

optional nestedProperties?: object;

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

Index Signature

[name: string]: PropertySchema

---

ref?

optional ref?: string;

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

---

required?

optional required?: boolean;

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

---

subSchemas?

optional subSchemas?: PropertySchema[];

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

---

type?

optional type?: PropertySchema;

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

---

validationStrategy?

optional validationStrategy?: ValidationStrategy;

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

---

validators?

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

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