Interface CodeKeywordDefinition

interface CodeKeywordDefinition {
    $data?: boolean;
    $dataError?: KeywordErrorDefinition;
    allowUndefined?: boolean;
    before?: string;
    code: ((cxt, ruleType?) => void);
    dependencies?: string[];
    error?: KeywordErrorDefinition;
    implements?: string[];
    keyword: string | string[];
    metaSchema?: AnySchemaObject;
    post?: boolean;
    schemaType?: "string" | "number" | "boolean" | "object" | "integer" | "null" | "array" | ("string" | "number" | "boolean" | "object" | "integer" | "null" | "array")[];
    trackErrors?: boolean;
    type?: "string" | "number" | "boolean" | "object" | "integer" | "null" | "array" | ("string" | "number" | "boolean" | "object" | "integer" | "null" | "array")[];
    validateSchema?: AnyValidateFunction<any>;
}

Hierarchy (view full)

Properties

$data? $dataError? allowUndefined? before? code dependencies? error? implements? keyword metaSchema? post? schemaType? trackErrors? type? validateSchema?

Properties

Optional $data

$data?: boolean

Optional $dataError

$dataError?: KeywordErrorDefinition

Optional allowUndefined

allowUndefined?: boolean

Optional before

before?: string

code

code: ((cxt, ruleType?) => void)

Type declaration

    • (cxt, ruleType?): void

    • Parameters

      Returns void

Optional dependencies

dependencies?: string[]

Optional error

error?: KeywordErrorDefinition

Optional implements

implements?: string[]

keyword

keyword: string | string[]

Optional metaSchema

metaSchema?: AnySchemaObject

Optional post

post?: boolean

Optional schemaType

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

Optional trackErrors

trackErrors?: boolean

Optional type

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

Optional validateSchema

validateSchema?: AnyValidateFunction<any>

Settings

Member Visibility

Theme

On This Page

$data$dataErrorallowUndefinedbeforecodedependencieserrorimplementskeywordmetaSchemapostschemaTypetrackErrorstypevalidateSchema