Interface SchemaInternals

interface SchemaInternals {
    $_super: Schema<any>;
    $_terms: Record<string, any>;
    $_addRule(rule): Schema<any>;
    $_compile(schema, options?): Schema<any>;
    $_createError(code, value, context, state, prefs, options?): Err;
    $_getFlag(name): any;
    $_getRule(name): undefined | GetRuleOptions;
    $_mapLabels(path): string;
    $_match(value, state, prefs): boolean;
    $_modify(options?): Schema<any>;
    $_mutateRebuild(): SchemaInternals;
    $_mutateRegister(schema, options?): void;
    $_property(name): any;
    $_reach(path): Schema<any>;
    $_rootReferences(): any;
    $_setFlag(flag, value, options?): void;
    $_validate(value, state, prefs): ValidationResult<any>;
}

Hierarchy

Properties

$_super $_terms

Methods

$_addRule $_compile $_createError $_getFlag $_getRule $_mapLabels $_match $_modify $_mutateRebuild $_mutateRegister $_property $_reach $_rootReferences $_setFlag $_validate

Properties

$_super

$_super: Schema<any>

Parent schema object.

$_terms

$_terms: Record<string, any>

Terms of current schema.

Methods

$_addRule

  • $_addRule(rule): Schema<any>

  • Adds a rule to current validation schema.

    Parameters

    • rule: string | AddRuleOptions

    Returns Schema<any>

$_compile

  • $_compile(schema, options?): Schema<any>

  • Internally compiles schema.

    Parameters

    • schema: SchemaLike
    • Optional options: CompileOptions

    Returns Schema<any>

$_createError

  • $_createError(code, value, context, state, prefs, options?): Err

  • Creates a joi error object.

    Parameters

    • code: string
    • value: any
    • context: Context
    • state: State
    • prefs: ValidationOptions
    • Optional options: CreateErrorOptions

    Returns Err

$_getFlag

  • $_getFlag(name): any

  • Get value from given flag.

    Parameters

    • name: string

    Returns any

$_getRule

  • $_getRule(name): undefined | GetRuleOptions

  • Retrieve some rule configuration.

    Parameters

    • name: string

    Returns undefined | GetRuleOptions

$_mapLabels

  • $_mapLabels(path): string

  • Parameters

    • path: string | string[]

    Returns string

$_match

  • $_match(value, state, prefs): boolean

  • Returns true if validations runs fine on given value.

    Parameters

    • value: any
    • state: State
    • prefs: ValidationOptions

    Returns boolean

$_modify

  • $_modify(options?): Schema<any>

  • Parameters

    • Optional options: ModifyOptions

    Returns Schema<any>

$_mutateRebuild

$_mutateRegister

  • $_mutateRegister(schema, options?): void

  • Parameters

    • schema: Schema<any>
    • Optional options: MutateRegisterOptions

    Returns void

$_property

  • $_property(name): any

  • Get value from given property.

    Parameters

    • name: string

    Returns any

$_reach

  • $_reach(path): Schema<any>

  • Get schema at given path.

    Parameters

    • path: string[]

    Returns Schema<any>

$_rootReferences

  • $_rootReferences(): any

  • Get current schema root references.

    Returns any

$_setFlag

  • $_setFlag(flag, value, options?): void

  • Set flag to given value.

    Parameters

    • flag: string
    • value: any
    • Optional options: SetFlagOptions

    Returns void

$_validate

  • $_validate(value, state, prefs): ValidationResult<any>

  • Runs internal validations against given value.

    Parameters

    • value: any
    • state: State
    • prefs: ValidationOptions

    Returns ValidationResult<any>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc