MultiDocument<D>Like Document, but carries multiple root schemas that share a single definitions pool.
When to use
Use when generating several schemas, such as a request body and a response body, that reference the same set of definitions.
Details
The schemas tuple is non-empty and contains at least one element.
Source effect/JsonSchema.ts:1555 lines
export interface interface MultiDocument<D extends Dialect>Like
Document
, but carries multiple root schemas that share a
single definitions pool.
When to use
Use when generating several schemas, such as a request body
and a response body, that reference the same set of definitions.
Details
The schemas tuple is non-empty and contains at least one element.
MultiDocument<function (type parameter) D in MultiDocument<D extends Dialect>D extends type Dialect =
| "draft-07"
| "draft-2020-12"
| "openapi-3.1"
| "openapi-3.0"
The set of JSON Schema dialects supported by this module.
When to use
Use as the dialect marker for JsonSchema documents when parsing,
converting, or emitting schemas across the supported formats.
Details
Supported values are "draft-07" for JSON Schema Draft-07,
"draft-2020-12" for JSON Schema Draft 2020-12 and the canonical internal
form, "openapi-3.1" for OpenAPI 3.1, and "openapi-3.0" for OpenAPI 3.0.
Dialect> {
readonly MultiDocument<D extends Dialect>.dialect: D extends Dialectdialect: function (type parameter) D in MultiDocument<D extends Dialect>D
readonly MultiDocument<D extends Dialect>.schemas: readonly [JsonSchema, ...Array<JsonSchema>](property) MultiDocument<D extends Dialect>.schemas: {
0: JsonSchema;
length: number;
toString: () => string;
toLocaleString: { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string };
concat: { (...items: Array<ConcatArray<JsonSchema>>): Array<JsonSchema>; (...items: Array<JsonSchema | ConcatArray<JsonSchema>>): Array<JsonSchema> };
join: (separator?: string) => string;
slice: (start?: number, end?: number) => Array<JsonSchema>;
indexOf: (searchElement: JsonSchema, fromIndex?: number) => number;
lastIndexOf: (searchElement: JsonSchema, fromIndex?: number) => number;
every: { (predicate: (value: JsonSchema, index: number, array: ReadonlyArray<JsonSchema>) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: JsonSchema, index: number, array: ReadonlyArray<JsonSchema>) => unknown, thisArg?: …;
some: (predicate: (value: JsonSchema, index: number, array: ReadonlyArray<JsonSchema>) => unknown, thisArg?: any) => boolean;
forEach: (callbackfn: (value: JsonSchema, index: number, array: ReadonlyArray<JsonSchema>) => void, thisArg?: any) => void;
map: (callbackfn: (value: JsonSchema, index: number, array: ReadonlyArray<JsonSchema>) => U, thisArg?: any) => Array<U>;
filter: { (predicate: (value: JsonSchema, index: number, array: ReadonlyArray<JsonSchema>) => value is S, thisArg?: any): Array<S>; (predicate: (value: JsonSchema, index: number, array: ReadonlyArray<JsonSchema>) => unknown, thisArg?: any): Array<…;
reduce: { (callbackfn: (previousValue: JsonSchema, currentValue: JsonSchema, currentIndex: number, array: ReadonlyArray<JsonSchema>) => JsonSchema): JsonSchema; (callbackfn: (previousValue: JsonSchema, currentValue: JsonSchema, currentIndex: numbe…;
reduceRight: { (callbackfn: (previousValue: JsonSchema, currentValue: JsonSchema, currentIndex: number, array: ReadonlyArray<JsonSchema>) => JsonSchema): JsonSchema; (callbackfn: (previousValue: JsonSchema, currentValue: JsonSchema, currentIndex: numbe…;
find: { (predicate: (value: JsonSchema, index: number, obj: ReadonlyArray<JsonSchema>) => value is S, thisArg?: any): S | undefined; (predicate: (value: JsonSchema, index: number, obj: ReadonlyArray<JsonSchema>) => unknown, thisArg?: any): JsonS…;
findIndex: (predicate: (value: JsonSchema, index: number, obj: ReadonlyArray<JsonSchema>) => unknown, thisArg?: any) => number;
entries: () => ArrayIterator<[number, JsonSchema]>;
keys: () => ArrayIterator<number>;
values: () => ArrayIterator<JsonSchema>;
includes: (searchElement: JsonSchema, fromIndex?: number) => boolean;
flatMap: (callback: (this: This, value: JsonSchema, index: number, array: Array<JsonSchema>) => U | ReadonlyArray<U>, thisArg?: This | undefined) => Array<U>;
flat: (this: A, depth?: D | undefined) => Array<FlatArray<A, D>>;
at: (index: number) => JsonSchema | undefined;
findLast: { (predicate: (value: JsonSchema, index: number, array: ReadonlyArray<JsonSchema>) => value is S, thisArg?: any): S | undefined; (predicate: (value: JsonSchema, index: number, array: ReadonlyArray<JsonSchema>) => unknown, thisArg?: any): J…;
findLastIndex: (predicate: (value: JsonSchema, index: number, array: ReadonlyArray<JsonSchema>) => unknown, thisArg?: any) => number;
toReversed: () => Array<JsonSchema>;
toSorted: (compareFn?: ((a: JsonSchema, b: JsonSchema) => number) | undefined) => Array<JsonSchema>;
toSpliced: { (start: number, deleteCount: number, ...items: Array<JsonSchema>): Array<JsonSchema>; (start: number, deleteCount?: number): Array<JsonSchema> };
with: (index: number, value: JsonSchema) => Array<JsonSchema>;
}
interface Array<T>Array<JsonSchema>]
readonly MultiDocument<D extends Dialect>.definitions: Definitionsdefinitions: Definitions
}Referenced by 3 symbols