TypeBoxValidator

Members

Properties

Property	Description
Clean	-
hasCodec	-
hasDefault	-
isAsync	-
mayReturnPromise	-
precomputeSafe	-
reconstructedCheck	-
schema	-
tb	-

Methods

Method	Description
Check	-
Decode	-
Encode	-
EncodeFrom	-
Errors	-
From	-
FromAsync	-
FromSync	-
clear	-
create	-
isAsyncMember	-
reference	-
response	-

Defined in: elysia/dist/type/validator/index.d.ts:11

Extends

Validator

Type Parameters

Type Parameter	Default type
`T` extends `TSchema`	`TAny`

Constructors

Constructor

new TypeBoxValidator<T>(
   schema,
   options?,
   name?,
   isIntersectable?
): TypeBoxValidator<T>;

Defined in: elysia/dist/type/validator/index.d.ts:21

Parameters

Parameter	Type
`schema`	`T`
`options?`	`ValidatorOptions`
`name?`	`string`
`isIntersectable?`	`boolean`

Returns

TypeBoxValidator<T>

Overrides

Validator.constructor

Properties

Clean

Clean: (value) => unknown;

Defined in: elysia/dist/validator/index.d.ts:37

Parameters

Parameter	Type
`value`	`unknown`

Returns

unknown

Inherited from

Validator.Clean

hasCodec

hasCodec: boolean;

Defined in: elysia/dist/type/validator/index.d.ts:17

hasDefault

hasDefault: boolean;

Defined in: elysia/dist/type/validator/index.d.ts:19

isAsync

isAsync: boolean;

Defined in: elysia/dist/type/validator/index.d.ts:18

Overrides

Validator.isAsync

mayReturnPromise

mayReturnPromise: boolean;

Defined in: elysia/dist/validator/index.d.ts:32

Inherited from

Validator.mayReturnPromise

precomputeSafe

precomputeSafe: boolean;

Defined in: elysia/dist/type/validator/index.d.ts:20

reconstructedCheck?

optional reconstructedCheck?: (value) => boolean;

Defined in: elysia/dist/type/validator/index.d.ts:15

Parameters

Parameter	Type
`value`	`unknown`

Returns

boolean

schema

schema: T;

Defined in: elysia/dist/type/validator/index.d.ts:16

tb?

optional tb?: Validator;

Defined in: elysia/dist/type/validator/index.d.ts:14

Methods

Check()

Check(value): boolean;

Defined in: elysia/dist/type/validator/index.d.ts:22

Parameters

Parameter	Type
`value`	`StaticType`<[]>

Returns

boolean

Overrides

Validator.Check

Decode()

Decode(value): StaticType<[]>;

Defined in: elysia/dist/type/validator/index.d.ts:24

Parameters

Parameter	Type
`value`	`StaticType`<[]>

Returns

StaticType<[]>

Encode()

Encode(value): StaticType<[]>;

Defined in: elysia/dist/type/validator/index.d.ts:25

Parameters

Parameter	Type
`value`	`StaticType`<[]>

Returns

StaticType<[]>

EncodeFrom()

EncodeFrom(value, type?): StaticType<[]>;

Defined in: elysia/dist/type/validator/index.d.ts:26

Parameters

Parameter	Type
`value`	`StaticType`<[]>
`type?`	`string`

Returns

StaticType<[]>

Errors()

Errors(value): TLocalizedValidationError[];

Defined in: elysia/dist/type/validator/index.d.ts:23

Parameters

Parameter	Type
`value`	`unknown`

Returns

TLocalizedValidationError[]

Overrides

Validator.Errors

From()

From(value, type?): MaybePromise<StaticType<[], "Encode", {
}, {
}, T>>;

Defined in: elysia/dist/type/validator/index.d.ts:27

Parameters

Parameter	Type
`value`	`StaticType`<[]>
`type?`	`string`

Returns

MaybePromise<StaticType<[], "Encode", { }, { }, T>>

Overrides

Validator.From

FromAsync()

FromAsync(value, type?): Promise<StaticType<[], "Encode", {
}, {
}, T>>;

Defined in: elysia/dist/type/validator/index.d.ts:29

Parameters

Parameter	Type
`value`	`StaticType`<[]>
`type?`	`string`

Returns

Promise<StaticType<[], "Encode", { }, { }, T>>

FromSync()

FromSync(value, type?): StaticType<[]>;

Defined in: elysia/dist/type/validator/index.d.ts:30

Parameters

Parameter	Type
`value`	`StaticType`<[]>
`type?`	`string`

Returns

StaticType<[]>

clear()

static clear(): void;

Defined in: elysia/dist/validator/index.d.ts:42

Returns

void

Inherited from

Validator.clear

create()

Call Signature

static create<Schema>(schema, options?): TypeBoxValidator<Schema>;

Defined in: elysia/dist/validator/index.d.ts:38

Type Parameters

Type Parameter
`Schema` extends `TSchema`

Parameters

Parameter	Type
`schema`	`Schema`
`options?`	`ValidatorOptions`

Returns

TypeBoxValidator<Schema>

Inherited from

Validator.create

Call Signature

static create<Schema>(schema, options?): StandardValidator;

Defined in: elysia/dist/validator/index.d.ts:39

Type Parameters

Type Parameter
`Schema` extends `StandardSchemaV1Like`<`unknown`, `unknown`>

Parameters

Parameter	Type
`schema`	`Schema`
`options?`	`ValidatorOptions`

Returns

StandardValidator

Inherited from

Validator.create

Call Signature

static create(schema, options?): Validator;

Defined in: elysia/dist/validator/index.d.ts:40

Parameters

Parameter	Type
`schema`	`null`
`options?`	`ValidatorOptions`

Returns

Validator

Inherited from

Validator.create

isAsyncMember()

static isAsyncMember(schema, compiled): boolean;

Defined in: elysia/dist/type/validator/index.d.ts:13

Parameters

Parameter	Type
`schema`	`TSchema`
`compiled`	`any`

Returns

boolean

reference()

static reference(schema, models): AnySchema;

Defined in: elysia/dist/validator/index.d.ts:35

Parameters

Parameter	Type
`schema`	\| `string` \| `TSchema` \| `StandardSchemaV1Like`<`unknown`, `unknown`>
`models`	`Record`<`string` \| `number` \| `symbol`, `AnySchema`>

Returns

AnySchema

Inherited from

Validator.reference

response()

static response(schema, options?): Map<number, Validator>;

Defined in: elysia/dist/validator/index.d.ts:41

Parameters

Parameter	Type
`schema`	\| `TSchema` \| `StandardSchemaV1Like`<`unknown`, `unknown`> \| `Record`<`number`, \| `TSchema` \| `StandardSchemaV1Like`<`unknown`, `unknown`>>
`options?`	`ResponseValidatorOptions`

Returns

Map<number, Validator>

Inherited from

Validator.response