botbook/node_modules/json-schema-library/dist/lib/draft06/compile/index.d.ts
Rodrigo Rodriguez 6ae15fe3e5 Updated.
2024-09-04 13:13:15 -03:00

16 lines
766 B
TypeScript

import { Draft } from "../../draft";
import { JsonSchema } from "../../types";
/**
* @draft starting with _draft 06_ keyword `id` has been renamed to `$id`
*
* compiles the input root schema for $ref resolution and returns it again
* @attention this modifies input schema but maintains object-structure
*
* for a compiled json-schema you can call getRef on any contained schema (location of type).
* this resolves a $ref target to a valid schema (for a valid $ref)
*
* @param rootSchema root json-schema ($id, defs, ... ) to compile
* @param [force] = false force compile json-schema
* @return compiled json-schema
*/
export default function compileSchema(draft: Draft, schemaToCompile: JsonSchema, rootSchema?: JsonSchema, force?: boolean): JsonSchema;