Interface: FunctionSchema<TSchema>

Schema type for function validation.

Extends

ObjectSchema<TSchema>

Type Parameters

Type Parameter	Default type
`TSchema`	`Function`

Properties

Property	Modifier	Type	Description	Inherited from
`_flags`	`public`	`Record`<`string`, `any`>	Flags of current schema.	`ObjectSchema`.`_flags`
`~standard`	`readonly`	`Props`<`TSchema`, `TSchema`>	The Standard Schema properties.	`ObjectSchema`.`~standard`
`$`	`public`	`FunctionSchema`<`TSchema`>	Starts a ruleset in order to apply multiple rule options. The set ends when `rule()`, `keep()`, `message()`, or `warn()` is called.	`ObjectSchema`.`$`
`$_knex`	`public`	`any`	-	`ObjectSchema`.`$_knex`
`$_super`	`public`	`Schema`	Parent schema object.	`ObjectSchema`.`$_super`
`$_terms`	`public`	`Record`<`string`, `any`>	Terms of current schema.	`SchemaInternals`.`$_terms`
`ruleset`	`public`	`FunctionSchema`<`TSchema`>	Starts a ruleset in order to apply multiple rule options. The set ends when `rule()`, `keep()`, `message()`, or `warn()` is called.	`ObjectSchema`.`ruleset`
`type?`	`public`	`string`	-	`ObjectSchema`.`type`

Methods

$_addRule()

$_addRule(rule: string | AddRuleOptions): Schema;

Adds a rule to current validation schema.

Parameters

Parameter	Type
`rule`	`string` \| `AddRuleOptions`

Returns

Schema

Inherited from

ObjectSchema.$_addRule

$_compile()

$_compile(schema: SchemaLike, options?: CompileOptions): Schema;

Internally compiles schema.

Parameters

Parameter	Type
`schema`	`SchemaLike`
`options?`	`CompileOptions`

Returns

Schema

Inherited from

ObjectSchema.$_compile

$_createError()

$_createError(
   code: string,
   value: any,
   context: ValidationContext,
   state: State,
   prefs: ValidationOptions,
   options?: CreateErrorOptions): Err;

Creates a joi error object.

Parameters

Parameter	Type
`code`	`string`
`value`	`any`
`context`	`ValidationContext`
`state`	`State`
`prefs`	`ValidationOptions`
`options?`	`CreateErrorOptions`

Returns

Err

Inherited from

SchemaInternals.$_createError

$_getFlag()

$_getFlag(name: string): any;

Get value from given flag.

Parameters

Parameter	Type
`name`	`string`

Returns

any

Inherited from

SchemaInternals.$_getFlag

$_getRule()

$_getRule(name: string): GetRuleOptions | undefined;

Retrieve some rule configuration.

Parameters

Parameter	Type
`name`	`string`

Returns

GetRuleOptions | undefined

Inherited from

ObjectSchema.$_getRule

$_mapLabels()

$_mapLabels(path: string | string[]): string;

Parameters

Parameter	Type
`path`	`string` \| `string`[]

Returns

string

Inherited from

ObjectSchema.$_mapLabels

$_match()

$_match(
   value: any,
   state: State,
   prefs: ValidationOptions): boolean;

Returns true if validations runs fine on given value.

Parameters

Parameter	Type
`value`	`any`
`state`	`State`
`prefs`	`ValidationOptions`

Returns

boolean

Inherited from

SchemaInternals.$_match

$_modify()

$_modify(options?: ModifyOptions): Schema;

Parameters

Parameter	Type
`options?`	`ModifyOptions`

Returns

Schema

Inherited from

ObjectSchema.$_modify

$_mutateRebuild()

$_mutateRebuild(): this;

Resets current schema.

Returns

this

Inherited from

ObjectSchema.$_mutateRebuild

$_mutateRegister()

$_mutateRegister(schema: Schema_2, options?: MutateRegisterOptions): void;

Parameters

Parameter	Type
`schema`	`Schema_2`
`options?`	`MutateRegisterOptions`

Returns

void

Inherited from

SchemaInternals.$_mutateRegister

$_property()

$_property(name: string): any;

Get value from given property.

Parameters

Parameter	Type
`name`	`string`

Returns

any

Inherited from

SchemaInternals.$_property

$_reach()

$_reach(path: string[]): Schema;

Get schema at given path.

Parameters

Parameter	Type
`path`	`string`[]

Returns

Schema

Inherited from

ObjectSchema.$_reach

$_rootReferences()

$_rootReferences(): any;

Get current schema root references.

Returns

any

Inherited from

SchemaInternals.$_rootReferences

$_setFlag()

$_setFlag(
   flag: string,
   value: any,
   options?: SetFlagOptions): void;

Set flag to given value.

Parameters

Parameter	Type
`flag`	`string`
`value`	`any`
`options?`	`SetFlagOptions`

Returns

void

Inherited from

SchemaInternals.$_setFlag

$_validate()

$_validate(
   value: any,
   state: State,
   prefs: ValidationOptions): ValidationResult;

Runs internal validations against given value.

Parameters

Parameter	Type
`value`	`any`
`state`	`State`
`prefs`	`ValidationOptions`

Returns

ValidationResult

Inherited from

SchemaInternals.$_validate

allow()

allow(...values: any[]): this;

Parameters

Parameter	Type
...`values`	`any`[]

Returns

this

Inherited from

ObjectSchema.allow

alter()

alter(targets: Record<string, (schema: this) => Schema>): this;

Parameters

Parameter	Type
`targets`	`Record`<`string`, (`schema`: `this`) => `Schema`>

Returns

this

Inherited from

ObjectSchema.alter

and()

and(...peers: (string | DependencyOptions)[]): this;

Defines an all-or-nothing relationship between keys where if one of the peers is present, all of them are required as well.

Optional settings must be the last argument.

Parameters

Parameter	Type
...`peers`	(`string` \| `DependencyOptions`)[]

Returns

this

Inherited from

ObjectSchema.and

append()

Call Signature

append(schema?: PartialSchemaMap<TSchema>): this;

Appends the allowed object keys. If schema is null, undefined, or {}, no changes will be applied.

Parameters

Parameter	Type
`schema?`	`PartialSchemaMap`<`TSchema`>

Returns

this

Inherited from

ObjectSchema.append

Call Signature

append<TSchemaExtended, T>(schema?: PartialSchemaMap<T>): ObjectSchema<T>;

Type Parameters

Type Parameter	Default type
`TSchemaExtended`	`any`
`T`	`TSchemaExtended`

Parameters

Parameter	Type
`schema?`	`PartialSchemaMap`<`T`>

Returns

ObjectSchema<T>

Inherited from

ObjectSchema.append

arity()

arity(n: number): this;

Specifies the arity of the function where:

Parameters

Parameter	Type	Description
`n`	`number`	the arity expected.

Returns

this

artifact()

artifact(id: any): this;

Parameters

Parameter	Type
`id`	`any`

Returns

this

Inherited from

ObjectSchema.artifact

assert()

assert(
   ref: string | Reference,
   schema: SchemaLike,
   message?: string): this;

Verifies an assertion where.

Parameters

Parameter	Type
`ref`	`string` \| `Reference`
`schema`	`SchemaLike`
`message?`	`string`

Returns

this

Inherited from

ObjectSchema.assert

bind()

bind(): this;

Returns

this

Inherited from

ObjectSchema.bind

cache()

cache(cache?: Cache): this;

Parameters

Parameter	Type
`cache?`	`Cache`

Returns

this

Inherited from

ObjectSchema.cache

cast()

cast(to: "string" | "number" | "object" | "set" | "map"): this;

Parameters

Parameter	Type
`to`	`"string"` \| `"number"` \| `"object"` \| `"set"` \| `"map"`

Returns

this

Inherited from

ObjectSchema.cast

class()

class(): this;

Requires the function to be a class.

Returns

this

concat()

concat(schema: this): this;

Parameters

Parameter	Type
`schema`	`this`

Returns

this

Inherited from

ObjectSchema.concat

custom()

custom(fn: CustomValidator, description?: string): this;

Parameters

Parameter	Type
`fn`	`CustomValidator`
`description?`	`string`

Returns

this

Inherited from

ObjectSchema.custom

db()

db(connection: any): this;

Alias for .knex(). Sets the database connection for database validation rules.

Parameters

Parameter	Type	Description
`connection`	`any`	A Knex instance, transaction, or connection configuration

Returns

this

Inherited from

ObjectSchema.db

default()

default(value?: DefaultableValue): this;

Sets a default value if the original value is undefined.

Parameters

Parameter	Type	Description
`value?`	`DefaultableValue`	The default value. Can be: - A literal object value - A reference to another schema value - A function that returns the default value with signature `(parent, helpers) => value` - `parent` - A clone of the object containing the value being validated - `helpers` - Validation helper functions for custom validation logic When called without any value on an object schema type, a default value will be automatically generated based on the default values of the object keys.

Returns

this

Inherited from

ObjectSchema.default

describe()

describe(): Description;

Returns a plain object representing the schema's rules and properties

Returns

Description

Inherited from

ObjectSchema.describe

description()

description(desc: string): this;

Parameters

Parameter	Type
`desc`	`string`

Returns

this

Inherited from

ObjectSchema.description

disallow()

disallow(...values: any[]): this;

Parameters

Parameter	Type
...`values`	`any`[]

Returns

this

Inherited from

ObjectSchema.disallow

empty()

empty(schema?: SchemaLike): this;

Parameters

Parameter	Type
`schema?`	`SchemaLike`

Returns

this

Inherited from

ObjectSchema.empty

equal()

equal(...values: any[]): this;

Parameters

Parameter	Type
...`values`	`any`[]

Returns

this

Inherited from

ObjectSchema.equal

error()

error(err:
  | Error
  | ValidationErrorFunction): this;

Parameters

Parameter	Type
`err`	\| `Error` \| `ValidationErrorFunction`

Returns

this

Inherited from

ObjectSchema.error

example()

example(value: any, options?: {
  override: boolean;
}): this;

Parameters

Parameter	Type
`value`	`any`
`options?`	{ `override`: `boolean`; }
`options.override?`	`boolean`

Returns

this

Inherited from

ObjectSchema.example

exist()

exist(): this;

Returns

this

Inherited from

ObjectSchema.exist

existsInDb()

existsInDb(
   table: string | Reference,
   column: string | Reference,
   options?: DbValidationOptions): this;

Validates that the value exists in the specified database table and column. Requires .knex() or .db() to be called first to set the database connection.

Parameters

Parameter	Type	Description
`table`	`string` \| `Reference`	The database table name (can be a Joi reference)
`column`	`string` \| `Reference`	The column name to check (can be a Joi reference)
`options?`	`DbValidationOptions`	Optional configuration: - `caseInsensitive`: Perform case-insensitive comparison (default: false) - `filter`: Async function to add additional WHERE clauses to the query

Returns

this

Example

typescript

const schema = joi.object({
  country_id: joi.number().knex(db).existsInDb("countries", "id"),
  category: joi.string().knex(db).existsInDb("categories", "name", {
    caseInsensitive: true,
  }),
});

Inherited from

ObjectSchema.existsInDb

external()

external(method: ExternalValidationFunction, description?: string): this;

Parameters

Parameter	Type
`method`	`ExternalValidationFunction`
`description?`	`string`

Returns

this

Inherited from

ObjectSchema.external

extract()

extract(path: string | string[]): Schema;

Returns a sub-schema based on a path of object keys or schema ids.

Parameters

Parameter	Type	Description
`path`	`string` \| `string`[]	a dot `.` separated path string or a pre-split array of path keys. The keys must match the sub-schema id or object key (if no id was explicitly set).

Returns

Schema

Inherited from

ObjectSchema.extract

failover()

failover(value: any): this;

Parameters

Parameter	Type
`value`	`any`

Returns

this

Inherited from

ObjectSchema.failover

forbidden()

forbidden(): this;

Returns

this

Inherited from

ObjectSchema.forbidden

fork()

fork(key: string | string[] | string[][], adjuster: SchemaFunction): this;

Parameters

Parameter	Type
`key`	`string` \| `string`[] \| `string`[][]
`adjuster`	`SchemaFunction`

Returns

this

Inherited from

ObjectSchema.fork

id()

id(name?: string): this;

Parameters

Parameter	Type
`name?`	`string`

Returns

this

Inherited from

ObjectSchema.id

instance()

instance(constructor: Function, name?: string): this;

Requires the object to be an instance of a given constructor.

Parameters

Parameter	Type	Description
`constructor`	`Function`	the constructor function that the object must be an instance of.
`name?`	`string`	an alternate name to use in validation errors. This is useful when the constructor function does not have a name.

Returns

this

Inherited from

ObjectSchema.instance

invalid()

invalid(...values: any[]): this;

Parameters

Parameter	Type
...`values`	`any`[]

Returns

this

Inherited from

ObjectSchema.invalid

isAsync()

isAsync(): boolean;

Returns a boolean indicating whether this schema contains a rule that requires asynchronous validation.

Returns

boolean

Inherited from

ObjectSchema.isAsync

keep()

keep(): this;

Returns

this

Inherited from

ObjectSchema.keep

keys()

keys(schema?: PartialSchemaMap<TSchema>): this;

Sets or extends the allowed object keys.

Parameters

Parameter	Type
`schema?`	`PartialSchemaMap`<`TSchema`>

Returns

this

Inherited from

ObjectSchema.keys

knex()

knex(connection: any): this;

Sets the database connection for database validation rules. This must be called before using .uniqueInDb() or .existsInDb().

Parameters

Parameter	Type	Description
`connection`	`any`	A Knex instance, transaction, or connection configuration

Returns

this

Example

typescript

import knex from 'knex'
const db = knex({ client: 'pg', connection: {...} })
const schema = joi.string().knex(db).uniqueInDb('users', 'email')

Inherited from

ObjectSchema.knex

label()

label(name: string): this;

Parameters

Parameter	Type
`name`	`string`

Returns

this

Inherited from

ObjectSchema.label

length()

length(limit: number): this;

Specifies the exact number of keys in the object.

Parameters

Parameter	Type
`limit`	`number`

Returns

this

Inherited from

ObjectSchema.length

max()

max(limit: number | Reference): this;

Specifies the maximum number of keys in the object.

Parameters

Parameter	Type
`limit`	`number` \| `Reference`

Returns

this

Inherited from

ObjectSchema.max

maxArity()

maxArity(n: number): this;

Specifies the minimal arity of the function where:

Parameters

Parameter	Type	Description
`n`	`number`	the minimal arity expected.

Returns

this

message()

message(message: string): this;

Parameters

Parameter	Type
`message`	`string`

Returns

this

Inherited from

ObjectSchema.message

messages()

messages(messages: LanguageMessages): this;

Parameters

Parameter	Type
`messages`	`LanguageMessages`

Returns

this

Inherited from

ObjectSchema.messages

meta()

meta(meta: object): this;

Parameters

Parameter	Type
`meta`	`object`

Returns

this

Inherited from

ObjectSchema.meta

min()

min(limit: number | Reference): this;

Specifies the minimum number of keys in the object.

Parameters

Parameter	Type
`limit`	`number` \| `Reference`

Returns

this

Inherited from

ObjectSchema.min

minArity()

minArity(n: number): this;

Specifies the minimal arity of the function where:

Parameters

Parameter	Type	Description
`n`	`number`	the minimal arity expected.

Returns

this

nand()

nand(...peers: (string | DependencyOptions)[]): this;

Defines a relationship between keys where not all peers can be present at the same time.

Optional settings must be the last argument.

Parameters

Parameter	Type
...`peers`	(`string` \| `DependencyOptions`)[]

Returns

this

Inherited from

ObjectSchema.nand

not()

not(...values: any[]): this;

Parameters

Parameter	Type
...`values`	`any`[]

Returns

this

Inherited from

ObjectSchema.not

note()

note(...notes: string[]): this;

Parameters

Parameter	Type
...`notes`	`string`[]

Returns

this

Inherited from

ObjectSchema.note

only()

only(): this;

Returns

this

Inherited from

ObjectSchema.only

optional()

optional(): this;

Returns

this

Inherited from

ObjectSchema.optional

options()

options(options: ValidationOptions): this;

Parameters

Parameter	Type
`options`	`ValidationOptions`

Returns

this

Inherited from

ObjectSchema.options

or()

or(...peers: (string | DependencyOptions)[]): this;

Defines a relationship between keys where one of the peers is required (and more than one is allowed).

Optional settings must be the last argument.

Parameters

Parameter	Type
...`peers`	(`string` \| `DependencyOptions`)[]

Returns

this

Inherited from

ObjectSchema.or

oxor()

oxor(...peers: (string | DependencyOptions)[]): this;

Defines an exclusive relationship between a set of keys where only one is allowed but none are required.

Optional settings must be the last argument.

Parameters

Parameter	Type
...`peers`	(`string` \| `DependencyOptions`)[]

Returns

this

Inherited from

ObjectSchema.oxor

pattern()

pattern(
   pattern: RegExp | SchemaLike,
   schema: SchemaLike,
   options?: ObjectPatternOptions): this;

Specify validation rules for unknown keys matching a pattern.

Parameters

Parameter	Type	Description
`pattern`	`RegExp` \| `SchemaLike`	a pattern that can be either a regular expression or a joi schema that will be tested against the unknown key names
`schema`	`SchemaLike`	the schema object matching keys must validate against
`options?`	`ObjectPatternOptions`	-

Returns

this

Inherited from

ObjectSchema.pattern

preferences()

preferences(options: ValidationOptions): this;

Parameters

Parameter	Type
`options`	`ValidationOptions`

Returns

this

Inherited from

ObjectSchema.preferences

prefs()

prefs(options: ValidationOptions): this;

Parameters

Parameter	Type
`options`	`ValidationOptions`

Returns

this

Inherited from

ObjectSchema.prefs

presence()

presence(mode: PresenceMode): this;

Parameters

Parameter	Type
`mode`	`PresenceMode`

Returns

this

Inherited from

ObjectSchema.presence

raw()

raw(enabled?: boolean): this;

Parameters

Parameter	Type
`enabled?`	`boolean`

Returns

this

Inherited from

ObjectSchema.raw

ref()

ref(): this;

Requires the object to be a Joi reference.

Returns

this

Inherited from

ObjectSchema.ref

regex()

regex(): this;

Requires the object to be a RegExp object.

Returns

this

Inherited from

ObjectSchema.regex

rename()

rename(
   from: string | RegExp,
   to: string,
   options?: RenameOptions): this;

Renames a key to another name (deletes the renamed key).

Parameters

Parameter	Type
`from`	`string` \| `RegExp`
`to`	`string`
`options?`	`RenameOptions`

Returns

this

Inherited from

ObjectSchema.rename

required()

required(): this;

Returns

this

Inherited from

ObjectSchema.required

rule()

rule(options: RuleOptions): this;

Parameters

Parameter	Type
`options`	`RuleOptions`

Returns

this

Inherited from

ObjectSchema.rule

schema()

schema(type?: SchemaLike): this;

Requires the object to be a Joi schema instance.

Parameters

Parameter	Type
`type?`	`SchemaLike`

Returns

this

Inherited from

ObjectSchema.schema

shared()

shared(ref: Schema): this;

Parameters

Parameter	Type
`ref`	`Schema`

Returns

this

Inherited from

ObjectSchema.shared

strict()

strict(isStrict?: boolean): this;

Parameters

Parameter	Type
`isStrict?`	`boolean`

Returns

this

Inherited from

ObjectSchema.strict

strip()

strip(enabled?: boolean): this;

Parameters

Parameter	Type
`enabled?`	`boolean`

Returns

this

Inherited from

ObjectSchema.strip

tag()

tag(...tags: string[]): this;

Parameters

Parameter	Type
...`tags`	`string`[]

Returns

this

Inherited from

ObjectSchema.tag

tailor()

tailor(targets: string | string[]): Schema;

Applies any assigned target alterations to a copy of the schema that were applied via any.alter().

Parameters

Parameter	Type
`targets`	`string` \| `string`[]

Returns

Schema

Inherited from

ObjectSchema.tailor

uniqueInDb()

uniqueInDb(
   table: string | Reference,
   column: string | Reference,
   options?: DbValidationOptions): this;

Validates that the value is unique in the specified database table and column. Requires .knex() or .db() to be called first to set the database connection.

Parameters

Parameter	Type	Description
`table`	`string` \| `Reference`	The database table name (can be a Joi reference)
`column`	`string` \| `Reference`	The column name to check (can be a Joi reference)
`options?`	`DbValidationOptions`	Optional configuration: - `caseInsensitive`: Perform case-insensitive comparison (default: false) - `filter`: Async function to add additional WHERE clauses to the query

Returns

this

Example

typescript

const schema = joi.object({
  email: joi.string().email().knex(db).uniqueInDb("users", "email"),
  username: joi
    .string()
    .knex(db)
    .uniqueInDb("users", "username", {
      caseInsensitive: true,
      filter: async (query) => query.where("tenant_id", tenantId),
    }),
});

Inherited from

ObjectSchema.uniqueInDb

unit()

unit(name: string): this;

Parameters

Parameter	Type
`name`	`string`

Returns

this

Inherited from

ObjectSchema.unit

unknown()

unknown(allow?: boolean): this;

Overrides the handling of unknown keys for the scope of the current object only (does not apply to children).

Parameters

Parameter	Type
`allow?`	`boolean`

Returns

this

Inherited from

ObjectSchema.unknown

valid()

valid(...values: any[]): this;

Parameters

Parameter	Type
...`values`	`any`[]

Returns

this

Inherited from

ObjectSchema.valid

validate()

validate(value: any, options?: ValidationOptions): ValidationResult<TSchema>;

Validates a value using the schema and options.

Parameters

Parameter	Type
`value`	`any`
`options?`	`ValidationOptions`

Returns

ValidationResult<TSchema>

Inherited from

ObjectSchema.validate

validateAsync()

validateAsync<TOpts>(value: any, options?: TOpts): Promise<TOpts extends
  | {
  artifacts: true;
}
  | {
  warnings: true;
} ? {
  value: TSchema;
} & TOpts<TOpts> extends {
  artifacts: true;
} ? {
  artifacts: Map<any, string[][]>;
} : {
} & TOpts<TOpts> extends {
  warnings: true;
} ? {
  warning: ValidationWarning;
} : {
} : TSchema>;

Validates a value using the schema and options.

Type Parameters

Type Parameter
`TOpts` extends `AsyncValidationOptions`

Parameters

Parameter	Type
`value`	`any`
`options?`	`TOpts`

Returns

Promise<TOpts extends | { artifacts: true; } | { warnings: true; } ? { value: TSchema; } & TOpts<TOpts> extends { artifacts: true; } ? { artifacts: Map<any, string[][]>; } : { } & TOpts<TOpts> extends { warnings: true; } ? { warning: ValidationWarning; } : { } : TSchema>

Inherited from

ObjectSchema.validateAsync

warn()

warn(): this;

Returns

this

Inherited from

ObjectSchema.warn

warning()

warning(code: string, context: ValidationContext): this;

Parameters

Parameter	Type
`code`	`string`
`context`	`ValidationContext`

Returns

this

Inherited from

ObjectSchema.warning

when()

Call Signature

when(ref: string | Reference, options:
  | WhenOptions<any, any>
  | WhenOptions<any, any>[]): this;

Parameters

Parameter	Type
`ref`	`string` \| `Reference`
`options`	\| `WhenOptions`<`any`, `any`> \| `WhenOptions`<`any`, `any`>[]

Returns

this

Inherited from

ObjectSchema.when

Call Signature

when(ref: Schema, options: WhenSchemaOptions): this;

Parameters

Parameter	Type
`ref`	`Schema`
`options`	`WhenSchemaOptions`

Returns

this

Inherited from

ObjectSchema.when

with()

with(
   key: string,
   peers: string | string[],
   options?: DependencyOptions): this;

Requires the presence of other keys whenever the specified key is present.

Parameters

Parameter	Type
`key`	`string`
`peers`	`string` \| `string`[]
`options?`	`DependencyOptions`

Returns

this

Inherited from

ObjectSchema.with

without()

without(
   key: string,
   peers: string | string[],
   options?: DependencyOptions): this;

Forbids the presence of other keys whenever the specified is present.

Parameters

Parameter	Type
`key`	`string`
`peers`	`string` \| `string`[]
`options?`	`DependencyOptions`

Returns

this

Inherited from

ObjectSchema.without

xor()

xor(...peers: (string | DependencyOptions)[]): this;

Defines an exclusive relationship between a set of keys. one of them is required but not at the same time.

Optional settings must be the last argument.

Parameters

Parameter	Type
...`peers`	(`string` \| `DependencyOptions`)[]

Returns

this

Inherited from

ObjectSchema.xor

address

Interfaces

Variables

Functions

formula

Namespaces

Classes

Interfaces

guards

Variables

location

Interfaces

OpenAPIV3

Enumerations

Interfaces

Type Aliases

casters

Functions

consumers

Functions

guards

Variables

Functions

preparers

Functions

Interface: FunctionSchema<TSchema> ​

Extends ​

Type Parameters ​

Properties ​

Methods ​

$_addRule() ​

Parameters ​

Returns ​

Inherited from ​

$_compile() ​

Parameters ​

Returns ​

Inherited from ​

$_createError() ​

Parameters ​

Returns ​

Inherited from ​

$_getFlag() ​

Parameters ​

Returns ​

Inherited from ​

$_getRule() ​

Parameters ​

Returns ​

Inherited from ​

$_mapLabels() ​

Parameters ​

Returns ​

Inherited from ​

$_match() ​

Parameters ​

Returns ​

Inherited from ​

$_modify() ​

Parameters ​

Returns ​

Inherited from ​

$_mutateRebuild() ​

Returns ​

Inherited from ​

$_mutateRegister() ​

Parameters ​

Returns ​

Inherited from ​

$_property() ​

Parameters ​

Returns ​

Inherited from ​

$_reach() ​

Parameters ​

Returns ​

Inherited from ​

$_rootReferences() ​

Returns ​

Inherited from ​

Interface: FunctionSchema<TSchema>

Extends

Type Parameters

Properties

Methods

$_addRule()

Parameters

Returns

Inherited from

$_compile()

Parameters

Returns

Inherited from

$_createError()

Parameters

Returns

Inherited from

$_getFlag()

Parameters

Returns

Inherited from

$_getRule()

Parameters

Returns

Inherited from

$_mapLabels()

Parameters

Returns

Inherited from

$_match()

Parameters

Returns

Inherited from

$_modify()

Parameters

Returns

Inherited from

$_mutateRebuild()

Returns

Inherited from

$_mutateRegister()

Parameters

Returns

Inherited from

$_property()

Parameters

Returns

Inherited from

$_reach()

Parameters

Returns

Inherited from

$_rootReferences()

Returns

Inherited from

$_setFlag()

Parameters

Returns

Inherited from

$_validate()

Parameters

Returns

Inherited from

allow()