SchemaConverter
Class: SchemaConverter
Defined in: packages/content-mapper/src/schema/converter.ts:93
Converts TypeScript types into JSON Schema draft-07 documents.
One instance may serve many conversions; definitions are reset per
document.
Constructors
Constructor
new SchemaConverter(
options):SchemaConverter
Defined in: packages/content-mapper/src/schema/converter.ts:109
Parameters
options
project, checker and conversion settings
Returns
SchemaConverter
Methods
fromNode()
fromNode(
node):JSONSchema7
Defined in: packages/content-mapper/src/schema/converter.ts:128
Convert the type at a node into a complete schema document.
Mirrors SchemaGenerator.getSchemaFromNodes with a single node, which is
how @webda/compiler always calls it.
Parameters
node
Node
a declaration or type node
Returns
a self-contained draft-07 document
fromType()
fromType(
type,contextNode?):JSONSchema7
Defined in: packages/content-mapper/src/schema/converter.ts:141
Convert a type into a complete schema document.
Mirrors SchemaGenerator.getSchemaFromType.
Parameters
type
Type
the type to convert
contextNode?
Node
resolution context for properties without declarations
Returns
a self-contained draft-07 document