Class KeywordCxt

constructor

• new KeywordCxt(it, def, keyword): KeywordCxt

• Parameters

  • it: SchemaObjCxt
  • def: AddedKeywordDefinition
  • keyword: string

  Returns KeywordCxt

Optional Readonly $data

Optional Readonly allErrors

Readonly data

Readonly def

Optional Readonly errsCount

Readonly gen

Readonly it

Readonly keyword

params

Readonly parentSchema

schema

Readonly schemaCode

Readonly schemaType

Readonly schemaValue

$dataError

• $dataError(): void

• Returns void

block$data

• block$data(valid, codeBlock, $dataValid?): void

• Parameters

  • valid: Name
  • codeBlock: (() => void)
    • • (): void

      • Returns void

  • Optional $dataValid: Code

  Returns void

check$data

• check$data(valid?, $dataValid?): void

• Parameters

  • Optional valid: Name
  • Optional $dataValid: Code

  Returns void

error

• error(append?, errorParams?, errorPaths?): void

• Parameters

  • Optional append: boolean
  • Optional errorParams: KeywordCxtParams
  • Optional errorPaths: ErrorPaths

  Returns void

fail

• fail(condition?): void

• Parameters

  • Optional condition: Code

  Returns void

fail$data

• fail$data(condition): void

• Parameters

  • condition: Code

  Returns void

failResult

• failResult(condition, successAction?, failAction?): void

• Parameters

  • condition: Code
  • Optional successAction: (() => void)
    • • (): void

      • Returns void

  • Optional failAction: (() => void)
    • • (): void

      • Returns void

  Returns void

invalid$data

• invalid$data(): Code

• Returns Code

mergeEvaluated

• mergeEvaluated(schemaCxt, toName?): void

• Parameters

  • schemaCxt: SchemaCxt
  • Optional toName: typeof Name

  Returns void

mergeValidEvaluated

• mergeValidEvaluated(schemaCxt, valid): boolean | void

• Parameters

  • schemaCxt: SchemaCxt
  • valid: Name

  Returns boolean | void

ok

• ok(cond): void

• Parameters

  • cond: boolean | Code

  Returns void

pass

• pass(condition, failAction?): void

• Parameters

  • condition: Code
  • Optional failAction: (() => void)
    • • (): void

      • Returns void

  Returns void

reset

• reset(): void

• Returns void

result

• result(condition, successAction?, failAction?): void

• Parameters

  • condition: Code
  • Optional successAction: (() => void)
    • • (): void

      • Returns void

  • Optional failAction: (() => void)
    • • (): void

      • Returns void

  Returns void

setParams

• setParams(obj, assign?): void

• Parameters

  • obj: KeywordCxtParams
  • Optional assign: true

  Returns void

subschema

• subschema(appl, valid): SchemaCxt

• Parameters

  • appl: Partial<{
        allErrors: boolean;
        compositeRule: true;
        createErrors: boolean;
        data: Code;
        dataProp: string | number | Code;
        dataPropType: Type;
        dataTypes: ("string" | "number" | "boolean" | "object" | "integer" | "null" | "array")[];
        definedProperties: Set<string>;
        errSchemaPath: string;
        jtdDiscriminator: string;
        jtdMetadata: boolean;
        keyword: string;
        propertyName: Name;
        schema: AnySchema;
        schemaPath: Code;
        schemaProp: string | number;
        topSchemaRef: Code;
    }>
  • valid: Name

  Returns SchemaCxt