tsoa-next / @tsoa-next/runtime / ValidationService

Clase: Servicio de validación

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:101

Motor de validación utilizado por los manipuladores de ruta generados.

Constructores

Constructor

new ValidationService(models, config): ValidationService;

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:104

Parámetros

models

Models

config

AdditionalProps

Devoluciones

ValidationService

Métodos

hasCorrectJsType()

hasCorrectJsType(
   value, 
   type, 
   isBodyParam): boolean;

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:482

Parámetros

value

unknown

type

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

isBodyParam

boolean

Devoluciones

boolean

---

validateArray()

Call Signature

validateArray(options): unknown[] | undefined;

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:709

Parámetros

options

ValidateArrayOptions

Devoluciones

unknown[] | undefined

Call Signature

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:713

Parámetros

args

...ValidateArrayTupleArgs

Devoluciones

unknown[] | undefined

Deprecated

Use la sobrecarga del objeto en su lugar.

---

validateBool()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:687

Parámetros

name

string

value

unknown

fieldErrors

FieldErrors

isBodyParam

boolean

validators?

BooleanValidator

parent?

string = ''

Devoluciones

boolean | undefined

---

validateBuffer()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:810

Parámetros

name

string

value

unknown

fieldErrors

FieldErrors

parent?

string = ''

Devoluciones

Buffer<ArrayBufferLike> | undefined

---

validateDate()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:630

Parámetros

name

string

value

unknown

fieldErrors

FieldErrors

isBodyParam

boolean

validators?

DateValidator

parent?

string = ''

Devoluciones

Date | undefined

---

validateDateTime()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:649

Parámetros

name

string

value

unknown

fieldErrors

FieldErrors

isBodyParam

boolean

validators?

DateTimeValidator

parent?

string = ''

Devoluciones

Date | undefined

---

validateEnum()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:607

Parámetros

name

string

value

unknown

fieldErrors

FieldErrors

members?

(string | number | boolean | null)[]

parent?

string = ''

Devoluciones

unknown

---

validateFloat()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:588

Parámetros

name

string

value

unknown

fieldErrors

FieldErrors

isBodyParam

boolean

validators?

FloatValidator

parent?

string = ''

Devoluciones

number | undefined

---

validateInt()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:569

Parámetros

name

string

value

unknown

fieldErrors

FieldErrors

isBodyParam

boolean

validators?

IntegerValidator

parent?

string = ''

Devoluciones

number | undefined

---

validateIntersection()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:868

Parámetros tipo

TValue

TValue

Parámetros

name

string

value

TValue

fieldErrors

FieldErrors

isBodyParam

boolean

subSchemas

| PropertySchema[] | undefined

parent?

string

metadata?

ParameterValidationMetadata

Devoluciones

TValue

---

validateModel()

validateModel<TValue>(input): TValue;

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:1060

Parámetros tipo

TValue

TValue

Parámetros

input

fieldErrors

FieldErrors

isBodyParam

boolean

metadata?

ParameterValidationMetadata

modelDefinition

ModelSchema

name

string

parent?

string

value

TValue

Devoluciones

TValue

---

validateNestedObjectLiteral()

Call Signature

validateNestedObjectLiteral(...args): unknown;

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:486

Parámetros

args

...[ValidateNestedObjectLiteralOptions]

Devoluciones

unknown

Call Signature

validateNestedObjectLiteral(...args): unknown;

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:490

Parámetros

args

...ValidateNestedObjectLiteralTupleArgs

Devoluciones

unknown

Deprecated

Use la sobrecarga del objeto en su lugar.

---

ValidateParam()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:118

Parámetros tipo

TValue

TValue

Parámetros

property

PropertySchema

rawValue

TValue

name

string | undefined

fieldErrors

FieldErrors

isBodyParam

boolean

parent?

string

metadata?

ParameterValidationMetadata

Devoluciones

TValue

---

validateString()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:668

Parámetros

name

string

value

unknown

fieldErrors

FieldErrors

validators?

StringValidator

parent?

string = ''

Devoluciones

string | undefined

---

validateUndefined()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:697

Parámetros

name

string

value

unknown

fieldErrors

FieldErrors

parent?

string = ''

Devoluciones

undefined

---

validateUnion()

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

Definido en: packages/runtime/src/routeGeneration/templateHelpers.ts:830

Parámetros tipo

TValue

TValue

Parámetros

name

string

value

TValue

fieldErrors

FieldErrors

isBodyParam

boolean

property

PropertySchema

parent?

string

metadata?

ParameterValidationMetadata

Devoluciones

TValue

Contributors

No contributors

Changelog

No recent changes