From cd8b7f95e5e50aeaf0eda4630c9e1da13346d5ff Mon Sep 17 00:00:00 2001 From: Frazer Smith Date: Sun, 3 Nov 2024 12:33:29 +0000 Subject: [PATCH] style: remove trailing whitespace (#256) --- docs/API.md | 232 ++++++++++++++++++++++++++-------------------------- 1 file changed, 116 insertions(+), 116 deletions(-) diff --git a/docs/API.md b/docs/API.md index 779a439..1db3872 100644 --- a/docs/API.md +++ b/docs/API.md @@ -337,7 +337,7 @@ The length of a string instance is defined as the number of its characters as de ## ArraySchema([options]) ⇒ [ArraySchema](#ArraySchema) Represents a ArraySchema. -**Kind**: global function +**Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -355,11 +355,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| items | FluentSchema \| Array.<FluentSchema> | +| items | FluentSchema \| Array.<FluentSchema> | @@ -368,11 +368,11 @@ This keyword determines how child instances validate for arrays, and does not di [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.2) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| items | FluentSchema \| [boolean](#boolean) | +| items | FluentSchema \| [boolean](#boolean) | @@ -381,11 +381,11 @@ An array instance is valid against "contains" if at least one of its elements is [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.6) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| value | FluentSchema | +| value | FluentSchema | @@ -396,11 +396,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| boolean | [boolean](#boolean) | +| boolean | [boolean](#boolean) | @@ -410,11 +410,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| min | [number](#number) | +| min | [number](#number) | @@ -424,18 +424,18 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| max | [number](#number) | +| max | [number](#number) | ## BaseSchema([options]) ⇒ [BaseSchema](#BaseSchema) Represents a BaseSchema. -**Kind**: global function +**Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -450,7 +450,7 @@ It defines a URI for the schema, and the base URI that other URI references with [reference](https://tools.ietf.org/html/draft-handrews-json-schema-01#section-8.2) -**Kind**: global function +**Kind**: global function | Param | Type | Description | | --- | --- | --- | @@ -463,11 +463,11 @@ It can be used to decorate a user interface with information about the data prod [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.1) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| title | [string](#string) | +| title | [string](#string) | @@ -478,11 +478,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| description | [string](#string) | +| description | [string](#string) | @@ -492,22 +492,22 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| examples | [string](#string) | +| examples | [string](#string) | ## ref(ref) ⇒ [BaseSchema](#BaseSchema) The value must be a valid id e.g. #properties/foo -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| ref | [string](#string) | +| ref | [string](#string) | @@ -516,11 +516,11 @@ The value of this keyword MUST be an array. This array SHOULD have at least one [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.1.2) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| values | [array](#array) | +| values | [array](#array) | @@ -529,11 +529,11 @@ 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 +**Kind**: global function | Param | | --- | -| value | +| value | @@ -542,11 +542,11 @@ 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 +**Kind**: global function | Param | | --- | -| defaults | +| defaults | @@ -556,11 +556,11 @@ It takes an optional boolean which can be used to explicitly set readOnly true/f [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.3) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| isReadOnly | [boolean](#boolean) \| undefined | +| isReadOnly | [boolean](#boolean) \| undefined | @@ -570,11 +570,11 @@ It takes an optional boolean which can be used to explicitly set writeOnly true/ [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.3) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| isWriteOnly | [boolean](#boolean) \| undefined | +| isWriteOnly | [boolean](#boolean) \| undefined | @@ -584,11 +584,11 @@ It takes an optional boolean which can be used to explicitly set deprecated true [reference](https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.9.3) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| isDeprecated | Boolean | +| isDeprecated | Boolean | @@ -601,7 +601,7 @@ Examples: [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.3) -**Kind**: global function +**Kind**: global function ## not(not) ⇒ [BaseSchema](#BaseSchema) @@ -610,11 +610,11 @@ An instance is valid against this keyword if it fails to validate successfully a [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.7.4) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| not | FluentSchema | +| not | FluentSchema | @@ -623,11 +623,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| schemas | [array](#array) | +| schemas | [array](#array) | @@ -636,11 +636,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| schemas | [array](#array) | +| schemas | [array](#array) | @@ -649,11 +649,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| schemas | [array](#array) | +| schemas | [array](#array) | @@ -663,7 +663,7 @@ 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 +**Kind**: global function | Param | Type | Description | | --- | --- | --- | @@ -676,7 +676,7 @@ validation succeeds against this keyword if the instance also successfully valid 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 +**Kind**: global function | Param | Type | Description | | --- | --- | --- | @@ -694,7 +694,7 @@ it can be handy to arbitrary modify the schema injecting a fragment - S.number().raw({ nullable:true }) - S.string().format('date').raw({ formatMaximum: '2020-01-01' }) -**Kind**: global function +**Kind**: global function | Param | Type | Description | | --- | --- | --- | @@ -705,7 +705,7 @@ it can be handy to arbitrary modify the schema injecting a fragment ## valueOf([options]) ⇒ [object](#object) It returns all the schema values -**Kind**: global function +**Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -717,7 +717,7 @@ It returns all the schema values ## BooleanSchema([options]) ⇒ [StringSchema](#StringSchema) Represents a BooleanSchema. -**Kind**: global function +**Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -730,7 +730,7 @@ Represents a BooleanSchema. ## S([options]) ⇒ [S](#S) Represents a S. -**Kind**: global function +**Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -745,7 +745,7 @@ 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 +**Kind**: global function ## number() ⇒ [NumberSchema](#NumberSchema) @@ -753,7 +753,7 @@ Set a property to type number [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#numeric) -**Kind**: global function +**Kind**: global function ## integer() ⇒ [IntegerSchema](#IntegerSchema) @@ -761,7 +761,7 @@ Set a property to type integer [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#numeric) -**Kind**: global function +**Kind**: global function ## boolean() ⇒ [BooleanSchema](#BooleanSchema) @@ -769,7 +769,7 @@ 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 +**Kind**: global function ## array() ⇒ [ArraySchema](#ArraySchema) @@ -777,7 +777,7 @@ 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 +**Kind**: global function ## object() ⇒ [ObjectSchema](#ObjectSchema) @@ -785,7 +785,7 @@ 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 +**Kind**: global function ## null() ⇒ [NullSchema](#NullSchema) @@ -793,17 +793,17 @@ Set a property to type null [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#general) -**Kind**: global function +**Kind**: global function ## mixed(types) ⇒ [MixedSchema](#MixedSchema) A mixed schema is the union of multiple types (e.g. ['string', 'integer'] -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| types | [Array.<string>](#string) | +| types | [Array.<string>](#string) | @@ -815,7 +815,7 @@ it can be handy to arbitrary modify the schema injecting a fragment - S.raw({ nullable:true, format: 'date', formatMaximum: '2020-01-01' }) - S.string().format('date').raw({ formatMaximum: '2020-01-01' }) -**Kind**: global function +**Kind**: global function | Param | Type | Description | | --- | --- | --- | @@ -826,7 +826,7 @@ it can be handy to arbitrary modify the schema injecting a fragment ## IntegerSchema([options]) ⇒ [NumberSchema](#NumberSchema) Represents a NumberSchema. -**Kind**: global function +**Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -839,7 +839,7 @@ Represents a NumberSchema. ## MixedSchema([options]) ⇒ [StringSchema](#StringSchema) Represents a MixedSchema. -**Kind**: global function +**Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -852,7 +852,7 @@ Represents a MixedSchema. ## NullSchema([options]) ⇒ [StringSchema](#StringSchema) Represents a NullSchema. -**Kind**: global function +**Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -867,13 +867,13 @@ 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 +**Kind**: global function ## NumberSchema([options]) ⇒ [NumberSchema](#NumberSchema) Represents a NumberSchema. -**Kind**: global function +**Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -888,11 +888,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| min | [number](#number) | +| min | [number](#number) | @@ -901,11 +901,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| min | [number](#number) | +| min | [number](#number) | @@ -914,11 +914,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| max | [number](#number) | +| max | [number](#number) | @@ -927,11 +927,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| max | [number](#number) | +| max | [number](#number) | @@ -940,18 +940,18 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| multiple | [number](#number) | +| multiple | [number](#number) | ## ObjectSchema([options]) ⇒ [StringSchema](#StringSchema) Represents a ObjectSchema. -**Kind**: global function +**Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -968,7 +968,7 @@ differs from other schema types. [reference](https://tools.ietf.org/html/draft-handrews-json-schema-01#section-8.2) -**Kind**: global function +**Kind**: global function | Param | Type | Description | | --- | --- | --- | @@ -985,11 +985,11 @@ 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 +**Kind**: global function | Param | Type | | --- | --- | -| value | FluentSchema \| [boolean](#boolean) | +| value | FluentSchema \| [boolean](#boolean) | @@ -998,11 +998,11 @@ An object instance is valid against "maxProperties" if its number of properties [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.1) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| max | [number](#number) | +| max | [number](#number) | @@ -1011,11 +1011,11 @@ An object instance is valid against "minProperties" if its number of properties [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.2) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| min | [number](#number) | +| min | [number](#number) | @@ -1028,11 +1028,11 @@ Validation succeeds if, for each instance name that matches any regular expressi [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.5) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| opts | [object](#object) | +| opts | [object](#object) | @@ -1044,11 +1044,11 @@ If the dependency value is an array, each element in the array, if any, MUST be [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.7) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| opts | [object](#object) | +| opts | [object](#object) | @@ -1058,11 +1058,11 @@ Each element in the array MUST be a string and MUST be unique. If the dependency [reference](https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.6.5.4) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| opts | [object](#object) | +| opts | [object](#object) | @@ -1072,11 +1072,11 @@ Each dependency key is a property in the instance and the entire instance must v [reference](https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.9.2.2.4) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| opts | [object](#object) | +| opts | [object](#object) | @@ -1086,11 +1086,11 @@ Note the property name that the schema is testing will always be a string. [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.8) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| value | FluentSchema | +| value | FluentSchema | @@ -1099,12 +1099,12 @@ The value of "properties" MUST be an object. Each value of this object MUST be a [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.5.4) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| name | [string](#string) | -| props | FluentSchema | +| name | [string](#string) | +| props | FluentSchema | @@ -1112,7 +1112,7 @@ The value of "properties" MUST be an object. Each value of this object MUST be a Returns an object schema with only a subset of keys provided. If called on an ObjectSchema with an `$id`, it will be removed and the return value will be considered a new schema. -**Kind**: global function +**Kind**: global function | Param | Description | | --- | --- | @@ -1124,7 +1124,7 @@ Returns an object schema with only a subset of keys provided. If called on an Ob Returns an object schema without a subset of keys provided. If called on an ObjectSchema with an `$id`, it will be removed and the return value will be considered a new schema. -**Kind**: global function +**Kind**: global function | Param | Description | | --- | --- | @@ -1138,30 +1138,30 @@ 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.9) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| name | [string](#string) | -| props | FluentSchema | +| name | [string](#string) | +| props | FluentSchema | ## RawSchema(schema) ⇒ FluentSchema Represents a raw JSON Schema that will be parsed -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| schema | Object | +| schema | Object | ## StringSchema([options]) ⇒ [StringSchema](#StringSchema) Represents a StringSchema. -**Kind**: global function +**Kind**: global function | Param | Type | Default | Description | | --- | --- | --- | --- | @@ -1177,11 +1177,11 @@ The length of a string instance is defined as the number of its characters as de [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.3.2) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| min | [number](#number) | +| min | [number](#number) | @@ -1191,11 +1191,11 @@ The length of a string instance is defined as the number of its characters as de [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.3.1) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| max | [number](#number) | +| max | [number](#number) | @@ -1204,11 +1204,11 @@ A string value can be RELATIVE_JSON_POINTER, JSON_POINTER, UUID, REGEX, IPV6, IP [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.7.3) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| format | [string](#string) | +| format | [string](#string) | @@ -1218,11 +1218,11 @@ This string SHOULD be a valid regular expression, according to the ECMA 262 regu [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.3.3) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| pattern | [string](#string) | +| pattern | [string](#string) | @@ -1233,11 +1233,11 @@ If the instance value is a string, this property defines that the string SHOULD [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.8.3) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| encoding | [string](#string) | +| encoding | [string](#string) | @@ -1247,9 +1247,9 @@ The value of this property must be a media type, as defined by RFC 2046 [RFC2046 [reference](https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.8.4) -**Kind**: global function +**Kind**: global function | Param | Type | | --- | --- | -| mediaType | [string](#string) | +| mediaType | [string](#string) |