Interface FuncKeywordDefinition

interface FuncKeywordDefinition {
    $data?: boolean;
    $dataError?: KeywordErrorDefinition;
    allowUndefined?: boolean;
    async?: boolean;
    before?: string;
    compile?: CompileKeywordFunc;
    dependencies?: string[];
    error?: KeywordErrorDefinition;
    errors?: boolean | "full";
    implements?: string[];
    keyword: string | string[];
    metaSchema?: AnySchemaObject;
    modifying?: boolean;
    post?: boolean;
    schema?: boolean;
    schemaType?: "string" | "number" | "boolean" | "object" | "integer" | "null" | "array" | ("string" | "number" | "boolean" | "object" | "integer" | "null" | "array")[];
    type?: "string" | "number" | "boolean" | "object" | "integer" | "null" | "array" | ("string" | "number" | "boolean" | "object" | "integer" | "null" | "array")[];
    valid?: boolean;
    validate?: SchemaValidateFunction | DataValidateFunction;
    validateSchema?: AnyValidateFunction<any>;
}

Hierarchy (view full)

Properties

$data? $dataError? allowUndefined? async? before? compile? dependencies? error? errors? implements? keyword metaSchema? modifying? post? schema? schemaType? type? valid? validate? validateSchema?

Properties

Optional $data

$data?: boolean

Optional $dataError

$dataError?: KeywordErrorDefinition

Optional allowUndefined

allowUndefined?: boolean

Optional async

async?: boolean

Optional before

before?: string

Optional compile

compile?: CompileKeywordFunc

Optional dependencies

dependencies?: string[]

Optional error

error?: KeywordErrorDefinition

Optional errors

errors?: boolean | "full"

Optional implements

implements?: string[]

keyword

keyword: string | string[]

Optional metaSchema

metaSchema?: AnySchemaObject

Optional modifying

modifying?: boolean

Optional post

post?: boolean

Optional schema

schema?: boolean

Optional schemaType

schemaType?: "string" | "number" | "boolean" | "object" | "integer" | "null" | "array" | ("string" | "number" | "boolean" | "object" | "integer" | "null" | "array")[]

Optional type

type?: "string" | "number" | "boolean" | "object" | "integer" | "null" | "array" | ("string" | "number" | "boolean" | "object" | "integer" | "null" | "array")[]

Optional valid

valid?: boolean

Optional validate

validate?: SchemaValidateFunction | DataValidateFunction

Optional validateSchema

validateSchema?: AnyValidateFunction<any>

Settings

Member Visibility

Theme

On This Page

$data$dataErrorallowUndefinedasyncbeforecompiledependencieserrorerrorsimplementskeywordmetaSchemamodifyingpostschemaschemaTypetypevalidvalidatevalidateSchema