tsoa-next / tsoa-next / ValidationService

Class: ValidationService

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:101

Validation engine used by generated route handlers.

Constructors

Constructor

new ValidationService(models, config): ValidationService;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:104

Parameters

models

Models

config

AdditionalProps

Returns

ValidationService

Methods

hasCorrectJsType()

hasCorrectJsType(
   value, 
   type, 
   isBodyParam): boolean;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:482

Parameters

value

unknown

type

"string" | "number" | "boolean" | "object"

isBodyParam

boolean

Returns

boolean

---

validateArray()

Call Signature

validateArray(options): unknown[] | undefined;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:709

Parameters

options

ValidateArrayOptions

Returns

unknown[] | undefined

Call Signature

validateArray(...args): unknown[] | undefined;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:713

Parameters

args

...ValidateArrayTupleArgs

Returns

unknown[] | undefined

Deprecated

Use the object overload instead.

---

validateBool()

validateBool(
   name, 
   value, 
   fieldErrors, 
   isBodyParam, 
   validators?, 
   parent?): boolean | undefined;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:687

Parameters

name

string

value

unknown

fieldErrors

FieldErrors

isBodyParam

boolean

validators?

BooleanValidator

parent?

string

Returns

boolean | undefined

---

validateBuffer()

validateBuffer(
   name, 
   value, 
   fieldErrors, 
   parent?): Buffer<ArrayBufferLike> | undefined;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:810

Parameters

name

string

value

unknown

fieldErrors

FieldErrors

parent?

string

Returns

Buffer<ArrayBufferLike> | undefined

---

validateDate()

validateDate(
   name, 
   value, 
   fieldErrors, 
   isBodyParam, 
   validators?, 
   parent?): Date | undefined;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:630

Parameters

name

string

value

unknown

fieldErrors

FieldErrors

isBodyParam

boolean

validators?

DateValidator

parent?

string

Returns

Date | undefined

---

validateDateTime()

validateDateTime(
   name, 
   value, 
   fieldErrors, 
   isBodyParam, 
   validators?, 
   parent?): Date | undefined;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:649

Parameters

name

string

value

unknown

fieldErrors

FieldErrors

isBodyParam

boolean

validators?

DateTimeValidator

parent?

string

Returns

Date | undefined

---

validateEnum()

validateEnum(
   name, 
   value, 
   fieldErrors, 
   members?, 
   parent?): unknown;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:607

Parameters

name

string

value

unknown

fieldErrors

FieldErrors

members?

(string | number | boolean | null)[]

parent?

string

Returns

unknown

---

validateFloat()

validateFloat(
   name, 
   value, 
   fieldErrors, 
   isBodyParam, 
   validators?, 
   parent?): number | undefined;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:588

Parameters

name

string

value

unknown

fieldErrors

FieldErrors

isBodyParam

boolean

validators?

FloatValidator

parent?

string

Returns

number | undefined

---

validateInt()

validateInt(
   name, 
   value, 
   fieldErrors, 
   isBodyParam, 
   validators?, 
   parent?): number | undefined;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:569

Parameters

name

string

value

unknown

fieldErrors

FieldErrors

isBodyParam

boolean

validators?

IntegerValidator

parent?

string

Returns

number | undefined

---

validateIntersection()

validateIntersection<TValue>(
   name, 
   value, 
   fieldErrors, 
   isBodyParam, 
   subSchemas, 
   parent?, 
   metadata?): TValue;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:868

Type Parameters

TValue

TValue

Parameters

name

string

value

TValue

fieldErrors

FieldErrors

isBodyParam

boolean

subSchemas

| PropertySchema[] | undefined

parent?

string

metadata?

ParameterValidationMetadata

Returns

TValue

---

validateModel()

validateModel<TValue>(input): TValue;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:1060

Type Parameters

TValue

TValue

Parameters

input

fieldErrors

FieldErrors

isBodyParam

boolean

metadata?

ParameterValidationMetadata

modelDefinition

ModelSchema

name

string

parent?

string

value

TValue

Returns

TValue

---

validateNestedObjectLiteral()

Call Signature

validateNestedObjectLiteral(...args): unknown;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:486

Parameters

args

...[ValidateNestedObjectLiteralOptions]

Returns

unknown

Call Signature

validateNestedObjectLiteral(...args): unknown;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:490

Parameters

args

...ValidateNestedObjectLiteralTupleArgs

Returns

unknown

Deprecated

Use the object overload instead.

---

ValidateParam()

ValidateParam<TValue>(
   property, 
   rawValue, 
   name, 
   fieldErrors, 
   isBodyParam, 
   parent?, 
   metadata?): TValue;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:118

Type Parameters

TValue

TValue

Parameters

property

PropertySchema

rawValue

TValue

name

string | undefined

fieldErrors

FieldErrors

isBodyParam

boolean

parent?

string

metadata?

ParameterValidationMetadata

Returns

TValue

---

validateString()

validateString(
   name, 
   value, 
   fieldErrors, 
   validators?, 
   parent?): string | undefined;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:668

Parameters

name

string

value

unknown

fieldErrors

FieldErrors

validators?

StringValidator

parent?

string

Returns

string | undefined

---

validateUndefined()

validateUndefined(
   name, 
   value, 
   fieldErrors, 
   parent?): undefined;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:697

Parameters

name

string

value

unknown

fieldErrors

FieldErrors

parent?

string

Returns

undefined

---

validateUnion()

validateUnion<TValue>(
   name, 
   value, 
   fieldErrors, 
   isBodyParam, 
   property, 
   parent?, 
   metadata?): TValue;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:830

Type Parameters

TValue

TValue

Parameters

name

string

value

TValue

fieldErrors

FieldErrors

isBodyParam

boolean

property

PropertySchema

parent?

string

metadata?

ParameterValidationMetadata

Returns

TValue