Validator
Members
Section titled “Members”Properties
Section titled “Properties”| Property | Description |
|---|---|
| Clean | - |
| isAsync | - |
| mayReturnPromise | - |
Methods
Section titled “Methods”Defined in: elysia/dist/validator/index.d.ts:30
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Validator(): Validator;Returns
Section titled “Returns”Validator
Properties
Section titled “Properties”Clean: (value) => unknown;Defined in: elysia/dist/validator/index.d.ts:37
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | unknown |
Returns
Section titled “Returns”unknown
isAsync
Section titled “isAsync”isAsync: boolean;Defined in: elysia/dist/validator/index.d.ts:31
mayReturnPromise
Section titled “mayReturnPromise”mayReturnPromise: boolean;Defined in: elysia/dist/validator/index.d.ts:32
Methods
Section titled “Methods”Check()
Section titled “Check()”abstract Check(value): boolean;Defined in: elysia/dist/validator/index.d.ts:33
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | unknown |
Returns
Section titled “Returns”boolean
Errors()
Section titled “Errors()”abstract Errors(value): TLocalizedValidationError[];Defined in: elysia/dist/validator/index.d.ts:34
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | unknown |
Returns
Section titled “Returns”TLocalizedValidationError[]
From()?
Section titled “From()?”optional From( value, type?, allowAsync?): unknown;Defined in: elysia/dist/validator/index.d.ts:36
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | unknown |
type? | string |
allowAsync? | boolean |
Returns
Section titled “Returns”unknown
clear()
Section titled “clear()”static clear(): void;Defined in: elysia/dist/validator/index.d.ts:42
Returns
Section titled “Returns”void
create()
Section titled “create()”Call Signature
Section titled “Call Signature”static create<Schema>(schema, options?): TypeBoxValidator<Schema>;Defined in: elysia/dist/validator/index.d.ts:38
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Schema extends TSchema |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
schema | Schema |
options? | ValidatorOptions |
Returns
Section titled “Returns”TypeBoxValidator<Schema>
Call Signature
Section titled “Call Signature”static create<Schema>(schema, options?): StandardValidator;Defined in: elysia/dist/validator/index.d.ts:39
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Schema extends StandardSchemaV1Like<unknown, unknown> |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
schema | Schema |
options? | ValidatorOptions |
Returns
Section titled “Returns”Call Signature
Section titled “Call Signature”static create(schema, options?): Validator;Defined in: elysia/dist/validator/index.d.ts:40
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
schema | null |
options? | ValidatorOptions |
Returns
Section titled “Returns”Validator
reference()
Section titled “reference()”static reference(schema, models): AnySchema;Defined in: elysia/dist/validator/index.d.ts:35
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
schema | | string | TSchema | StandardSchemaV1Like<unknown, unknown> |
models | Record<string | number | symbol, AnySchema> |
Returns
Section titled “Returns”response()
Section titled “response()”static response(schema, options?): Map<number, Validator>;Defined in: elysia/dist/validator/index.d.ts:41
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
schema | | TSchema | StandardSchemaV1Like<unknown, unknown> | Record<number, | TSchema | StandardSchemaV1Like<unknown, unknown>> |
options? | ResponseValidatorOptions |
Returns
Section titled “Returns”Map<number, Validator>