Module: lib/schema

Classes

ValidationError

Methods

(static) getEnumValues(types, enum_) → {Array.<Object>}

Get the enum's values (inherited values first)

Parameters:
Name Type Description
types Object

The type model
enum_ Object

The enum model
Source:
Returns:

The array of enum value models

Type
Array.<Object>

(static) getReferencedTypes(types, typeName, referencedTypesopt) → {Object}

Get a user type's referenced type model

Parameters:
Name Type Attributes Default Description
types Object

The type model
typeName string

The type name
referencedTypes Object <optional>
 null

Optional map of referenced user type name to user type model
Source:
Returns:

The referenced type model

Type
Object

(static) getStructMembers(types, struct) → {Array.<Object>}

Get the struct's members (inherited members first)

Parameters:
Name Type Description
types Object

The type model
struct Object

The struct model
Source:
Returns:

The array of struct member models

Type
Array.<Object>

(static) validateType(types, typeName, value, memberFqnopt, nullable) → {Object}

Type-validate a value using a user type model. Container values are duplicated since some member types are transformed during validation.

Parameters:
Name Type Attributes Default Description
types Object

The type model
typeName string

The type name
value Object

The value object to validate
memberFqn string <optional>
<nullable>
 null

The fully-qualified member name
Source:
Throws:

ValidationError

Returns:

The validated, transformed value object

Type
Object

(static) validateTypeModel(types) → {Object}

Validate a type model's types object

Parameters:
Name Type Description
types Object

The type model
Source:
Throws:

ValidationError

Returns:

The validated type model

Type
Object