Global

Members

bool
schema.js, line 1112

Get a new BooleanSchema object.

double
schema.js, line 1097

Get a new NumberSchema object.

int
schema.js, line 1102

Get a new IntegerSchema object.

map
schema.js, line 1132

Get a new MapSchema object.

media
schema.js, line 1137

Get a new MediaSchema object.

null
schema.js, line 1142

Gets the schema for null (a constant).

str
schema.js, line 1107

Get a new StringSchema object.

Methods

arr(schema)
schema.js, line 1092

Parameters:
Name Type Description
schema BaseSchema See ArraySchema#constructor
Returns:
- A new ArraySchema object.

const()
schema.js, line 1127

Get a new const schema.

enum()
schema.js, line 1122

Get a new num.

formatParagraph(p, options) → {String}
schema.js, line 1018

Formats a paragraph into a string.
Parameters:
Name Type Description
p String | Array.<String> the string or array of strings to process
options formatParagraphOptions how to format the string
Returns:
String - formatted string

lock(schemas)
schema.js, line 1159

Lock all schemas in a dictionary (in-place).
Parameters:
Name Type Description
schemas Object.<Schema> a map of schema values
Returns:
- the input map of schema values

nullable()
schema.js, line 1152

Returns a schema which is either null or the specified schema.

obj(object)
schema.js, line 1078

Parameters:
Name Type Description
object Object See ObjectSchema#constructor
Returns:
- A new ObjectSchema object.

optional(schemas)
schema.js, line 1169

Sets all schemas as optional (in-place).
Parameters:
Name Type Description
schemas Object.<Schema> a map of schema values
Returns:
- the input map of schema values

polymorphicObj(object)
schema.js, line 1084

Parameters:
Name Type Description
object Object See ObjectSchema#constructor
Returns:
- A new ObjectSchema object.

ref()
schema.js, line 1117

Get a new RefSchema object.

union()
schema.js, line 1147

Gets a schema which is a union of two or more schemas.

Type Definitions

formatParagraphOptions
schema.js, line 1001

Options to format a paragraph
Properties:
Name Type Description
replaceNewlines String | false if not false, then newlines will be replaced with this character
trim boolean whether to trim whitespace from the start/end (for arrays, each element will be trimmed too)