Rush StackShopBlogEvents
Skip to main content

Home > @rushstack/node-core-library > IJsonSchemaLoadOptions

IJsonSchemaLoadOptions interface

Options for JsonSchema.fromFile() and JsonSchema.fromLoadedObject()

Signature:

export interface IJsonSchemaLoadOptions 

Properties

Property

Modifiers

Type

Description

customFormats?

Record<string, IJsonSchemaCustomFormat<string> | IJsonSchemaCustomFormat<number>>

(Optional) Any custom formats to consider during validation. Some standard formats are supported out-of-the-box (e.g. emails, uris), but additional formats can be defined here. You could for example define generic numeric formats (e.g. uint8) or domain-specific formats.

dependentSchemas?

JsonSchema[]

(Optional) Other schemas that this schema references, e.g. via the "$ref" directive.

rejectVendorExtensionKeywords?

boolean

(BETA) (Optional) If true, the AJV validator will reject JSON Schema vendor extension keywords matching the pattern x-<vendor>-<keyword> as unknown keywords.

schemaVersion?

JsonSchemaVersion

(Optional) The json-schema version to target for validation.