json-schema-typed
Version:
JSONSchema TypeScript definitions.
1,124 lines • 105 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.3.2",
"schemaVersion": 1001,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "json-schema-typed",
"docComment": "",
"name": "json-schema-typed",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "",
"name": "",
"members": [
{
"kind": "Interface",
"canonicalReference": "(JSONSchema:interface)",
"docComment": "/**\n * JSON Schema\n *\n * Documentation corresponds to the work-in-progress draft-07 of JSON Schema.\n *\n * The latest published drafts are: - draft-handrews-json-schema-01 - draft-handrews-json-schema-validation-01\n *\n * For more information, visit: http://json-schema.org/.\n *\n * Draft date: March 19, 2018.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "JSONSchema",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "$comment",
"docComment": "/**\n * This keyword is reserved for comments from schema authors to readers or maintainers of the schema. The value of this keyword MUST be a string. Implementations MUST NOT present this string to end users. Tools for editing schemas SHOULD support displaying and editing this keyword.\n *\n * The value of this keyword MAY be used in debug or error output which is intended for developers making use of schemas. Schema vocabularies SHOULD allow \"$comment\" within any object containing vocabulary keywords.\n *\n * Implementations MAY assume \"$comment\" is allowed unless the vocabulary specifically forbids it. Vocabularies MUST NOT specify any effect of \"$comment\" beyond what is described in this specification. Tools that translate other media types or programming languages to and from application/schema+json MAY choose to convert that media type or programming language's native comments to or from \"$comment\" values.\n *\n * The behavior of such translation when both native comments and \"$comment\" properties are present is implementation-dependent. Implementations SHOULD treat \"$comment\" identically to an unknown extension keyword.\n *\n * They MAY strip \"$comment\" values at any point during processing. In particular, this allows for shortening schemas when the size of deployed schemas is a concern. Implementations MUST NOT take any other action based on the presence, absence, or contents of \"$comment\" properties.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "$comment"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "$comment",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "$id",
"docComment": "/**\n * The \"$id\" keyword defines a URI for the schema, and the base URI that other URI references within the schema are resolved against. A subschema's \"$id\" is resolved against the base URI of its parent schema. If no parent sets an explicit base with \"$id\", the base URI is that of the entire document, as determined per [RFC 3986 section 5][RFC3986].\n *\n * If present, the value for this keyword MUST be a string, and MUST represent a valid [URI-reference][RFC3986]. This value SHOULD be normalized, and SHOULD NOT be an empty fragment <#> or an empty string <>.\n *\n * [RFC3986]: http://json-schema.org/latest/json-schema-core.html#RFC3986\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "$id"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "$id",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "$ref",
"docComment": "/**\n * The \"$ref\" keyword is used to reference a schema, and provides the ability to validate recursive structures through self-reference.\n *\n * An object schema with a \"$ref\" property MUST be interpreted as a \"$ref\" reference. The value of the \"$ref\" property MUST be a URI Reference. Resolved against the current URI base, it identifies the URI of a schema to use. All other properties in a \"$ref\" object MUST be ignored.\n *\n * The URI is not a network locator, only an identifier. A schema need not be downloadable from the address if it is a network-addressable URL, and implementations SHOULD NOT assume they should perform a network operation when they encounter a network-addressable URI.\n *\n * A schema MUST NOT be run into an infinite loop against a schema. For example, if two schemas \"#alice\" and \"#bob\" both have an \"allOf\" property that refers to the other, a naive validator might get stuck in an infinite recursive loop trying to validate the instance. Schemas SHOULD NOT make use of infinite recursive nesting like this; the behavior is undefined.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "$ref"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "$ref",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "$schema",
"docComment": "/**\n * The \"$schema\" keyword is both used as a JSON Schema version identifier and the location of a resource which is itself a JSON Schema, which describes any schema written for this particular version.\n *\n * The value of this keyword MUST be a [URI][RFC3986] (containing a scheme) and this URI MUST be normalized. The current schema MUST be valid against the meta-schema identified by this URI.\n *\n * If this URI identifies a retrievable resource, that resource SHOULD be of media type \"application/schema+json\".\n *\n * The \"$schema\" keyword SHOULD be used in a root schema. It MUST NOT appear in subschemas.\n *\n * Values for this property are defined in other documents and by other parties. JSON Schema implementations SHOULD implement support for current and previous published drafts of JSON Schema vocabularies as deemed reasonable.\n *\n * [RFC3986]: http://json-schema.org/latest/json-schema-core.html#RFC3986\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "$schema"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "$schema",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "additionalItems",
"docComment": "/**\n * The value of \"additionalItems\" MUST be a valid JSON Schema.\n *\n * This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself.\n *\n * If \"items\" is an array of schemas, validation succeeds if every instance element at a position greater than the size of \"items\" validates against \"additionalItems\".\n *\n * Otherwise, \"additionalItems\" MUST be ignored, as the \"items\" schema (possibly the default value of an empty schema) is applied to all elements.\n *\n * Omitting this keyword has the same behavior as an empty schema.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "additionalItems"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "additionalItems",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "additionalProperties",
"docComment": "/**\n * The value of \"additionalProperties\" MUST be a valid JSON Schema.\n *\n * This keyword determines how child instances validate for objects, and does not directly validate the immediate instance itself.\n *\n * 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\".\n *\n * For all such properties, validation succeeds if the child instance validates against the \"additionalProperties\" schema.\n *\n * Omitting this keyword has the same behavior as an empty schema.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "additionalProperties"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "additionalProperties",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "allOf",
"docComment": "/**\n * This keyword's value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.\n *\n * An instance validates successfully against this keyword if it validates successfully against all schemas defined by this keyword's value.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "allOf"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean)[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "allOf",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "anyOf",
"docComment": "/**\n * This keyword's value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.\n *\n * An instance validates successfully against this keyword if it validates successfully against at least one schema defined by this keyword's value.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "anyOf"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean)[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "anyOf",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "const",
"docComment": "/**\n * The value of this keyword MAY be of any type, including null.\n *\n * An instance validates successfully against this keyword if its value is equal to the value of the keyword.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "const"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "const",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "contains",
"docComment": "/**\n * The value of this keyword MUST be a valid JSON Schema.\n *\n * An array instance is valid against \"contains\" if at least one of its elements is valid against the given schema.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "contains"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "contains",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "contentEncoding",
"docComment": "/**\n * 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.\n *\n * The value of this property SHOULD be ignored if the instance described is not a string.\n *\n * [RFC2045]: https://tools.ietf.org/html/rfc2045#section-6.1\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "contentEncoding"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "JSONSchemaContentEncodingName"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "JSONSchemaContentEncoding"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "contentEncoding",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "contentMediaType",
"docComment": "/**\n * 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.\n *\n * The value of this property SHOULD be ignored if the instance described is not a string.\n *\n * If the \"contentEncoding\" property is not present, but the instance value is a string, then the value of this property SHOULD specify a text document type, and the character set SHOULD be the character set into which the JSON string value was decoded (for which the default is Unicode).\n *\n * [RFC2046]: https://tools.ietf.org/html/rfc2046\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "contentMediaType"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "contentMediaType",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "default",
"docComment": "/**\n * There are no restrictions placed on the value of this keyword. When multiple occurrences of this keyword are applicable to a single sub-instance, implementations SHOULD remove duplicates.\n *\n * This keyword can be used to supply a default JSON value associated with a particular schema. It is RECOMMENDED that a default value be valid against the associated schema.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "default"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "default",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "definitions",
"docComment": "/**\n * The \"definitions\" keywords provides a standardized location for schema authors to inline re-usable JSON Schemas into a more general schema. The keyword does not directly affect the validation result.\n *\n * This keyword's value MUST be an object. Each member value of this object MUST be a valid JSON Schema.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "definitions"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "{\n ["
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": string]: "
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "definitions",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
},
{
"kind": "PropertySignature",
"canonicalReference": "dependencies",
"docComment": "/**\n * This keyword specifies rules that are evaluated if the instance is an object and contains a certain property.\n *\n * 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.\n *\n * 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.\n *\n * 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.\n *\n * Omitting this keyword has the same behavior as an empty object.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "dependencies"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "{\n ["
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": string]: "
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean | string[];\n } | string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dependencies",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
},
{
"kind": "PropertySignature",
"canonicalReference": "description",
"docComment": "/**\n * Can be used to decorate a user interface with explanation or information about the data produced.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "description"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "description",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "else",
"docComment": "/**\n * This keyword's value MUST be a valid JSON Schema.\n *\n * 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.\n *\n * This keyword has no effect when \"if\" is absent, or when the instance successfully validates against its subschema. Implementations MUST NOT evaluate the instance against this keyword, for either validation or annotation collection purposes, in such cases.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "else"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "else",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "enum",
"docComment": "/**\n * The value of this keyword MUST be an array. This array SHOULD have at least one element. Elements in the array SHOULD be unique.\n *\n * An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.\n *\n * Elements in the array might be of any value, including null.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "enum"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "any[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "enum",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "examples",
"docComment": "/**\n * The value of this keyword MUST be an array. There are no restrictions placed on the values within the array. When multiple occurrences of this keyword are applicable to a single sub-instance, implementations MUST provide a flat array of all values rather than an array of arrays.\n *\n * This keyword can be used to provide sample JSON values associated with a particular schema, for the purpose of illustrating usage. It is RECOMMENDED that these values be valid against the associated schema.\n *\n * Implementations MAY use the value(s) of \"default\", if present, as an additional example. If \"examples\" is absent, \"default\" MAY still be used in this manner.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "examples"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "any[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "examples",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "exclusiveMaximum",
"docComment": "/**\n * The value of \"exclusiveMaximum\" MUST be number, representing an exclusive upper limit for a numeric instance.\n *\n * If the instance is a number, then the instance is valid only if it has a value strictly less than (not equal to) \"exclusiveMaximum\".\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "exclusiveMaximum"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "exclusiveMaximum",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "exclusiveMinimum",
"docComment": "/**\n * The value of \"exclusiveMinimum\" MUST be number, representing an exclusive lower limit for a numeric instance.\n *\n * If the instance is a number, then the instance is valid only if it has a value strictly greater than (not equal to) \"exclusiveMinimum\".\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "exclusiveMinimum"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "exclusiveMinimum",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "format",
"docComment": "/**\n * The \"format\" keyword functions as both an [annotation][annotation] and as an [assertion][assertion]. While no special effort is required to implement it as an annotation conveying semantic meaning, implementing validation is non-trivial.\n *\n * Implementations MAY support the \"format\" keyword as a validation assertion. Should they choose to do so:\n *\n * - they SHOULD implement validation for attributes defined below; - they SHOULD offer an option to disable validation for this keyword.\n *\n * Implementations MAY add custom format attributes. Save for agreement between parties, schema authors SHALL NOT expect a peer implementation to support this keyword and/or custom format attributes.\n *\n * [annotation]: http://json-schema.org/latest/json-schema-validation.html#annotations [assertion]: http://json-schema.org/latest/json-schema-validation.html#assertions\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "format"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "JSONSchemaFormat"
},
{
"kind": "Content",
"text": " | 'date' | 'date-time' | 'email' | 'full-date' | 'full-time' | 'hostname' | 'idn-email' | 'idn-hostname' | 'ipv4' | 'ipv6' | 'iri' | 'iri-reference' | 'json-pointer' | 'json-pointer-uri-fragment' | 'regex' | 'relative-json-pointer' | 'time' | 'uri' | 'uri-reference' | 'uri-template' | 'uuid'"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "format",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "if",
"docComment": "/**\n * This keyword's value MUST be a valid JSON Schema.\n *\n * 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.\n *\n * Instances that successfully validate against this keyword's subschema MUST also be valid against the subschema value of the \"then\" keyword, if present.\n *\n * Instances that fail to validate against this keyword's subschema MUST also be valid against the subschema value of the \"else\" keyword, if present.\n *\n * If [annotations][annotations] are being collected, they are collected from this keyword's subschema in the usual way, including when the keyword is present without either \"then\" or \"else\".\n *\n * [annotations]: http://json-schema.org/latest/json-schema-validation.html#annotations\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "if"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "if",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "items",
"docComment": "/**\n * The value of \"items\" MUST be either a valid JSON Schema or an array of valid JSON Schemas.\n *\n * This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself.\n *\n * If \"items\" is a schema, validation succeeds if all elements in the array successfully validate against that schema.\n *\n * 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.\n *\n * Omitting this keyword has the same behavior as an empty schema.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "items"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean | ("
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean)[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "items",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "maximum",
"docComment": "/**\n * The value of \"maximum\" MUST be a number, representing an inclusive upper limit for a numeric instance.\n *\n * If the instance is a number, then this keyword validates only if the instance is less than or exactly equal to \"maximum\".\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "maximum"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "maximum",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "maxItems",
"docComment": "/**\n * The value of this keyword MUST be a non-negative integer.\n *\n * An array instance is valid against \"maxItems\" if its size is less than, or equal to, the value of this keyword.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "maxItems"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "maxItems",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "maxLength",
"docComment": "/**\n * The value of this keyword MUST be a non-negative integer.\n *\n * A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword.\n *\n * The length of a string instance is defined as the number of its characters as defined by [RFC 7159][RFC7159].\n *\n * [RFC7159]: http://json-schema.org/latest/json-schema-validation.html#RFC7159\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "maxLength"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "maxLength",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "maxProperties",
"docComment": "/**\n * The value of this keyword MUST be a non-negative integer.\n *\n * An object instance is valid against \"maxProperties\" if its number of properties is less than, or equal to, the value of this keyword.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "maxProperties"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "maxProperties",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "minimum",
"docComment": "/**\n * The value of \"minimum\" MUST be a number, representing an inclusive lower limit for a numeric instance.\n *\n * If the instance is a number, then this keyword validates only if the instance is greater than or exactly equal to \"minimum\".\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "minimum"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "minimum",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "minItems",
"docComment": "/**\n * The value of this keyword MUST be a non-negative integer.\n *\n * An array instance is valid against \"minItems\" if its size is greater than, or equal to, the value of this keyword.\n *\n * Omitting this keyword has the same behavior as a value of 0.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "minItems"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "minItems",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "minLength",
"docComment": "/**\n * The value of this keyword MUST be a non-negative integer.\n *\n * A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword.\n *\n * The length of a string instance is defined as the number of its characters as defined by [RFC 7159][RFC7159].\n *\n * Omitting this keyword has the same behavior as a value of 0.\n *\n * [RFC7159]: http://json-schema.org/latest/json-schema-validation.html#RFC7159\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "minLength"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "minLength",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "minProperties",
"docComment": "/**\n * The value of this keyword MUST be a non-negative integer.\n *\n * An object instance is valid against \"minProperties\" if its number of properties is greater than, or equal to, the value of this keyword.\n *\n * Omitting this keyword has the same behavior as a value of 0.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "minProperties"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "minProperties",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "multipleOf",
"docComment": "/**\n * The value of \"multipleOf\" MUST be a number, strictly greater than 0.\n *\n * A numeric instance is valid only if division by this keyword's value results in an integer.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "multipleOf"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "multipleOf",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "not",
"docComment": "/**\n * This keyword's value MUST be a valid JSON Schema.\n *\n * An instance is valid against this keyword if it fails to validate successfully against the schema defined by this keyword.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "not"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "JSONSchema"
},
{
"kind": "Content",
"text": " | boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "not",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "oneOf",
"docComment": "/**\n * This keyword's value