Class Ajv

Hierarchy (view full)

default
- Ajv

Constructors

constructor

new Ajv(opts?): Ajv
Parameters
- Optional opts: JTDOptions
Returns Ajv
Overrides default.constructor
- Defined in node_modules/ajv/dist/jtd.d.ts:26

Properties

`Readonly` RULES

RULES: ValidationRules

`Readonly` _compilations

_compilations: Set<SchemaEnv>

`Private` _compileParser

_compileParser: any

`Private` _compileSerializer

_compileSerializer: any

`Optional` errors

errors?: null | ErrorObject<string, Record<string, any>, unknown>[]

`Readonly` formats

formats: {}

Type declaration

logger

logger: Logger

opts

opts: InstanceOptions

`Readonly` refs

refs: {}

Type declaration

`Readonly` schemas

schemas: {}

Type declaration

`Readonly` scope

scope: ValueScope

`Static` MissingRefError

MissingRefError: typeof default

`Static` ValidationError

ValidationError: typeof default

Methods

$dataMetaSchema

$dataMetaSchema(metaSchema, keywordsJsonPointers): AnySchemaObject
Parameters
- metaSchema: AnySchemaObject
- keywordsJsonPointers: string[]
Returns AnySchemaObject
Inherited from default.$dataMetaSchema
- Defined in node_modules/ajv/dist/core.d.ts:163

_addDefaultMetaSchema

_addDefaultMetaSchema(): void
Returns void
Overrides default._addDefaultMetaSchema
- Defined in node_modules/ajv/dist/jtd.d.ts:28

_addSchema

_addSchema(schema, meta?, baseId?, validateSchema?, addSchema?): SchemaEnv
Parameters
- schema: AnySchema
- Optional meta: boolean
- Optional baseId: string
- Optional validateSchema: boolean | "log"
- Optional addSchema: boolean
Returns SchemaEnv
Inherited from default._addSchema
- Defined in node_modules/ajv/dist/core.d.ts:165

_addVocabularies

_addVocabularies(): void
Returns void
Overrides default._addVocabularies
- Defined in node_modules/ajv/dist/jtd.d.ts:27

addFormat

addFormat(name, format): default
Parameters
- name: string
- format: Format
Returns default
Inherited from default.addFormat
- Defined in node_modules/ajv/dist/core.d.ts:160

addKeyword

addKeyword(kwdOrDef, def?): default
Parameters
- kwdOrDef: string | KeywordDefinition
- Optional def: KeywordDefinition
Returns default
Inherited from default.addKeyword
- Defined in node_modules/ajv/dist/core.d.ts:157

addMetaSchema

addMetaSchema(schema, key?, _validateSchema?): default
Parameters
- schema: AnySchemaObject
- Optional key: string
- Optional _validateSchema: boolean | "log"
Returns default
Inherited from default.addMetaSchema
- Defined in node_modules/ajv/dist/core.d.ts:151

addSchema

addSchema(schema, key?, _meta?, _validateSchema?): default
Parameters
- schema: AnySchema | AnySchema[]
- Optional key: string
- Optional _meta: boolean
- Optional _validateSchema: boolean | "log"
Returns default
Inherited from default.addSchema
- Defined in node_modules/ajv/dist/core.d.ts:147

addVocabulary

addVocabulary(definitions): default
Parameters
- definitions: Vocabulary
Returns default
Inherited from default.addVocabulary
- Defined in node_modules/ajv/dist/core.d.ts:156

compile

compile<T>(schema, _meta?): ValidateFunction<T>
Type Parameters
- T = unknown
Parameters
- schema: Schema | JSONSchemaType<T>
- Optional _meta: boolean
Returns ValidateFunction<T>
Inherited from default.compile
- Defined in node_modules/ajv/dist/core.d.ts:138
compile<T>(schema, _meta?): ValidateFunction<T>
Type Parameters
- T = unknown
Parameters
- schema: JTDSchemaType<T>
- Optional _meta: boolean
Returns ValidateFunction<T>
Inherited from default.compile
- Defined in node_modules/ajv/dist/core.d.ts:139
compile<N, T>(schema, _meta?): ValidateFunction<JTDDataType<T>>
Type Parameters
- N extends never
- T extends SomeJTDSchemaType
Parameters
- schema: T
- Optional _meta: boolean
Returns ValidateFunction<JTDDataType<T>>
Inherited from default.compile
- Defined in node_modules/ajv/dist/core.d.ts:140
compile<T>(schema, _meta?): AsyncValidateFunction<T>
Type Parameters
- T = unknown
Parameters
- schema: AsyncSchema
- Optional _meta: boolean
Returns AsyncValidateFunction<T>
Inherited from default.compile
- Defined in node_modules/ajv/dist/core.d.ts:141
compile<T>(schema, _meta?): AnyValidateFunction<T>
Type Parameters
- T = unknown
Parameters
- schema: AnySchema
- Optional _meta: boolean
Returns AnyValidateFunction<T>
Inherited from default.compile
- Defined in node_modules/ajv/dist/core.d.ts:142

compileAsync

compileAsync<T>(schema, _meta?): Promise<ValidateFunction<T>>
Type Parameters
- T = unknown
Parameters
- schema: SchemaObject | JSONSchemaType<T>
- Optional _meta: boolean
Returns Promise<ValidateFunction<T>>
Inherited from default.compileAsync
- Defined in node_modules/ajv/dist/core.d.ts:143
compileAsync<T>(schema, _meta?): Promise<ValidateFunction<T>>
Type Parameters
- T = unknown
Parameters
- schema: JTDSchemaType<T>
- Optional _meta: boolean
Returns Promise<ValidateFunction<T>>
Inherited from default.compileAsync
- Defined in node_modules/ajv/dist/core.d.ts:144
compileAsync<T>(schema, meta?): Promise<AsyncValidateFunction<T>>
Type Parameters
- T = unknown
Parameters
- schema: AsyncSchema
- Optional meta: boolean
Returns Promise<AsyncValidateFunction<T>>
Inherited from default.compileAsync
- Defined in node_modules/ajv/dist/core.d.ts:145
compileAsync<T>(schema, meta?): Promise<AnyValidateFunction<T>>
Type Parameters
- T = unknown
Parameters
- schema: AnySchemaObject
- Optional meta: boolean
Returns Promise<AnyValidateFunction<T>>
Inherited from default.compileAsync
- Defined in node_modules/ajv/dist/core.d.ts:146

compileParser

compileParser<T>(schema): JTDParser<T>
Type Parameters
- T = unknown
Parameters
- schema: SchemaObject
Returns JTDParser<T>
- Defined in node_modules/ajv/dist/jtd.d.ts:32
compileParser<T>(schema): JTDParser<T>
Type Parameters
- T = unknown
Parameters
- schema: JTDSchemaType<T>
Returns JTDParser<T>
- Defined in node_modules/ajv/dist/jtd.d.ts:33

compileSerializer

compileSerializer<T>(schema): ((data) => string)
Type Parameters
- T = unknown
Parameters
- schema: SchemaObject
Returns ((data) => string)
- - (data): string
  - Parameters
    - data: T
    Returns string
- Defined in node_modules/ajv/dist/jtd.d.ts:30
compileSerializer<T>(schema): ((data) => string)
Type Parameters
- T = unknown
Parameters
- schema: JTDSchemaType<T>
Returns ((data) => string)
- - (data): string
  - Parameters
    - data: T
    Returns string
- Defined in node_modules/ajv/dist/jtd.d.ts:31

defaultMeta

defaultMeta(): undefined | string | AnySchemaObject
Returns undefined | string | AnySchemaObject
Overrides default.defaultMeta
- Defined in node_modules/ajv/dist/jtd.d.ts:29

errorsText

errorsText(errors?, __namedParameters?): string
Parameters
- Optional errors: null | ErrorObject<string, Record<string, any>, unknown>[]
- Optional __namedParameters: ErrorsTextOptions
Returns string
Inherited from default.errorsText
- Defined in node_modules/ajv/dist/core.d.ts:161

getKeyword

getKeyword(keyword): boolean | AddedKeywordDefinition
Parameters
- keyword: string
Returns boolean | AddedKeywordDefinition
Inherited from default.getKeyword
- Defined in node_modules/ajv/dist/core.d.ts:158

getSchema

getSchema<T>(keyRef): undefined | AnyValidateFunction<T>
Type Parameters
- T = unknown
Parameters
- keyRef: string
Returns undefined | AnyValidateFunction<T>
Inherited from default.getSchema
- Defined in node_modules/ajv/dist/core.d.ts:154

removeKeyword

removeKeyword(keyword): default
Parameters
- keyword: string
Returns default
Inherited from default.removeKeyword
- Defined in node_modules/ajv/dist/core.d.ts:159

removeSchema

removeSchema(schemaKeyRef?): default
Parameters
- Optional schemaKeyRef: string | RegExp | AnySchema
Returns default
Inherited from default.removeSchema
- Defined in node_modules/ajv/dist/core.d.ts:155

validate

validate(schema, data): boolean
Parameters
- schema: string | Schema
- data: unknown
Returns boolean
Inherited from default.validate
- Defined in node_modules/ajv/dist/core.d.ts:131
validate(schemaKeyRef, data): boolean | Promise<unknown>
Parameters
- schemaKeyRef: string | AnySchema
- data: unknown
Returns boolean | Promise<unknown>
Inherited from default.validate
- Defined in node_modules/ajv/dist/core.d.ts:132
validate<T>(schema, data): data is T
Type Parameters
- T
Parameters
- schema: string | Schema | JSONSchemaType<T>
- data: unknown
Returns data is T
Inherited from default.validate
- Defined in node_modules/ajv/dist/core.d.ts:133
validate<T>(schema, data): data is T
Type Parameters
- T
Parameters
- schema: JTDSchemaType<T>
- data: unknown
Returns data is T
Inherited from default.validate
- Defined in node_modules/ajv/dist/core.d.ts:134
validate<N, T>(schema, data): data is JTDDataType<T>
Type Parameters
- N extends never
- T extends SomeJTDSchemaType
Parameters
- schema: T
- data: unknown
Returns data is JTDDataType<T>
Inherited from default.validate
- Defined in node_modules/ajv/dist/core.d.ts:135
validate<T>(schema, data): Promise<T>
Type Parameters
- T
Parameters
- schema: AsyncSchema
- data: unknown
Returns Promise<T>
Inherited from default.validate
- Defined in node_modules/ajv/dist/core.d.ts:136
validate<T>(schemaKeyRef, data): data is T | Promise<T>
Type Parameters
- T
Parameters
- schemaKeyRef: string | AnySchema
- data: unknown
Returns data is T | Promise<T>
Inherited from default.validate
- Defined in node_modules/ajv/dist/core.d.ts:137

validateSchema

validateSchema(schema, throwOrLogError?): boolean | Promise<unknown>
Parameters
- schema: AnySchema
- Optional throwOrLogError: boolean
Returns boolean | Promise<unknown>
Inherited from default.validateSchema
- Defined in node_modules/ajv/dist/core.d.ts:153

Class Ajv

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Ajv

Properties

Readonly RULES

Readonly _compilations

Private _compileParser

Private _compileSerializer

Optional errors

Readonly formats

Type declaration

logger

opts

Readonly refs

Type declaration

Readonly schemas

Type declaration

Readonly scope

Static MissingRefError

Static ValidationError

Methods

$dataMetaSchema

Parameters

Returns AnySchemaObject

_addDefaultMetaSchema

Returns void

_addSchema

Parameters

Returns SchemaEnv

_addVocabularies

Returns void

addFormat

Parameters

Returns default

addKeyword

Parameters

Returns default

addMetaSchema

Parameters

Returns default

addSchema

Parameters

Returns default

addVocabulary

Parameters

Returns default

compile

Type Parameters

Parameters

Returns ValidateFunction<T>

Type Parameters

Parameters

Returns ValidateFunction<T>

Type Parameters

Parameters

Returns ValidateFunction<JTDDataType<T>>

Type Parameters

Parameters

Returns AsyncValidateFunction<T>

Type Parameters

Parameters

Returns AnyValidateFunction<T>

compileAsync

Type Parameters

Parameters

Returns Promise<ValidateFunction<T>>

Type Parameters

Parameters

Returns Promise<ValidateFunction<T>>

Type Parameters

Parameters

Returns Promise<AsyncValidateFunction<T>>

Type Parameters

`Readonly` RULES

`Readonly` _compilations

`Private` _compileParser

`Private` _compileSerializer

`Optional` errors

`Readonly` formats

`Readonly` refs

`Readonly` schemas

`Readonly` scope

`Static` MissingRefError

`Static` ValidationError