Interface JSONSchemaOptions

interface JSONSchemaOptions {
    basePath?: string;
    definitions?: Dict<AnyShape>;
    definitionsKey?: string;
    dialect?: string;
    unusedDefinitions?: boolean;
}

Properties

basePath? definitions? definitionsKey? dialect? unusedDefinitions?

Properties

OptionalbasePath

basePath?: string

The schema base path.

Default

"#"

Optionaldefinitions

definitions?: Dict<AnyShape>

The mapping from the definition name to a shape that is converted to the JSON schema.

OptionaldefinitionsKey

definitionsKey?: string

The key under which the definitions are stored.

Default

"definitions"

Optionaldialect

dialect?: string

The schema dialect placed in JSONSchema.$schema.

Default

"https://json-schema.org/draft/2020-12/schema"

OptionalunusedDefinitions

unusedDefinitions?: boolean

If true then definitions from definitions that aren't referenced, are still rendered under definitionsKey. Otherwise, those definitions aren't rendered.

Settings

Member Visibility

On This Page

Properties