SchemaValidator
age-schema-client / SchemaValidator
Class: SchemaValidator
Defined in: src/schema/validator.ts:62
Schema validator for validating data against schema definitions
Constructors
Constructor
new SchemaValidator(schema, config): SchemaValidator;
Defined in: src/schema/validator.ts:72
Create a new SchemaValidator
Parameters
| Parameter | Type | Description |
|---|---|---|
schema | SchemaDefinition | Schema definition |
config | SchemaValidatorConfig | Validator configuration |
Returns
SchemaValidator
Methods
validateVertex()
validateVertex(
label,
data,
throwOnError): ValidationResult;
Defined in: src/schema/validator.ts:85
Validate a vertex against the schema
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
label | string | undefined | Vertex label |
data | unknown | undefined | Vertex data |
throwOnError | boolean | true | - |
Returns
ValidationResult
Validation result
Throws
SchemaValidationError if validation fails and throwOnError is true
validateEdge()
validateEdge(
label,
data,
throwOnError): ValidationResult;
Defined in: src/schema/validator.ts:114
Validate an edge against the schema
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
label | string | undefined | Edge label |
data | unknown | undefined | Edge data |
throwOnError | boolean | true | Whether to throw an error if validation fails |
Returns
ValidationResult
Validation result
Throws
SchemaValidationError if validation fails and throwOnError is true
validateVertexAndThrow()
validateVertexAndThrow(label, data): void;
Defined in: src/schema/validator.ts:141
Validate a vertex against the schema and throw an error if validation fails
Parameters
| Parameter | Type | Description |
|---|---|---|
label | string | Vertex label |
data | unknown | Vertex data |
Returns
void
Throws
SchemaValidationError if validation fails
validateEdgeAndThrow()
validateEdgeAndThrow(label, data): void;
Defined in: src/schema/validator.ts:156
Validate an edge against the schema and throw an error if validation fails
Parameters
| Parameter | Type | Description |
|---|---|---|
label | string | Edge label |
data | unknown | Edge data |
Returns
void
Throws
SchemaValidationError if validation fails
validateProperty()
validateProperty(
property,
definition,
value,
throwOnError): ValidationResult;
Defined in: src/schema/validator.ts:174
Validate a property value against a property definition
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
property | string | undefined | Property name |
definition | PropertyDefinition | undefined | Property definition |
value | unknown | undefined | Property value |
throwOnError | boolean | true | Whether to throw an error if validation fails |
Returns
ValidationResult
Validation result
Throws
SchemaValidationError if validation fails and throwOnError is true
validatePropertyAndThrow()
validatePropertyAndThrow(
property,
definition,
value): void;
Defined in: src/schema/validator.ts:207
Validate a property value against a property definition and throw an error if validation fails
Parameters
| Parameter | Type | Description |
|---|---|---|
property | string | Property name |
definition | PropertyDefinition | Property definition |
value | unknown | Property value |
Returns
void
Throws
SchemaValidationError if validation fails