Members

__isLocked

schema.js, line 84

Indicates whether an object is locked. See lock.

__properties

schema.js, line 79

Stores json schema properties, e.g. type, description, maxLength, etc...

isFluentSchema

schema.js, line 74

For compatibility with fluent-schema. Indicates if an object is a fluent-schema object.

isTodeaSchema

schema.js, line 68

Flag to indicate whether an object is a Todea Schema object.

JSON_SCHEMA_TYPE

schema.js, line 49

The json schema type

MAX_PROP_NAME

schema.js, line 54

The max* property name.

MIN_PROP_NAME

schema.js, line 59

The min* property name.

required

schema.js, line 205

Convenient getter indicates if the schema is required / not optional. See optional.

Methods

__setDefaultProp(name, defaultValue)

schema.js, line 137

If property with name does not exist, the default value is set.

Parameters:

Name	Type	Description
name	String
defaultValue	*

Returns:

- The value associated with name.

__setProp(name, val, optionsopt)

schema.js, line 107

Sets a value in __properties. Throws if object is locked (unless the property is allowed to be overridden), or property with the same name already exists and override is not allowed.

Parameters:

Name	Type	Attributes	Default	Description
name	String			Name of the property
val	*			The value for the property
options	Object	<optional>	{}	Properties Name Type Attributes Default Description allowOverride Boolean <optional> false If true property override is allowed.

__validateRangeProperty(name, val)

schema.js, line 322

Validate input to min/max.

Parameters:

Name	Type	Description
name	String	Property name
val	Integer	A non-negative integer for min/max.

compile(name, compileropt, returnSchemaTooopt) → {function}

schema.js, line 271

Returns a validator function which throws ValidationError if the value it is asked to validate does not match the schema. Locks the current schema.

Parameters:

Name	Type	Attributes	Description
name	string		the name of this schema (to distinguish errors)
compiler	*	<optional>	the ajv or equivalent JSON schema compiler to use
returnSchemaToo	returnSchemaToo	<optional>	whether to return jsonSchema as well as the validator

Returns:

function - call on a value to validate it; throws on error

copy()

schema.js, line 309

Returns:

- A copy of the Todea Schema object. Locked objects become unlocked.

default(d)

schema.js, line 178

Sets a default value for schema. According to JsonSchema, default value is just metadata and does not serve any validation purpose with in JsonSchema. External tools may choose to use this value to setup defaults, and implementations of JsonSchema validator may choose to validate the type of default values, but it's not required. Since when the default is used to populate the json, there will be something downstream that validates the json and catches issues, we omit schema validation for simplicity.

Parameters:

Name	Type	Description
d	*	The default value.

desc(t)

schema.js, line 159

Sets a description.

Parameters:

Name	Type	Description
t	String | Array.<String>	The description of the schema. If an array of strings are passed in, they will be joined by a space to form the description.

examples(es)

schema.js, line 223

Updates schemas examples.

Parameters:

Name	Type	Description
es	Array.<(String|Array.<String>)>	A list of examples. Each example may be a string, or a list of strings. In case of a list of strings, the strings will be joined by a space character and used as one example.

export(visitor)

schema.js, line 243

The visitable in a visitor pattern. Used for exporting schema.

Parameters:

Name	Type	Description
visitor	Exporter	a schema exporter. @see JSONSchemaExporter

getProp(name)

schema.js, line 127

Parameters:

Name	Type	Description
name	String	Name of a property

Returns:

- The value associated with name.

getValidatorAndJSONSchema() → {Object}

schema.js, line 301

See compile.

Returns:

Object - contains jsonSchema and assertValid

jsonSchema()

schema.js, line 254

Returns:

- JSON Schema with the schema version keyword at the root level.

lock()

schema.js, line 92

Locks a Todea Schema object from modifications.

max(val)

schema.js, line 343

Set a max property depending on schema type.

Parameters:

Name	Type	Description
val	Integer	A non-negative integer for min/max.

min(val)

schema.js, line 331

Set a min property depending on schema type.

Parameters:

Name	Type	Description
val	Integer	A non-negative integer for min/max.

optional()

schema.js, line 195

Marks a schema as optional. Schemas are required by default.

readOnly(ropt)

schema.js, line 213

Sets schemas readOnly property.

Parameters:

Name	Type	Attributes	Default	Description
r	Boolean	<optional>	true	If the schema value should be readOnly.

title(t)

schema.js, line 148

Sets a title.

Parameters:

Name	Type	Description
t	String	The title of the schema.

valueOf()

schema.js, line 234

Returns a JSON Schema. It exists for compatibility with fluent-schema.