Skip to main content
Version: Next

SchemaParser

age-schema-client v0.5.0


age-schema-client / SchemaParser

Class: SchemaParser

Defined in: src/schema/parser.ts:80

Schema parser for parsing and validating schema definitions

Constructors

Constructor

new SchemaParser(config): SchemaParser;

Defined in: src/schema/parser.ts:88

Create a new SchemaParser

Parameters

ParameterTypeDescription
configSchemaParserConfigParser configuration

Returns

SchemaParser

Methods

parse()

parse(schemaJson): SchemaDefinition;

Defined in: src/schema/parser.ts:100

Parse a JSON schema string

Parameters

ParameterTypeDescription
schemaJsonstringJSON schema string

Returns

SchemaDefinition

Parsed schema definition

Throws

SchemaParseError if parsing fails

Throws

SchemaValidationError if validation fails


parseObject()

parseObject(schema): SchemaDefinition;

Defined in: src/schema/parser.ts:150

Parse a schema object

Parameters

ParameterTypeDescription
schemaunknownSchema object

Returns

SchemaDefinition

Validated schema definition

Throws

SchemaValidationError if validation fails


validate()

validate(schema): void;

Defined in: src/schema/parser.ts:189

Validate a schema object

Parameters

ParameterTypeDescription
schemaunknownSchema object to validate

Returns

void

Throws

SchemaValidationError if validation fails