Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "node_modules/@types/json-schema/index.d"

Index

Type aliases

JSONSchema4Type

JSONSchema4Type: string | number | boolean | JSONSchema4Object | JSONSchema4Array | null

JSONSchema4TypeName

JSONSchema4TypeName: "string" | "number" | "integer" | "boolean" | "object" | "array" | "null" | "any"

JSONSchema4Version

JSONSchema4Version: string

JSONSchema6Definition

JSONSchema6Definition: JSONSchema6 | boolean

JSONSchema6Type

JSONSchema6Type: string | number | boolean | JSONSchema6Object | JSONSchema6Array | null

JSONSchema6TypeName

JSONSchema6TypeName: "string" | "number" | "integer" | "boolean" | "object" | "array" | "null" | "any"

JSONSchema6Version

JSONSchema6Version: string

JSONSchema7Definition

JSONSchema7Definition: JSONSchema7 | boolean

JSONSchema7Type

JSONSchema7Type: string | number | boolean | JSONSchema7Object | JSONSchema7Array | null

JSONSchema7TypeName

JSONSchema7TypeName: "string" | "number" | "integer" | "boolean" | "object" | "array" | "null"

JSONSchema7Version

JSONSchema7Version: string

Functions

checkPropertyChange

  • The checkPropertyChange method will check to see if an value can legally be in property with the given schema This is slightly different than the validate method in that it will fail if the schema is readonly and it will not check for self-validation, it is assumed that the passed in value is already internally valid.

    Parameters

    Returns ValidationResult

mustBeValid

  • This checks to ensure that the result is valid and will throw an appropriate error message if it is not.

    Parameters

    Returns void

validate

  • To use the validator call JSONSchema.validate with an instance object and an optional schema object. If a schema is provided, it will be used to validate. If the instance object refers to a schema (self-validating), that schema will be used to validate and the schema parameter is not necessary (if both exist, both validations will occur).

    Parameters

    Returns ValidationResult

Generated using TypeDoc