JsonSchemaObject

@tsed/schema

Usage

import { JsonSchemaObject } from "@tsed/schema";

See /packages/specs/schema/src/domain/JsonSchema.ts.

Overview

interface JsonSchemaObject extends Omit<JSONSchema7, "type" | "additionalProperties" | "items" | "pattern"> {
    type?: JSONSchema7["type"] | Type | null | (String | null | Date | Number | Object | Boolean)[];
    additionalProperties?: JsonSchemaObject | boolean | Type | JsonSchema;
    items?: JsonSchemaObject | boolean | Type | JsonSchema | (JsonSchemaObject | Type | JsonSchema)[];
    pattern?: string | RegExp;
    [key: `x-${string}`]: unknown;
}

Description

Extended JSON Schema object supporting TypeScript types and Ts.ED enhancements.

This interface extends the standard JSON Schema 7 specification with additional type flexibility, allowing TypeScript classes and types to be used directly in schema definitions.

type: JSONSchema7["type"] | Type | null |

type?: JSONSchema7["type"] | Type | null | (String | null | Date | Number | Object | Boolean)[];

additionalProperties

additionalProperties?: JsonSchemaObject | boolean | Type | JsonSchema;

items: JsonSchemaObject | boolean | Type | JsonSchema |

items?: JsonSchemaObject | boolean | Type | JsonSchema | (JsonSchemaObject | Type | JsonSchema)[];

pattern

pattern?: string | RegExp;

[key: x-${string}]

[key: `x-${string}`]: unknown;