Plugin catalogue

At least one element satisfies the given element chain. Draft-07 contains, with optional min / max bounds for minContains / maxContains.

• array
• tuple

import { arrayContainsPlugin } from "@maroonedog/luq/plugins/arrayContains";

Applies one element chain to every element. It reports a single issue for the array; declare items[*] with .v() when you want one issue per element.

• array
• tuple

import { arrayEachPlugin } from "@maroonedog/luq/plugins/arrayEach";

The array contains the given value. Membership is structural, so a value that came out of JSON.parse still matches.

• array
• tuple

import { arrayIncludesPlugin } from "@maroonedog/luq/plugins/arrayIncludes";

At most N elements. Draft-07 maxItems.

• array
• tuple

import { arrayMaxLengthPlugin } from "@maroonedog/luq/plugins/arrayMaxLength";

At least N elements. Draft-07 minItems.

• array
• tuple

import { arrayMinLengthPlugin } from "@maroonedog/luq/plugins/arrayMinLength";

No two elements are equal. Equality is structural, so the same object shape twice is a duplicate. Draft-07 uniqueItems.

• array
• tuple

import { arrayUniquePlugin } from "@maroonedog/luq/plugins/arrayUnique";

The value must be false.

• boolean

import { booleanFalsyPlugin } from "@maroonedog/luq/plugins/booleanFalsy";

The value must be true — the accept-the-terms checkbox rule.

• boolean

import { booleanTruthyPlugin } from "@maroonedog/luq/plugins/booleanTruthy";

Compares this field with another declared path. Equality by default; pass a comparison function for anything else. The path is checked against your type at compile time.

• string
• number
• boolean
• date
• object
• array
• tuple
• union

import { compareFieldPlugin } from "@maroonedog/luq/plugins/compareField";

Draft-07 if / then / else as one three-branch rule: when the condition chain passes, then applies, otherwise else does. Both branches are optional.

• object
• array
• string
• number
• boolean

import { conditionalSchemaPlugin } from "@maroonedog/luq/plugins/conditionalSchema";

An arbitrary predicate over the field's value. It runs exactly once and may return { valid, message } to supply its own message.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { customPlugin } from "@maroonedog/luq/plugins/custom";

Checks the field against the external context handed to validate(value, { external }) — the read side of the async story. The plugin itself knows nothing about async.

• string
• number
• boolean
• date
• object
• array
• tuple
• union

import { fromContextPlugin } from "@maroonedog/luq/plugins/fromContext";

Constrains one declared field by a JSON Schema document, and takes the plugin bag explicitly. It reaches root-level keywords fromJsonSchema cannot, such as propertyNames and if / then / else on the document root.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { jsonSchemaPlugin } from "@maroonedog/luq/plugins/jsonSchema";

One import that covers a whole Draft-07 document. The same subpath exports fromJsonSchema<T>(schema), which builds a validator with no builder chain at all.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { jsonSchemaFullFeaturePlugin } from "@maroonedog/luq/plugins/jsonSchemaFullFeature";

Equality against one constant. Comparison is structural, so it matches values that came out of JSON.parse. Draft-07 const.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { literalPlugin } from "@maroonedog/luq/plugins/literal";

null is an accepted value for this field.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { nullablePlugin } from "@maroonedog/luq/plugins/nullable";

Rejects NaN, Infinity and -Infinity.

• number

import { numberFinitePlugin } from "@maroonedog/luq/plugins/numberFinite";

The value has no fractional part. Draft-07 integer.

• number

import { numberIntegerPlugin } from "@maroonedog/luq/plugins/numberInteger";

Upper bound. Pass true as the second argument for an exclusive bound. Draft-07 maximum / exclusiveMaximum.

• number

import { numberMaxPlugin } from "@maroonedog/luq/plugins/numberMax";

Lower bound. Pass true as the second argument for an exclusive bound. Draft-07 minimum / exclusiveMinimum.

• number

import { numberMinPlugin } from "@maroonedog/luq/plugins/numberMin";

The value is an exact multiple of the divisor. Draft-07 multipleOf.

• number

import { numberMultipleOfPlugin } from "@maroonedog/luq/plugins/numberMultipleOf";

Strictly less than zero.

• number

import { numberNegativePlugin } from "@maroonedog/luq/plugins/numberNegative";

Strictly greater than zero.

• number

import { numberPositivePlugin } from "@maroonedog/luq/plugins/numberPositive";

Both bounds at once, inclusive.

• number

import { numberRangePlugin } from "@maroonedog/luq/plugins/numberRange";

**Deprecated, and inert.** Entering b.object already checks that the value is a plain object, under the code objectType, so this rule answers PASS for everything. Drop the import and the .object() call: the field goes on rejecting arrays, null and primitives either way.

• object

import { objectPlugin } from "@maroonedog/luq/plugins/object";

Draft-07's boolean additionalProperties. false forbids any key the schema did not declare; the optional second argument is a plain allow-list of extra key names.

• object

import { objectAdditionalPropertiesPlugin } from "@maroonedog/luq/plugins/objectAdditionalProperties";

Draft-07's schema form of additionalProperties: every undeclared key's value must satisfy the sub-chain. Passing false forbids undeclared keys outright.

• object

import { objectAdditionalPropertiesSchemaPlugin } from "@maroonedog/luq/plugins/objectAdditionalProperties";

When a trigger key is present, the keys it lists must be present too. Draft-07 dependentRequired.

• object

import { objectDependentRequiredPlugin } from "@maroonedog/luq/plugins/objectDependentRequired";

When a trigger key is present, the whole object must also satisfy that key's sub-chain. Draft-07 dependentSchemas.

• object

import { objectDependentSchemasPlugin } from "@maroonedog/luq/plugins/objectDependentSchemas";

At most N own keys. Draft-07 maxProperties.

• object

import { objectMaxPropertiesPlugin } from "@maroonedog/luq/plugins/objectMaxProperties";

At least N own keys. Draft-07 minProperties.

• object

import { objectMinPropertiesPlugin } from "@maroonedog/luq/plugins/objectMinProperties";

Every property whose key matches a regular expression must satisfy that pattern's sub-chain. Draft-07 patternProperties.

• object

import { objectPatternPropertiesPlugin } from "@maroonedog/luq/plugins/objectPatternProperties";

Constrains the object's KEYS with a string sub-chain — the subject is the key, never the value. Draft-07 propertyNames.

• object

import { objectPropertyNamesPlugin } from "@maroonedog/luq/plugins/objectPropertyNames";

Re-enters this field's own plan, on itself ("self") or on its elements ("element"), down to maxDepth (default 10). A cycle ends the descent silently.

• object
• array

import { objectRecursivelyPlugin } from "@maroonedog/luq/plugins/objectRecursively";

The value is one of a fixed list. Membership is structural. This is the value enum — not the oneOf composition keyword, which takes sub-schemas.

• string
• number
• boolean

import { oneOfPlugin } from "@maroonedog/luq/plugins/oneOf";

The field may be absent. undefined passes and no other rule on the field runs.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { optionalPlugin } from "@maroonedog/luq/plugins/optional";

The field is optional only while the predicate holds, and required otherwise. The logical dual of requiredIf.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { optionalIfPlugin } from "@maroonedog/luq/plugins/optionalIf";

While the predicate holds, the field must carry no value at all, whatever that value would be — a deprecated field, or one a role forbids.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { orFailPlugin } from "@maroonedog/luq/plugins/orFail";

JSON Schema readOnly as an access check: on a write, the field must not be supplied.

• string
• number
• boolean
• date
• array
• object

import { readOnlyPlugin } from "@maroonedog/luq/plugins/readOnly";

The field must be present. It narrows null out of the field's type as well as undefined.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { requiredPlugin } from "@maroonedog/luq/plugins/required";

The field is required only while the predicate holds. The predicate sees the whole root value, and inside an array path it also sees the element's context.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { requiredIfPlugin } from "@maroonedog/luq/plugins/requiredIf";

Skips every rule on this field while the predicate holds. The polarity-inverted twin of validateIf.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { skipPlugin } from "@maroonedog/luq/plugins/skip";

Checks this field against the values of other declared paths in one function. The paths are type-checked, and the check runs exactly once.

• string
• number
• boolean
• date
• object
• array
• tuple
• union

import { stitchPlugin } from "@maroonedog/luq/plugins/stitch";

EXPERIMENTAL. Cross-field validation over a TYPED bundle. Name the paths under aliases, then judge them together in one sub-chain. stitch hands the bundle over as Record<string, unknown>; here a misspelt member or a wrong type is a compile error.

• string
• number
• boolean
• date
• object
• array
• tuple
• union

import { stitchWithPlugin } from "@maroonedog/luq/plugins/stitchWith";

ASCII letters and digits only. The empty string fails; pass true to allow spaces.

• string

import { stringAlphanumericPlugin } from "@maroonedog/luq/plugins/stringAlphanumeric";

The string looks like base64. Recognition only — nothing here decodes it, so there is no decoded value to inspect.

• string

import { stringBase64Plugin } from "@maroonedog/luq/plugins/stringBase64";

The string is valid under the named encoding: base64, base32, binary, 7bit, 8bit or quoted-printable. Draft-07 contentEncoding.

• string

import { stringContentEncodingPlugin } from "@maroonedog/luq/plugins/stringContentEncoding";

The string parses as the named media type. Draft-07 contentMediaType.

• string

import { stringContentMediaTypePlugin } from "@maroonedog/luq/plugins/stringContentMediaType";

An RFC 3339 full-date, YYYY-MM-DD. Draft-07 date.

• string

import { stringDatePlugin } from "@maroonedog/luq/plugins/stringDate";

An RFC 3339 date-time. Draft-07 date-time.

• string

import { stringDatetimePlugin } from "@maroonedog/luq/plugins/stringDatetime";

An ISO 8601 duration. Draft-07 duration.

• string

import { stringDurationPlugin } from "@maroonedog/luq/plugins/stringDuration";

An email address. Pass customRegex to substitute your own grammar. Draft-07 email.

• string

import { stringEmailPlugin } from "@maroonedog/luq/plugins/stringEmail";

The string ends with the suffix. An empty suffix always passes.

• string

import { stringEndsWithPlugin } from "@maroonedog/luq/plugins/stringEndsWith";

Exactly N UTF-16 code units.

• string

import { stringExactLengthPlugin } from "@maroonedog/luq/plugins/stringExactLength";

An RFC 1123 hostname. Draft-07 hostname.

• string

import { stringHostnamePlugin } from "@maroonedog/luq/plugins/stringHostname";

An internationalised email address. Draft-07 idn-email.

• string

import { stringIdnEmailPlugin } from "@maroonedog/luq/plugins/stringIdnEmail";

An internationalised hostname. Draft-07 idn-hostname.

• string

import { stringIdnHostnamePlugin } from "@maroonedog/luq/plugins/stringIdnHostname";

A dotted-quad IPv4 address. Draft-07 ipv4.

• string

import { stringIpv4Plugin } from "@maroonedog/luq/plugins/stringIpv4";

An IPv6 address. Draft-07 ipv6.

• string

import { stringIpv6Plugin } from "@maroonedog/luq/plugins/stringIpv6";

An IRI (RFC 3987, deliberately approximate). Draft-07 iri.

• string

import { stringIriPlugin } from "@maroonedog/luq/plugins/stringIri";

An IRI reference, absolute or relative. Draft-07 iri-reference.

• string

import { stringIriReferencePlugin } from "@maroonedog/luq/plugins/stringIriReference";

An RFC 6901 JSON Pointer. Draft-07 json-pointer.

• string

import { stringJsonPointerPlugin } from "@maroonedog/luq/plugins/stringJsonPointer";

At most N UTF-16 code units. max: 0 permits only the empty string. Draft-07 maxLength.

• string

import { stringMaxPlugin } from "@maroonedog/luq/plugins/stringMax";

At least N UTF-16 code units, so an astral character counts as two. Draft-07 minLength.

• string

import { stringMinPlugin } from "@maroonedog/luq/plugins/stringMin";

The string matches a RegExp.

• string

import { stringPatternPlugin } from "@maroonedog/luq/plugins/stringPattern";

The string is itself a valid regular expression. Draft-07 regex.

• string

import { stringRegexPlugin } from "@maroonedog/luq/plugins/stringRegex";

A relative JSON Pointer. Draft-07 relative-json-pointer.

• string

import { stringRelativeJsonPointerPlugin } from "@maroonedog/luq/plugins/stringRelativeJsonPointer";

The string starts with the prefix. An empty prefix always passes.

• string

import { stringStartsWithPlugin } from "@maroonedog/luq/plugins/stringStartsWith";

An RFC 3339 full-time. Draft-07 time.

• string

import { stringTimePlugin } from "@maroonedog/luq/plugins/stringTime";

A URI reference, absolute or relative. Draft-07 uri-reference.

• string

import { stringUriReferencePlugin } from "@maroonedog/luq/plugins/stringUriReference";

An RFC 6570 URI template. Draft-07 uri-template.

• string

import { stringUriTemplatePlugin } from "@maroonedog/luq/plugins/stringUriTemplate";

An absolute URL, and the single home of the Draft-07 uri format.

• string

import { stringUrlPlugin } from "@maroonedog/luq/plugins/stringUrl";

Maps the value to a new one. Transforms run LAST and only in parse() — validate() gives you back the original value.

• string
• number
• boolean
• date
• array
• object
• union

import { transformPlugin } from "@maroonedog/luq/plugins/transform";

One chain per tuple position, plus an optional chain for the rest. Each position is typed by the tuple member it sits on.

• tuple

import { tupleBuilderPlugin } from "@maroonedog/luq/plugins/tupleBuilder";

A type guard plus the rules that apply to the branch it narrows to. Every member of the union must be covered before build() is offered.

• union

import { unionGuardPlugin } from "@maroonedog/luq/plugins/unionGuard";

A UUID. Pass a version, or a list of versions, to narrow it.

• string

import { uuidPlugin } from "@maroonedog/luq/plugins/uuid";

Runs this field's rules only while the predicate holds. Where the call sits in the chain is irrelevant — the engine asks every gate before it runs any rule.

• string
• number
• boolean
• date
• array
• tuple
• object
• union
• any

import { validateIfPlugin } from "@maroonedog/luq/plugins/validateIf";

JSON Schema writeOnly as an access check: on a read, the field must not be returned.

• string
• number
• boolean
• date
• array
• object

import { writeOnlyPlugin } from "@maroonedog/luq/plugins/writeOnly";