fluent-json-schema

## Functions <dl> <dt><a href="#ArraySchema">ArraySchema([options])</a> ⇒ <code><a href="#ArraySchema">ArraySchema</a></code></dt> <dd>Represents a ArraySchema. </dd> <dt><a href="#items">items(items)</a> ⇒ <code>FluentSchema</code></dt> <dd>This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself. If "items" is a schema, validation succeeds if all elements in the array successfully validate against that schema. If "items" is an array of schemas, validation succeeds if each element of the instance validates against the schema at the same position, if any. Omitting this keyword has the same behavior as an empty schema. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.1">reference</a> </dd> <dt><a href="#additionalItems">additionalItems(items)</a> ⇒ <code>FluentSchema</code></dt> <dd>This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.2">reference</a> </dd> <dt><a href="#contains">contains(value)</a> ⇒ <code>FluentSchema</code></dt> <dd>An array instance is valid against "contains" if at least one of its elements is valid against the given schema. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.6">reference</a> </dd> <dt><a href="#uniqueItems">uniqueItems(boolean)</a> ⇒ <code>FluentSchema</code></dt> <dd>If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique. Omitting this keyword has the same behavior as a value of false. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.5">reference</a> </dd> <dt><a href="#minItems">minItems(min)</a> ⇒ <code>FluentSchema</code></dt> <dd>An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. Omitting this keyword has the same behavior as a value of 0. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.4">reference</a> </dd> <dt><a href="#maxItems">maxItems(max)</a> ⇒ <code>FluentSchema</code></dt> <dd>An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. Omitting this keyword has the same behavior as a value of 0. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.3">reference</a> </dd> <dt><a href="#BaseSchema">BaseSchema([options])</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>Represents a BaseSchema. </dd> <dt><a href="#id">id(id)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>It defines a URI for the schema, and the base URI that other URI references within the schema are resolved against. <a href="https://tools.ietf.org/html/draft-handrews-json-schema-01#section-8.2">reference</a> </dd> <dt><a href="#title">title(title)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>It can be used to decorate a user interface with information about the data produced by this user interface. A title will preferably be short. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.1">reference</a> </dd> <dt><a href="#description">description(description)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>It can be used to decorate a user interface with information about the data produced by this user interface. A description provides explanation about the purpose of the instance described by the schema. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.1">reference</a> </dd> <dt><a href="#examples">examples(examples)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>The value of this keyword MUST be an array. There are no restrictions placed on the values within the array. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.4">reference</a> </dd> <dt><a href="#ref">ref(ref)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>The value must be a valid id e.g. #properties/foo </dd> <dt><a href="#enum">enum(values)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>The value of this keyword MUST be an array. This array SHOULD have at least one element. Elements in the array SHOULD be unique. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.1.2">reference</a> </dd> <dt><a href="#const">const(value)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>The value of this keyword MAY be of any type, including null. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.1.3">reference</a> </dd> <dt><a href="#default">default(defaults)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>There are no restrictions placed on the value of this keyword. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.2">reference</a> </dd> <dt><a href="#readOnly">readOnly(isReadOnly)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>The value of readOnly can be left empty to indicate the property is readOnly. It takes an optional boolean which can be used to explicitly set readOnly true/false. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.3">reference</a> </dd> <dt><a href="#writeOnly">writeOnly(isWriteOnly)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>The value of writeOnly can be left empty to indicate the property is writeOnly. It takes an optional boolean which can be used to explicitly set writeOnly true/false. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.3">reference</a> </dd> <dt><a href="#deprecated">deprecated(isDeprecated)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>The value of deprecated can be left empty to indicate the property is deprecated. It takes an optional boolean which can be used to explicitly set deprecated true/false. <a href="https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.9.3">reference</a> </dd> <dt><a href="#required">required()</a> ⇒ <code>FluentSchema</code></dt> <dd>Required has to be chained to a property: Examples: <ul> <li>S.prop('prop').required()</li> <li>S.prop('prop', S.number()).required()</li> <li>S.required(['foo', 'bar'])</li> </ul> <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.3">reference</a> </dd> <dt><a href="#not">not(not)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>This keyword's value MUST be a valid JSON Schema. An instance is valid against this keyword if it fails to validate successfully against the schema defined by this keyword. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.7.4">reference</a> </dd> <dt><a href="#anyOf">anyOf(schemas)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>It MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.7.2">reference</a> </dd> <dt><a href="#allOf">allOf(schemas)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>It MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.7.1">reference</a> </dd> <dt><a href="#oneOf">oneOf(schemas)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>It MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.7.3">reference</a> </dd> <dt><a href="#ifThen">ifThen(ifClause, thenClause)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>This validation outcome of this keyword's subschema has no direct effect on the overall validation result. Rather, it controls which of the "then" or "else" keywords are evaluated. When "if" is present, and the instance successfully validates against its subschema, then validation succeeds against this keyword if the instance also successfully validates against this keyword's subschema. </dd> <dt><a href="#ifThenElse">ifThenElse(ifClause, thenClause, elseClause)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>When "if" is present, and the instance fails to validate against its subschema, then validation succeeds against this keyword if the instance successfully validates against this keyword's subschema. </dd> <dt><a href="#raw">raw(fragment)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>Because the differences between JSON Schemas and Open API (Swagger) it can be handy to arbitrary modify the schema injecting a fragment <ul> <li>Examples:</li> </ul> <ul> <li>S.number().raw({ nullable:true })</li> <li>S.string().format('date').raw({ formatMaximum: '2020-01-01' })</li> </ul> </dd> <dt><a href="#valueOf">valueOf([options])</a> ⇒ <code><a href="#object">object</a></code></dt> <dd>It returns all the schema values </dd> <dt><a href="#BooleanSchema">BooleanSchema([options])</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>Represents a BooleanSchema. </dd> <dt><a href="#S">S([options])</a> ⇒ <code><a href="#S">S</a></code></dt> <dd>Represents a S. </dd> <dt><a href="#string">string()</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>Set a property to type string <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.3">reference</a> </dd> <dt><a href="#number">number()</a> ⇒ <code><a href="#NumberSchema">NumberSchema</a></code></dt> <dd>Set a property to type number <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#numeric">reference</a> </dd> <dt><a href="#integer">integer()</a> ⇒ <code><a href="#IntegerSchema">IntegerSchema</a></code></dt> <dd>Set a property to type integer <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#numeric">reference</a> </dd> <dt><a href="#boolean">boolean()</a> ⇒ <code><a href="#BooleanSchema">BooleanSchema</a></code></dt> <dd>Set a property to type boolean <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.7">reference</a> </dd> <dt><a href="#array">array()</a> ⇒ <code><a href="#ArraySchema">ArraySchema</a></code></dt> <dd>Set a property to type array <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4">reference</a> </dd> <dt><a href="#object">object()</a> ⇒ <code><a href="#ObjectSchema">ObjectSchema</a></code></dt> <dd>Set a property to type object <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5">reference</a> </dd> <dt><a href="#null">null()</a> ⇒ <code><a href="#NullSchema">NullSchema</a></code></dt> <dd>Set a property to type null <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#general">reference</a> </dd> <dt><a href="#mixed">mixed(types)</a> ⇒ <code><a href="#MixedSchema">MixedSchema</a></code></dt> <dd>A mixed schema is the union of multiple types (e.g. ['string', 'integer'] </dd> <dt><a href="#raw">raw(fragment)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt> <dd>Because the differences between JSON Schemas and Open API (Swagger) it can be handy to arbitrary modify the schema injecting a fragment <ul> <li>Examples:</li> </ul> <ul> <li>S.raw({ nullable:true, format: 'date', formatMaximum: '2020-01-01' })</li> <li>S.string().format('date').raw({ formatMaximum: '2020-01-01' })</li> </ul> </dd> <dt><a href="#IntegerSchema">IntegerSchema([options])</a> ⇒ <code><a href="#NumberSchema">NumberSchema</a></code></dt> <dd>Represents a NumberSchema. </dd> <dt><a href="#MixedSchema">MixedSchema([options])</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>Represents a MixedSchema. </dd> <dt><a href="#NullSchema">NullSchema([options])</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>Represents a NullSchema. </dd> <dt><a href="#null">null()</a> ⇒ <code>FluentSchema</code></dt> <dd>Set a property to type null <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.1.1">reference</a> </dd> <dt><a href="#NumberSchema">NumberSchema([options])</a> ⇒ <code><a href="#NumberSchema">NumberSchema</a></code></dt> <dd>Represents a NumberSchema. </dd> <dt><a href="#minimum">minimum(min)</a> ⇒ <code>FluentSchema</code></dt> <dd>It represents an inclusive lower limit for a numeric instance. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.2.4">reference</a> </dd> <dt><a href="#exclusiveMinimum">exclusiveMinimum(min)</a> ⇒ <code>FluentSchema</code></dt> <dd>It represents an exclusive lower limit for a numeric instance. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.2.5">reference</a> </dd> <dt><a href="#maximum">maximum(max)</a> ⇒ <code>FluentSchema</code></dt> <dd>It represents an inclusive upper limit for a numeric instance. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.2.2">reference</a> </dd> <dt><a href="#exclusiveMaximum">exclusiveMaximum(max)</a> ⇒ <code>FluentSchema</code></dt> <dd>It represents an exclusive upper limit for a numeric instance. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.2.3">reference</a> </dd> <dt><a href="#multipleOf">multipleOf(multiple)</a> ⇒ <code>FluentSchema</code></dt> <dd>It's strictly greater than 0. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.2.1">reference</a> </dd> <dt><a href="#ObjectSchema">ObjectSchema([options])</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>Represents a ObjectSchema. </dd> <dt><a href="#id">id(id)</a></dt> <dd>It defines a URI for the schema, and the base URI that other URI references within the schema are resolved against. Calling <code>id</code> on an ObjectSchema will alway set the id on the root of the object rather than in its "properties", which differs from other schema types. <a href="https://tools.ietf.org/html/draft-handrews-json-schema-01#section-8.2">reference</a> </dd> <dt><a href="#additionalProperties">additionalProperties(value)</a> ⇒ <code>FluentSchema</code></dt> <dd>This keyword determines how child instances validate for objects, and does not directly validate the immediate instance itself. Validation with "additionalProperties" applies only to the child values of instance names that do not match any names in "properties", and do not match any regular expression in "patternProperties". For all such properties, validation succeeds if the child instance validates against the "additionalProperties" schema. Omitting this keyword has the same behavior as an empty schema. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.6">reference</a> </dd> <dt><a href="#maxProperties">maxProperties(max)</a> ⇒ <code>FluentSchema</code></dt> <dd>An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.1">reference</a> </dd> <dt><a href="#minProperties">minProperties(min)</a> ⇒ <code>FluentSchema</code></dt> <dd>An object instance is valid against "minProperties" if its number of properties is greater than, or equal to, the value of this keyword. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.2">reference</a> </dd> <dt><a href="#patternProperties">patternProperties(opts)</a> ⇒ <code>FluentSchema</code></dt> <dd>Each property name of this object SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect. Each property value of this object MUST be a valid JSON Schema. This keyword determines how child instances validate for objects, and does not directly validate the immediate instance itself. Validation of the primitive instance type against this keyword always succeeds. Validation succeeds if, for each instance name that matches any regular expressions that appear as a property name in this keyword's value, the child instance for that name successfully validates against each schema that corresponds to a matching regular expression. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.5">reference</a> </dd> <dt><a href="#dependencies">dependencies(opts)</a> ⇒ <code>FluentSchema</code></dt> <dd>This keyword specifies rules that are evaluated if the instance is an object and contains a certain property. This keyword's value MUST be an object. Each property specifies a dependency. Each dependency value MUST be an array or a valid JSON Schema. If the dependency value is a subschema, and the dependency key is a property in the instance, the entire instance must validate against the dependency value. If the dependency value is an array, each element in the array, if any, MUST be a string, and MUST be unique. If the dependency key is a property in the instance, each of the items in the dependency value must be a property that exists in the instance. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.7">reference</a> </dd> <dt><a href="#dependentRequired">dependentRequired(opts)</a> ⇒ <code>FluentSchema</code></dt> <dd>The value of "properties" MUST be an object. Each dependency value MUST be an array. Each element in the array MUST be a string and MUST be unique. If the dependency key is a property in the instance, each of the items in the dependency value must be a property that exists in the instance. <a href="https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.6.5.4">reference</a> </dd> <dt><a href="#dependentSchemas">dependentSchemas(opts)</a> ⇒ <code>FluentSchema</code></dt> <dd>The value of "properties" MUST be an object. The dependency value MUST be a valid JSON Schema. Each dependency key is a property in the instance and the entire instance must validate against the dependency value. <a href="https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.9.2.2.4">reference</a> </dd> <dt><a href="#propertyNames">propertyNames(value)</a> ⇒ <code>FluentSchema</code></dt> <dd>If the instance is an object, this keyword validates if every property name in the instance validates against the provided schema. Note the property name that the schema is testing will always be a string. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.8">reference</a> </dd> <dt><a href="#prop">prop(name, props)</a> ⇒ <code>FluentSchema</code></dt> <dd>The value of "properties" MUST be an object. Each value of this object MUST be a valid JSON Schema. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.4">reference</a> </dd> <dt><a href="#only">only(properties)</a> ⇒ <code><a href="#ObjectSchema">ObjectSchema</a></code></dt> <dd>Returns an object schema with only a subset of keys provided. If called on an ObjectSchema with an <code>$id</code>, it will be removed and the return value will be considered a new schema. </dd> <dt><a href="#without">without(properties)</a> ⇒ <code><a href="#ObjectSchema">ObjectSchema</a></code></dt> <dd>Returns an object schema without a subset of keys provided. If called on an ObjectSchema with an <code>$id</code>, it will be removed and the return value will be considered a new schema. </dd> <dt><a href="#definition">definition(name, props)</a> ⇒ <code>FluentSchema</code></dt> <dd>The "definitions" keywords provides a standardized location for schema authors to inline re-usable JSON Schemas into a more general schema. There are no restrictions placed on the values within the array. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.9">reference</a> </dd> <dt><a href="#RawSchema">RawSchema(schema)</a> ⇒ <code>FluentSchema</code></dt> <dd>Represents a raw JSON Schema that will be parsed </dd> <dt><a href="#StringSchema">StringSchema([options])</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>Represents a StringSchema. </dd> <dt><a href="#minLength">minLength(min)</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. The length of a string instance is defined as the number of its characters as defined by RFC 7159 [RFC7159]. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.3.2">reference</a> </dd> <dt><a href="#maxLength">maxLength(max)</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. The length of a string instance is defined as the number of its characters as defined by RFC 7159 [RFC7159]. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.3.1">reference</a> </dd> <dt><a href="#format">format(format)</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>A string value can be RELATIVE_JSON_POINTER, JSON_POINTER, UUID, REGEX, IPV6, IPV4, HOSTNAME, EMAIL, URL, URI_TEMPLATE, URI_REFERENCE, URI, TIME, DATE, <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.7.3">reference</a> </dd> <dt><a href="#pattern">pattern(pattern)</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect. A string instance is considered valid if the regular expression matches the instance successfully. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.3.3">reference</a> </dd> <dt><a href="#contentEncoding">contentEncoding(encoding)</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>If the instance value is a string, this property defines that the string SHOULD be interpreted as binary data and decoded using the encoding named by this property. RFC 2045, Sec 6.1 [RFC2045] lists the possible values for this property. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.8.3">reference</a> </dd> <dt><a href="#contentMediaType">contentMediaType(mediaType)</a> ⇒ <code><a href="#StringSchema">StringSchema</a></code></dt> <dd>The value of this property must be a media type, as defined by RFC 2046 [RFC2046]. This property defines the media type of instances which this schema defines. <a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.8.4">reference</a> </dd> </dl> <a name="ArraySchema"></a> ## ArraySchema([options]) ⇒ [<code>ArraySchema</code>](#ArraySchema) Represents a ArraySchema. **Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | <code>Object</code> | | Options | | [options.schema] | [<code>StringSchema</code>](#StringSchema) | | Default schema | | [options.generateIds] | [<code>boolean</code>](#boolean) | <code>false</code> | generate the id automatically e.g. #properties.foo | <a name="items"></a> ## items(items) ⇒ <code>FluentSchema</code> This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself. If "items" is a schema, validation succeeds if all elements in the array successfully validate against that schema. If "items" is an array of schemas, validation succeeds if each element of the instance validates against the schema at the same position, if any. Omitting this keyword has the same behavior as an empty schema. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.1) **Kind**: global function | Param | Type | | --- | --- | | items | <code>FluentSchema</code> \| <code>Array.<FluentSchema></code> | <a name="additionalItems"></a> ## additionalItems(items) ⇒ <code>FluentSchema</code> This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.2) **Kind**: global function | Param | Type | | --- | --- | | items | <code>FluentSchema</code> \| [<code>boolean</code>](#boolean) | <a name="contains"></a> ## contains(value) ⇒ <code>FluentSchema</code> An array instance is valid against "contains" if at least one of its elements is valid against the given schema. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.6) **Kind**: global function | Param | Type | | --- | --- | | value | <code>FluentSchema</code> | <a name="uniqueItems"></a> ## uniqueItems(boolean) ⇒ <code>FluentSchema</code> If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique. Omitting this keyword has the same behavior as a value of false. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.5) **Kind**: global function | Param | Type | | --- | --- | | boolean | [<code>boolean</code>](#boolean) | <a name="minItems"></a> ## minItems(min) ⇒ <code>FluentSchema</code> An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. Omitting this keyword has the same behavior as a value of 0. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.4) **Kind**: global function | Param | Type | | --- | --- | | min | [<code>number</code>](#number) | <a name="maxItems"></a> ## maxItems(max) ⇒ <code>FluentSchema</code> An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. Omitting this keyword has the same behavior as a value of 0. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.3) **Kind**: global function | Param | Type | | --- | --- | | max | [<code>number</code>](#number) | <a name="BaseSchema"></a> ## BaseSchema([options]) ⇒ [<code>BaseSchema</code>](#BaseSchema) Represents a BaseSchema. **Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | <code>Object</code> | | Options | | [options.schema] | [<code>BaseSchema</code>](#BaseSchema) | | Default schema | | [options.generateIds] | [<code>boolean</code>](#boolean) | <code>false</code> | generate the id automatically e.g. #properties.foo | <a name="id"></a> ## id(id) ⇒ [<code>BaseSchema</code>](#BaseSchema) It defines a URI for the schema, and the base URI that other URI references within the schema are resolved against. [reference](https://tools.ietf.org/html/draft-handrews-json-schema-01#section-8.2) **Kind**: global function | Param | Type | Description | | --- | --- | --- | | id | [<code>string</code>](#string) | an #id | <a name="title"></a> ## title(title) ⇒ [<code>BaseSchema</code>](#BaseSchema) It can be used to decorate a user interface with information about the data produced by this user interface. A title will preferably be short. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.1) **Kind**: global function | Param | Type | | --- | --- | | title | [<code>string</code>](#string) | <a name="description"></a> ## description(description) ⇒ [<code>BaseSchema</code>](#BaseSchema) It can be used to decorate a user interface with information about the data produced by this user interface. A description provides explanation about the purpose of the instance described by the schema. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.1) **Kind**: global function | Param | Type | | --- | --- | | description | [<code>string</code>](#string) | <a name="examples"></a> ## examples(examples) ⇒ [<code>BaseSchema</code>](#BaseSchema) The value of this keyword MUST be an array. There are no restrictions placed on the values within the array. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.4) **Kind**: global function | Param | Type | | --- | --- | | examples | [<code>string</code>](#string) | <a name="ref"></a> ## ref(ref) ⇒ [<code>BaseSchema</code>](#BaseSchema) The value must be a valid id e.g. #properties/foo **Kind**: global function | Param | Type | | --- | --- | | ref | [<code>string</code>](#string) | <a name="enum"></a> ## enum(values) ⇒ [<code>BaseSchema</code>](#BaseSchema) The value of this keyword MUST be an array. This array SHOULD have at least one element. Elements in the array SHOULD be unique. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.1.2) **Kind**: global function | Param | Type | | --- | --- | | values | [<code>array</code>](#array) | <a name="const"></a> ## const(value) ⇒ [<code>BaseSchema</code>](#BaseSchema) The value of this keyword MAY be of any type, including null. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.1.3) **Kind**: global function | Param | | --- | | value | <a name="default"></a> ## default(defaults) ⇒ [<code>BaseSchema</code>](#BaseSchema) There are no restrictions placed on the value of this keyword. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.2) **Kind**: global function | Param | | --- | | defaults | <a name="readOnly"></a> ## readOnly(isReadOnly) ⇒ [<code>BaseSchema</code>](#BaseSchema) The value of readOnly can be left empty to indicate the property is readOnly. It takes an optional boolean which can be used to explicitly set readOnly true/false. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.3) **Kind**: global function | Param | Type | | --- | --- | | isReadOnly | [<code>boolean</code>](#boolean) \| <code>undefined</code> | <a name="writeOnly"></a> ## writeOnly(isWriteOnly) ⇒ [<code>BaseSchema</code>](#BaseSchema) The value of writeOnly can be left empty to indicate the property is writeOnly. It takes an optional boolean which can be used to explicitly set writeOnly true/false. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.3) **Kind**: global function | Param | Type | | --- | --- | | isWriteOnly | [<code>boolean</code>](#boolean) \| <code>undefined</code> | <a name="deprecated"></a> ## deprecated(isDeprecated) ⇒ [<code>BaseSchema</code>](#BaseSchema) The value of deprecated can be left empty to indicate the property is deprecated. It takes an optional boolean which can be used to explicitly set deprecated true/false. [reference](https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.9.3) **Kind**: global function | Param | Type | | --- | --- | | isDeprecated | <code>Boolean</code> | <a name="required"></a> ## required() ⇒ <code>FluentSchema</code> Required has to be chained to a property: Examples: - S.prop('prop').required() - S.prop('prop', S.number()).required() - S.required(['foo', 'bar']) [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.3) **Kind**: global function <a name="not"></a> ## not(not) ⇒ [<code>BaseSchema</code>](#BaseSchema) This keyword's value MUST be a valid JSON Schema. An instance is valid against this keyword if it fails to validate successfully against the schema defined by this keyword. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.7.4) **Kind**: global function | Param | Type | | --- | --- | | not | <code>FluentSchema</code> | <a name="anyOf"></a> ## anyOf(schemas) ⇒ [<code>BaseSchema</code>](#BaseSchema) It MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.7.2) **Kind**: global function | Param | Type | | --- | --- | | schemas | [<code>array</code>](#array) | <a name="allOf"></a> ## allOf(schemas) ⇒ [<code>BaseSchema</code>](#BaseSchema) It MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.7.1) **Kind**: global function | Param | Type | | --- | --- | | schemas | [<code>array</code>](#array) | <a name="oneOf"></a> ## oneOf(schemas) ⇒ [<code>BaseSchema</code>](#BaseSchema) It MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.7.3) **Kind**: global function | Param | Type | | --- | --- | | schemas | [<code>array</code>](#array) | <a name="ifThen"></a> ## ifThen(ifClause, thenClause) ⇒ [<code>BaseSchema</code>](#BaseSchema) This validation outcome of this keyword's subschema has no direct effect on the overall validation result. Rather, it controls which of the "then" or "else" keywords are evaluated. When "if" is present, and the instance successfully validates against its subschema, then validation succeeds against this keyword if the instance also successfully validates against this keyword's subschema. **Kind**: global function | Param | Type | Description | | --- | --- | --- | | ifClause | [<code>BaseSchema</code>](#BaseSchema) | [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.6.1) | | thenClause | [<code>BaseSchema</code>](#BaseSchema) | [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.6.2) | <a name="ifThenElse"></a> ## ifThenElse(ifClause, thenClause, elseClause) ⇒ [<code>BaseSchema</code>](#BaseSchema) When "if" is present, and the instance fails to validate against its subschema, then validation succeeds against this keyword if the instance successfully validates against this keyword's subschema. **Kind**: global function | Param | Type | Description | | --- | --- | --- | | ifClause | [<code>BaseSchema</code>](#BaseSchema) | [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.6.1) | | thenClause | [<code>BaseSchema</code>](#BaseSchema) | [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.6.2) | | elseClause | [<code>BaseSchema</code>](#BaseSchema) | [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.6.3) | <a name="raw"></a> ## raw(fragment) ⇒ [<code>BaseSchema</code>](#BaseSchema) Because the differences between JSON Schemas and Open API (Swagger) it can be handy to arbitrary modify the schema injecting a fragment * Examples: - S.number().raw({ nullable:true }) - S.string().format('date').raw({ formatMaximum: '2020-01-01' }) **Kind**: global function | Param | Type | Description | | --- | --- | --- | | fragment | [<code>string</code>](#string) | an arbitrary JSON Schema to inject [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.3.3) | <a name="valueOf"></a> ## valueOf([options]) ⇒ [<code>object</code>](#object) It returns all the schema values **Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | <code>Object</code> | | Options | | [options.isRoot] | [<code>boolean</code>](#boolean) | <code>true</code> | Is a root level schema | <a name="BooleanSchema"></a> ## BooleanSchema([options]) ⇒ [<code>StringSchema</code>](#StringSchema) Represents a BooleanSchema. **Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | <code>Object</code> | | Options | | [options.schema] | [<code>StringSchema</code>](#StringSchema) | | Default schema | | [options.generateIds] | [<code>boolean</code>](#boolean) | <code>false</code> | generate the id automatically e.g. #properties.foo | <a name="S"></a> ## S([options]) ⇒ [<code>S</code>](#S) Represents a S. **Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | <code>Object</code> | | Options | | [options.schema] | [<code>S</code>](#S) | | Default schema | | [options.generateIds] | [<code>boolean</code>](#boolean) | <code>false</code> | generate the id automatically e.g. #properties.foo | <a name="string"></a> ## string() ⇒ [<code>StringSchema</code>](#StringSchema) Set a property to type string [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.3) **Kind**: global function <a name="number"></a> ## number() ⇒ [<code>NumberSchema</code>](#NumberSchema) Set a property to type number [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#numeric) **Kind**: global function <a name="integer"></a> ## integer() ⇒ [<code>IntegerSchema</code>](#IntegerSchema) Set a property to type integer [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#numeric) **Kind**: global function <a name="boolean"></a> ## boolean() ⇒ [<code>BooleanSchema</code>](#BooleanSchema) Set a property to type boolean [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.7) **Kind**: global function <a name="array"></a> ## array() ⇒ [<code>ArraySchema</code>](#ArraySchema) Set a property to type array [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4) **Kind**: global function <a name="object"></a> ## object() ⇒ [<code>ObjectSchema</code>](#ObjectSchema) Set a property to type object [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5) **Kind**: global function <a name="null"></a> ## null() ⇒ [<code>NullSchema</code>](#NullSchema) Set a property to type null [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#general) **Kind**: global function <a name="mixed"></a> ## mixed(types) ⇒ [<code>MixedSchema</code>](#MixedSchema) A mixed schema is the union of multiple types (e.g. ['string', 'integer'] **Kind**: global function | Param | Type | | --- | --- | | types | [<code>Array.<string></code>](#string) | <a name="raw"></a> ## raw(fragment) ⇒ [<code>BaseSchema</code>](#BaseSchema) Because the differences between JSON Schemas and Open API (Swagger) it can be handy to arbitrary modify the schema injecting a fragment * Examples: - S.raw({ nullable:true, format: 'date', formatMaximum: '2020-01-01' }) - S.string().format('date').raw({ formatMaximum: '2020-01-01' }) **Kind**: global function | Param | Type | Description | | --- | --- | --- | | fragment | [<code>string</code>](#string) | an arbitrary JSON Schema to inject | <a name="IntegerSchema"></a> ## IntegerSchema([options]) ⇒ [<code>NumberSchema</code>](#NumberSchema) Represents a NumberSchema. **Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | <code>Object</code> | | Options | | [options.schema] | [<code>NumberSchema</code>](#NumberSchema) | | Default schema | | [options.generateIds] | [<code>boolean</code>](#boolean) | <code>false</code> | generate the id automatically e.g. #properties.foo | <a name="MixedSchema"></a> ## MixedSchema([options]) ⇒ [<code>StringSchema</code>](#StringSchema) Represents a MixedSchema. **Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | <code>Object</code> | | Options | | [options.schema] | [<code>MixedSchema</code>](#MixedSchema) | | Default schema | | [options.generateIds] | [<code>boolean</code>](#boolean) | <code>false</code> | generate the id automatically e.g. #properties.foo | <a name="NullSchema"></a> ## NullSchema([options]) ⇒ [<code>StringSchema</code>](#StringSchema) Represents a NullSchema. **Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | <code>Object</code> | | Options | | [options.schema] | [<code>StringSchema</code>](#StringSchema) | | Default schema | | [options.generateIds] | [<code>boolean</code>](#boolean) | <code>false</code> | generate the id automatically e.g. #properties.foo | <a name="null"></a> ## null() ⇒ <code>FluentSchema</code> Set a property to type null [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.1.1) **Kind**: global function <a name="NumberSchema"></a> ## NumberSchema([options]) ⇒ [<code>NumberSchema</code>](#NumberSchema) Represents a NumberSchema. **Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | <code>Object</code> | | Options | | [options.schema] | [<code>NumberSchema</code>](#NumberSchema) | | Default schema | | [options.generateIds] | [<code>boolean</code>](#boolean) | <code>false</code> | generate the id automatically e.g. #properties.foo | <a name="minimum"></a> ## minimum(min) ⇒ <code>FluentSchema</code> It represents an inclusive lower limit for a numeric instance. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.2.4) **Kind**: global function | Param | Type | | --- | --- | | min | [<code>number</code>](#number) | <a name="exclusiveMinimum"></a> ## exclusiveMinimum(min) ⇒ <code>FluentSchema</code> It represents an exclusive lower limit for a numeric instance. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.2.5) **Kind**: global function | Param | Type | | --- | --- | | min | [<code>number</code>](#number) | <a name="maximum"></a> ## maximum(max) ⇒ <code>FluentSchema</code> It represents an inclusive upper limit for a numeric instance. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.2.2) **Kind**: global function | Param | Type | | --- | --- | | max | [<code>number</code>](#number) | <a name="exclusiveMaximum"></a> ## exclusiveMaximum(max) ⇒ <code>FluentSchema</code> It represents an exclusive upper limit for a numeric instance. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.2.3) **Kind**: global function | Param | Type | | --- | --- | | max | [<code>number</code>](#number) | <a name="multipleOf"></a> ## multipleOf(multiple) ⇒ <code>FluentSchema</code> It's strictly greater than 0. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.2.1) **Kind**: global function | Param | Type | | --- | --- | | multiple | [<code>number</code>](#number) | <a name="ObjectSchema"></a> ## ObjectSchema([options]) ⇒ [<code>StringSchema</code>](#StringSchema) Represents a ObjectSchema. **Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | <code>Object</code> | | Options | | [options.schema] | [<code>StringSchema</code>](#StringSchema) | | Default schema | | [options.generateIds] | [<code>boolean</code>](#boolean) | <code>false</code> | generate the id automatically e.g. #properties.foo | <a name="id"></a> ## id(id) It defines a URI for the schema, and the base URI that other URI references within the schema are resolved against. Calling `id` on an ObjectSchema will alway set the id on the root of the object rather than in its "properties", which differs from other schema types. [reference](https://tools.ietf.org/html/draft-handrews-json-schema-01#section-8.2) **Kind**: global function | Param | Type | Description | | --- | --- | --- | | id | [<code>string</code>](#string) | an #id | <a name="additionalProperties"></a> ## additionalProperties(value) ⇒ <code>FluentSchema</code> This keyword determines how child instances validate for objects, and does not directly validate the immediate instance itself. Validation with "additionalProperties" applies only to the child values of instance names that do not match any names in "properties", and do not match any regular expression in "patternProperties". For all such properties, validation succeeds if the child instance validates against the "additionalProperties" schema. Omitting this keyword has the same behavior as an empty schema. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.6) **Kind**: global function | Param | Type | | --- | --- | | value | <code>FluentSchema</code> \| [<code>boolean</code>](#boolean) | <a name="maxProperties"></a> ## maxProperties(max) ⇒ <code>FluentSchema</code> An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.1) **Kind**: global function | Param | Type | | --- | --- | | max | [<code>number</code>](#number) | <a name="minProperties"></a> ## minProperties(min) ⇒ <code>FluentSchema</code> An object instance is valid against "minProperties" if its number of properties is greater than, or equal to, the value of this keyword. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.2) **Kind**: global function | Param | Type | | --- | --- | | min | [<code>number</code>](#number) | <a name="patternProperties"></a> ## patternProperties(opts) ⇒ <code>FluentSchema</code> Each property name of this object SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect. Each property value of this object MUST be a valid JSON Schema. This keyword determines how child instances validate for objects, and does not directly validate the immediate instance itself. Validation of the primitive instance type against this keyword always succeeds. Validation succeeds if, for each instance name that matches any regular expressions that appear as a property name in this keyword's value, the child instance for that name successfully validates against each schema that corresponds to a matching regular expression. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.5) **Kind**: global function | Param | Type | | --- | --- | | opts | [<code>object</code>](#object) | <a name="dependencies"></a> ## dependencies(opts) ⇒ <code>FluentSchema</code> This keyword specifies rules that are evaluated if the instance is an object and contains a certain property. This keyword's value MUST be an object. Each property specifies a dependency. Each dependency value MUST be an array or a valid JSON Schema. If the dependency value is a subschema, and the dependency key is a property in the instance, the entire instance must validate against the dependency value. If the dependency value is an array, each element in the array, if any, MUST be a string, and MUST be unique. If the dependency key is a property in the instance, each of the items in the dependency value must be a property that exists in the instance. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.7) **Kind**: global function | Param | Type | | --- | --- | | opts | [<code>object</code>](#object) | <a name="dependentRequired"></a> ## dependentRequired(opts) ⇒ <code>FluentSchema</code> The value of "properties" MUST be an object. Each dependency value MUST be an array. Each element in the array MUST be a string and MUST be unique. If the dependency key is a property in the instance, eac