shelving 1.240.0 → 1.242.0

package/extract/TypescriptExtractor.d.ts

@@ -9,7 +9,7 @@ import { FileExtractor } from "./FileExtractor.js";
  * - A `@kind` tag in a symbol's JSDoc overrides the inferred kind — e.g. `@kind component` relabels a React component (otherwise a `function`) so the docs site groups and colours it as a component. The override also drops the trailing `()` from the title, since a non-function kind reads as a bare name.
  * - Top-of-file JSDoc comment becomes the file's `content`.
  * - Sets `description` (a plain-text summary from the first JSDoc paragraph) on the file and every `tree-documentation` child.
- * - Sets `title` on every `tree-documentation` child — `name()` for functions and methods, bare `name` for other kinds. Parent class context comes from the `class` prop ("member of …" affordance), never the title.
+ * - Sets `title` on every `tree-documentation` child — `name()` for functions, `Class.name()` for methods, `Class.name` for properties, bare `name` for other kinds.
  * - Records relational metadata as raw strings for render-time linking: `class` (owning class), `readonly`, `extends`, `implements`.
  * - Members declared with the `override` or `declare` modifier are skipped — the base class already documents overrides, and `declare` members are ambient type-only re-declarations rather than new API.
  * - Keys are the raw declared `name` (case-preserving) so case-distinct exports like `Collection` and `COLLECTION` stay separate.

package/extract/TypescriptExtractor.js

@@ -10,7 +10,7 @@ import { extractMarkdownProps } from "./MarkupExtractor.js";
  * - A `@kind` tag in a symbol's JSDoc overrides the inferred kind — e.g. `@kind component` relabels a React component (otherwise a `function`) so the docs site groups and colours it as a component. The override also drops the trailing `()` from the title, since a non-function kind reads as a bare name.
  * - Top-of-file JSDoc comment becomes the file's `content`.
  * - Sets `description` (a plain-text summary from the first JSDoc paragraph) on the file and every `tree-documentation` child.
- * - Sets `title` on every `tree-documentation` child — `name()` for functions and methods, bare `name` for other kinds. Parent class context comes from the `class` prop ("member of …" affordance), never the title.
+ * - Sets `title` on every `tree-documentation` child — `name()` for functions, `Class.name()` for methods, `Class.name` for properties, bare `name` for other kinds.
  * - Records relational metadata as raw strings for render-time linking: `class` (owning class), `readonly`, `extends`, `implements`.
  * - Members declared with the `override` or `declare` modifier are skipped — the base class already documents overrides, and `declare` members are ambient type-only re-declarations rather than new API.
  * - Keys are the raw declared `name` (case-preserving) so case-distinct exports like `Collection` and `COLLECTION` stay separate.
@@ -332,10 +332,11 @@ function _getReturns(statement, source, jsDocReturns, name) {
 }
 /**
  * Extract class or interface members as child elements.
- * - `className` is stamped onto every member as its `class` prop (the source of the qualified flat key and the "member of …" affordance); the title stays the bare member `name` / `name()`.
+ * - `className` is stamped onto every member as its `class` prop (the source of the qualified flat key and the "member of …" affordance) and is prebaked into the member `title` (`Class.name` / `Class.name()`).
  * - Members declared with the `override` modifier are skipped — the base class already documents them, so a subclass page lists only its newly-introduced API.
  * - Members declared with the `declare` modifier are skipped — they're ambient type-only re-declarations (e.g. narrowing an inherited property's type), not new API.
  * - Getters/setters fold into a single `property` element per name; a getter with no matching setter is `readonly`.
+ * - `static` members are labelled `static method` / `static property` so the docs site groups them in their own sections, separate from instance `method` / `property`, and their rendered signature is prefixed with the `static ` keyword.
  */
 function _getClassMembers(statement, source, className) {
     if (!ts.isClassDeclaration(statement) && !ts.isInterfaceDeclaration(statement))
@@ -355,13 +356,17 @@ function _getClassMembers(statement, source, className) {
         // Skip `declare` members — ambient type-only re-declarations (e.g. a subclass narrowing an inherited property's type), not new API.
         if (modifiers?.some(m => m.kind === ts.SyntaxKind.DeclareKeyword))
             continue;
+        // `static` members are grouped and labelled separately from instance members (`static method` / `static property`),
+        // and carry the `static ` keyword in their rendered signature.
+        const isStatic = modifiers?.some(m => m.kind === ts.SyntaxKind.StaticKeyword);
+        const staticPrefix = isStatic ? "static " : "";
         const memberJSDoc = _getJSDoc(member, source);
         const content = _buildJSDocContent(memberJSDoc?.description, memberJSDoc?.unhandled);
         const description = extractMarkdownProps(memberJSDoc?.description ?? "").description;
         if (ts.isMethodDeclaration(member) || ts.isMethodSignature(member)) {
             const params = member.parameters.map(p => p.getText(source)).join(", ");
             const ret = member.type ? member.type.getText(source) : "void";
-            const signature = `${name}(${params}): ${ret}`;
+            const signature = `${staticPrefix}${name}(${params}): ${ret}`;
             const key = name;
             const existingIndex = members.findIndex(m => m.key === key);
             const existing = members[existingIndex];
@@ -377,10 +382,10 @@ function _getClassMembers(statement, source, className) {
                     key,
                     props: {
                         name,
-                        title: `${name}()`,
+                        title: `${className}.${name}()`,
                         description,
                         content,
-                        kind: "method",
+                        kind: isStatic ? "static method" : "method",
                         class: className,
                         signatures: [signature],
                     },
@@ -395,13 +400,13 @@ function _getClassMembers(statement, source, className) {
                 key: name,
                 props: {
                     name,
-                    title: name,
+                    title: `${className}.${name}`,
                     description,
                     content,
-                    kind: "property",
+                    kind: isStatic ? "static property" : "property",
                     class: className,
                     readonly,
-                    signatures: type ? [`${readonly ? "readonly " : ""}${name}: ${type}`] : undefined,
+                    signatures: type ? [`${staticPrefix}${readonly ? "readonly " : ""}${name}: ${type}`] : undefined,
                 },
             });
         }
@@ -418,7 +423,7 @@ function _getClassMembers(statement, source, className) {
                         ...existing.props,
                         // A getter + setter pair is writable — drop the read-only flag and the `readonly ` signature prefix.
                         readonly: undefined,
-                        signatures: type ? [`${name}: ${type}`] : existing.props.signatures,
+                        signatures: type ? [`${staticPrefix}${name}: ${type}`] : existing.props.signatures,
                     },
                 };
             }
@@ -428,13 +433,13 @@ function _getClassMembers(statement, source, className) {
                     key,
                     props: {
                         name,
-                        title: name,
+                        title: `${className}.${name}`,
                         description,
                         content,
-                        kind: "property",
+                        kind: isStatic ? "static property" : "property",
                         class: className,
                         readonly: ts.isGetAccessor(member) || undefined,
-                        signatures: type ? [`${ts.isGetAccessor(member) ? "readonly " : ""}${name}: ${type}`] : undefined,
+                        signatures: type ? [`${staticPrefix}${ts.isGetAccessor(member) ? "readonly " : ""}${name}: ${type}`] : undefined,
                     },
                 });
             }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "shelving",
-	"version": "1.240.0",
+	"version": "1.242.0",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"repository": {
 		"type": "git",

package/schema/AddressSchema.d.ts

@@ -38,14 +38,14 @@ export declare class AddressSchema extends DataSchema<AddressData> {
     format(value: AddressData): string;
 }
 /**
- * Valid postal address data.
+ * Sugar instance of [`AddressSchema`](/schema/AddressSchema) for postal address data. Equivalent to `new AddressSchema({})`.
  *
  * @example ADDRESS.validate({ address1: "1 High St", city: "London", postcode: "SW1A 1AA", country: "GB" });
  * @see https://dhoulb.github.io/shelving/schema/AddressSchema/ADDRESS
  */
 export declare const ADDRESS: AddressSchema;
 /**
- * Valid postal address data, or `null`
+ * Sugar instance allowing an [`ADDRESS`](/schema/ADDRESS) or `null`. Equivalent to `NULLABLE(ADDRESS)`.
  *
  * @example NULLABLE_ADDRESS.validate(null); // Returns null
  * @see https://dhoulb.github.io/shelving/schema/AddressSchema/NULLABLE_ADDRESS

package/schema/AddressSchema.js

@@ -45,14 +45,14 @@ export class AddressSchema extends DataSchema {
     }
 }
 /**
- * Valid postal address data.
+ * Sugar instance of [`AddressSchema`](/schema/AddressSchema) for postal address data. Equivalent to `new AddressSchema({})`.
  *
  * @example ADDRESS.validate({ address1: "1 High St", city: "London", postcode: "SW1A 1AA", country: "GB" });
  * @see https://dhoulb.github.io/shelving/schema/AddressSchema/ADDRESS
  */
 export const ADDRESS = new AddressSchema({});
 /**
- * Valid postal address data, or `null`
+ * Sugar instance allowing an [`ADDRESS`](/schema/ADDRESS) or `null`. Equivalent to `NULLABLE(ADDRESS)`.
  *
  * @example NULLABLE_ADDRESS.validate(null); // Returns null
  * @see https://dhoulb.github.io/shelving/schema/AddressSchema/NULLABLE_ADDRESS

package/schema/ArraySchema.d.ts

@@ -83,7 +83,7 @@ export declare class ArraySchema<T> extends Schema<ImmutableArray<T>> {
 /**
  * Create a schema for a valid array with specified items.
  *
- * *Factory for `ArraySchema`.*
+ * Sugar factory for [`ArraySchema`](/schema/ArraySchema).
  *
  * @param items Schema every item in the array must conform to.
  * @returns An `ArraySchema` validating arrays of the given item type.

package/schema/ArraySchema.js

@@ -79,7 +79,7 @@ export class ArraySchema extends Schema {
 /**
  * Create a schema for a valid array with specified items.
  *
- * *Factory for `ArraySchema`.*
+ * Sugar factory for [`ArraySchema`](/schema/ArraySchema).
  *
  * @param items Schema every item in the array must conform to.
  * @returns An `ArraySchema` validating arrays of the given item type.

package/schema/BooleanSchema.d.ts

@@ -63,7 +63,7 @@ export declare class BooleanSchema extends Schema<boolean> {
     format(value: boolean): string;
 }
 /**
- * Valid boolean.
+ * Sugar instance of [`BooleanSchema`](/schema/BooleanSchema) for a coerced boolean. Equivalent to `new BooleanSchema({})`.
  *
  * @example
  *  BOOLEAN.validate("yes"); // Returns true

package/schema/BooleanSchema.js

@@ -60,7 +60,7 @@ export class BooleanSchema extends Schema {
     }
 }
 /**
- * Valid boolean.
+ * Sugar instance of [`BooleanSchema`](/schema/BooleanSchema) for a coerced boolean. Equivalent to `new BooleanSchema({})`.
  *
  * @example
  *  BOOLEAN.validate("yes"); // Returns true

package/schema/ChoiceSchema.d.ts

@@ -76,7 +76,7 @@ export declare class ChoiceSchema<O extends string, I = never> extends Schema<O>
 /**
  * Create a schema for a valid choice from an allowed set of values.
  *
- * *Factory for `ChoiceSchema`.*
+ * Sugar factory for [`ChoiceSchema`](/schema/ChoiceSchema).
  *
  * @param options The allowed choices, as a `{ key: title }` dictionary or an array of keys.
  * @returns A `ChoiceSchema` validating the given choices.

package/schema/ChoiceSchema.js

@@ -60,7 +60,7 @@ export class ChoiceSchema extends Schema {
 /**
  * Create a schema for a valid choice from an allowed set of values.
  *
- * *Factory for `ChoiceSchema`.*
+ * Sugar factory for [`ChoiceSchema`](/schema/ChoiceSchema).
  *
  * @param options The allowed choices, as a `{ key: title }` dictionary or an array of keys.
  * @returns A `ChoiceSchema` validating the given choices.

package/schema/ColorSchema.d.ts

@@ -39,14 +39,14 @@ export declare class ColorSchema extends StringSchema {
     sanitize(insaneString: string): string;
 }
 /**
- * Valid color hex string, e.g. `#00CCFF` (required because empty string is invalid).
+ * Sugar instance of [`ColorSchema`](/schema/ColorSchema) for a required hex color string, e.g. `#00CCFF`. Equivalent to `new ColorSchema({})`.
  *
  * @example COLOR.validate("#00CCFF"); // Returns "#00CCFF"
  * @see https://dhoulb.github.io/shelving/schema/ColorSchema/COLOR
  */
 export declare const COLOR: ColorSchema;
 /**
- * Valid color hex string, e.g. `#00CCFF`, or `null`
+ * Sugar instance allowing a [`COLOR`](/schema/COLOR) or `null`. Equivalent to `NULLABLE(COLOR)`.
  *
  * @example NULLABLE_COLOR.validate(null); // Returns null
  * @see https://dhoulb.github.io/shelving/schema/ColorSchema/NULLABLE_COLOR

package/schema/ColorSchema.js

@@ -50,14 +50,14 @@ export class ColorSchema extends StringSchema {
     }
 }
 /**
- * Valid color hex string, e.g. `#00CCFF` (required because empty string is invalid).
+ * Sugar instance of [`ColorSchema`](/schema/ColorSchema) for a required hex color string, e.g. `#00CCFF`. Equivalent to `new ColorSchema({})`.
  *
  * @example COLOR.validate("#00CCFF"); // Returns "#00CCFF"
  * @see https://dhoulb.github.io/shelving/schema/ColorSchema/COLOR
  */
 export const COLOR = new ColorSchema({});
 /**
- * Valid color hex string, e.g. `#00CCFF`, or `null`
+ * Sugar instance allowing a [`COLOR`](/schema/COLOR) or `null`. Equivalent to `NULLABLE(COLOR)`.
  *
  * @example NULLABLE_COLOR.validate(null); // Returns null
  * @see https://dhoulb.github.io/shelving/schema/ColorSchema/NULLABLE_COLOR

package/schema/CountrySchema.d.ts

@@ -42,14 +42,14 @@ export declare class CountrySchema extends ChoiceSchema<Country, PossibleCountry
     validate(unsafeValue?: unknown): Country;
 }
 /**
- * Valid country code, e.g. `GB` (required because falsy values are invalid).
+ * Sugar instance of [`CountrySchema`](/schema/CountrySchema) for a required ISO 3166 country code, e.g. `GB`. Equivalent to `new CountrySchema({})`.
  *
  * @example COUNTRY.validate("GB") // "GB"
  * @see https://dhoulb.github.io/shelving/schema/CountrySchema/COUNTRY
  */
 export declare const COUNTRY: CountrySchema;
 /**
- * Valid country code, e.g. `GB`, or `null`.
+ * Sugar instance allowing a [`COUNTRY`](/schema/COUNTRY) or `null`. Equivalent to `NULLABLE(COUNTRY)`.
  *
  * @example NULLABLE_COUNTRY.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/CountrySchema/NULLABLE_COUNTRY

package/schema/CountrySchema.js

@@ -40,14 +40,14 @@ export class CountrySchema extends ChoiceSchema {
     }
 }
 /**
- * Valid country code, e.g. `GB` (required because falsy values are invalid).
+ * Sugar instance of [`CountrySchema`](/schema/CountrySchema) for a required ISO 3166 country code, e.g. `GB`. Equivalent to `new CountrySchema({})`.
  *
  * @example COUNTRY.validate("GB") // "GB"
  * @see https://dhoulb.github.io/shelving/schema/CountrySchema/COUNTRY
  */
 export const COUNTRY = new CountrySchema({});
 /**
- * Valid country code, e.g. `GB`, or `null`.
+ * Sugar instance allowing a [`COUNTRY`](/schema/COUNTRY) or `null`. Equivalent to `NULLABLE(COUNTRY)`.
  *
  * @example NULLABLE_COUNTRY.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/CountrySchema/NULLABLE_COUNTRY

package/schema/CurrencyAmountSchema.d.ts

@@ -66,7 +66,7 @@ export declare class CurrencyAmountSchema extends NumberSchema {
 /**
  * Create a `CurrencyAmountSchema` for a non-negative monetary amount in a currency.
  *
- * *Factory for `CurrencyAmountSchema`.*
+ * Sugar factory for [`CurrencyAmountSchema`](/schema/CurrencyAmountSchema).
  *
  * @param currency ISO 4217 currency code that determines the step and symbol.
  * @returns A `CurrencyAmountSchema` validating amounts in `currency`.
@@ -76,21 +76,21 @@ export declare class CurrencyAmountSchema extends NumberSchema {
  */
 export declare function CURRENCY_AMOUNT(currency: CurrencyCode): CurrencyAmountSchema;
 /**
- * Valid US dollar amount, e.g. `12.35`.
+ * Sugar instance of [`CurrencyAmountSchema`](/schema/CurrencyAmountSchema) for a US dollar amount. Equivalent to `new CurrencyAmountSchema({ currency: "USD" })`.
  *
  * @example USD_AMOUNT.validate("12.345") // 12.35
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/USD_AMOUNT
  */
 export declare const USD_AMOUNT: CurrencyAmountSchema;
 /**
- * Valid pound sterling amount, e.g. `12.35`.
+ * Sugar instance of [`CurrencyAmountSchema`](/schema/CurrencyAmountSchema) for a pound sterling amount. Equivalent to `new CurrencyAmountSchema({ currency: "GBP" })`.
  *
  * @example GBP_AMOUNT.validate("12.345") // 12.35
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/GBP_AMOUNT
  */
 export declare const GBP_AMOUNT: CurrencyAmountSchema;
 /**
- * Valid euro amount, e.g. `12.35`.
+ * Sugar instance of [`CurrencyAmountSchema`](/schema/CurrencyAmountSchema) for a euro amount. Equivalent to `new CurrencyAmountSchema({ currency: "EUR" })`.
  *
  * @example EUR_AMOUNT.validate("12.345") // 12.35
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/EUR_AMOUNT
@@ -99,7 +99,7 @@ export declare const EUR_AMOUNT: CurrencyAmountSchema;
 /**
  * Create a `NullableSchema` for an optional monetary amount in a currency, or `null`.
  *
- * *Factory for `NullableSchema`.*
+ * Sugar factory for [`NullableSchema`](/schema/NullableSchema).
  *
  * @param currency ISO 4217 currency code that determines the step and symbol.
  * @returns A `NullableSchema` validating amounts in `currency`, or `null`.
@@ -109,21 +109,21 @@ export declare const EUR_AMOUNT: CurrencyAmountSchema;
  */
 export declare function NULLABLE_CURRENCY_AMOUNT(currency: CurrencyCode): NullableSchema<number>;
 /**
- * Valid US dollar amount, e.g. `12.35`, or `null`.
+ * Sugar instance allowing a [`USD_AMOUNT`](/schema/USD_AMOUNT) or `null`. Equivalent to `NULLABLE(USD_AMOUNT)`.
  *
  * @example NULLABLE_USD_AMOUNT.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/NULLABLE_USD_AMOUNT
  */
 export declare const NULLABLE_USD_AMOUNT: NullableSchema<number>;
 /**
- * Valid pound sterling amount, e.g. `12.35`, or `null`.
+ * Sugar instance allowing a [`GBP_AMOUNT`](/schema/GBP_AMOUNT) or `null`. Equivalent to `NULLABLE(GBP_AMOUNT)`.
  *
  * @example NULLABLE_GBP_AMOUNT.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/NULLABLE_GBP_AMOUNT
  */
 export declare const NULLABLE_GBP_AMOUNT: NullableSchema<number>;
 /**
- * Valid euro amount, e.g. `12.35`, or `null`.
+ * Sugar instance allowing an [`EUR_AMOUNT`](/schema/EUR_AMOUNT) or `null`. Equivalent to `NULLABLE(EUR_AMOUNT)`.
  *
  * @example NULLABLE_EUR_AMOUNT.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/NULLABLE_EUR_AMOUNT

package/schema/CurrencyAmountSchema.js

@@ -62,7 +62,7 @@ export class CurrencyAmountSchema extends NumberSchema {
 /**
  * Create a `CurrencyAmountSchema` for a non-negative monetary amount in a currency.
  *
- * *Factory for `CurrencyAmountSchema`.*
+ * Sugar factory for [`CurrencyAmountSchema`](/schema/CurrencyAmountSchema).
  *
  * @param currency ISO 4217 currency code that determines the step and symbol.
  * @returns A `CurrencyAmountSchema` validating amounts in `currency`.
@@ -74,21 +74,21 @@ export function CURRENCY_AMOUNT(currency) {
     return new CurrencyAmountSchema({ currency });
 }
 /**
- * Valid US dollar amount, e.g. `12.35`.
+ * Sugar instance of [`CurrencyAmountSchema`](/schema/CurrencyAmountSchema) for a US dollar amount. Equivalent to `new CurrencyAmountSchema({ currency: "USD" })`.
  *
  * @example USD_AMOUNT.validate("12.345") // 12.35
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/USD_AMOUNT
  */
 export const USD_AMOUNT = new CurrencyAmountSchema({ currency: "USD" });
 /**
- * Valid pound sterling amount, e.g. `12.35`.
+ * Sugar instance of [`CurrencyAmountSchema`](/schema/CurrencyAmountSchema) for a pound sterling amount. Equivalent to `new CurrencyAmountSchema({ currency: "GBP" })`.
  *
  * @example GBP_AMOUNT.validate("12.345") // 12.35
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/GBP_AMOUNT
  */
 export const GBP_AMOUNT = new CurrencyAmountSchema({ currency: "GBP" });
 /**
- * Valid euro amount, e.g. `12.35`.
+ * Sugar instance of [`CurrencyAmountSchema`](/schema/CurrencyAmountSchema) for a euro amount. Equivalent to `new CurrencyAmountSchema({ currency: "EUR" })`.
  *
  * @example EUR_AMOUNT.validate("12.345") // 12.35
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/EUR_AMOUNT
@@ -97,7 +97,7 @@ export const EUR_AMOUNT = new CurrencyAmountSchema({ currency: "EUR" });
 /**
  * Create a `NullableSchema` for an optional monetary amount in a currency, or `null`.
  *
- * *Factory for `NullableSchema`.*
+ * Sugar factory for [`NullableSchema`](/schema/NullableSchema).
  *
  * @param currency ISO 4217 currency code that determines the step and symbol.
  * @returns A `NullableSchema` validating amounts in `currency`, or `null`.
@@ -109,21 +109,21 @@ export function NULLABLE_CURRENCY_AMOUNT(currency) {
     return NULLABLE(CURRENCY_AMOUNT(currency));
 }
 /**
- * Valid US dollar amount, e.g. `12.35`, or `null`.
+ * Sugar instance allowing a [`USD_AMOUNT`](/schema/USD_AMOUNT) or `null`. Equivalent to `NULLABLE(USD_AMOUNT)`.
  *
  * @example NULLABLE_USD_AMOUNT.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/NULLABLE_USD_AMOUNT
  */
 export const NULLABLE_USD_AMOUNT = NULLABLE(USD_AMOUNT);
 /**
- * Valid pound sterling amount, e.g. `12.35`, or `null`.
+ * Sugar instance allowing a [`GBP_AMOUNT`](/schema/GBP_AMOUNT) or `null`. Equivalent to `NULLABLE(GBP_AMOUNT)`.
  *
  * @example NULLABLE_GBP_AMOUNT.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/NULLABLE_GBP_AMOUNT
  */
 export const NULLABLE_GBP_AMOUNT = NULLABLE(GBP_AMOUNT);
 /**
- * Valid euro amount, e.g. `12.35`, or `null`.
+ * Sugar instance allowing an [`EUR_AMOUNT`](/schema/EUR_AMOUNT) or `null`. Equivalent to `NULLABLE(EUR_AMOUNT)`.
  *
  * @example NULLABLE_EUR_AMOUNT.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/CurrencyAmountSchema/NULLABLE_EUR_AMOUNT

package/schema/CurrencyCodeSchema.d.ts

@@ -58,14 +58,14 @@ export declare class CurrencyCodeSchema extends StringSchema {
     validate(value?: unknown): string;
 }
 /**
- * Valid currency code, e.g. `GBP` (required because falsy values are invalid).
+ * Sugar instance of [`CurrencyCodeSchema`](/schema/CurrencyCodeSchema) for a required ISO 4217 currency code, e.g. `GBP`. Equivalent to `new CurrencyCodeSchema({})`.
  *
  * @example CURRENCY_CODE.validate("gbp") // "GBP"
  * @see https://dhoulb.github.io/shelving/schema/CurrencyCodeSchema/CURRENCY_CODE
  */
 export declare const CURRENCY_CODE: CurrencyCodeSchema;
 /**
- * Valid currency code, e.g. `GBP`, or `null`.
+ * Sugar instance allowing a [`CURRENCY_CODE`](/schema/CURRENCY_CODE) or `null`. Equivalent to `NULLABLE(CURRENCY_CODE)`.
  *
  * @example NULLABLE_CURRENCY_CODE.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/CurrencyCodeSchema/NULLABLE_CURRENCY_CODE

package/schema/CurrencyCodeSchema.js

@@ -67,14 +67,14 @@ export class CurrencyCodeSchema extends StringSchema {
     }
 }
 /**
- * Valid currency code, e.g. `GBP` (required because falsy values are invalid).
+ * Sugar instance of [`CurrencyCodeSchema`](/schema/CurrencyCodeSchema) for a required ISO 4217 currency code, e.g. `GBP`. Equivalent to `new CurrencyCodeSchema({})`.
  *
  * @example CURRENCY_CODE.validate("gbp") // "GBP"
  * @see https://dhoulb.github.io/shelving/schema/CurrencyCodeSchema/CURRENCY_CODE
  */
 export const CURRENCY_CODE = new CurrencyCodeSchema({});
 /**
- * Valid currency code, e.g. `GBP`, or `null`.
+ * Sugar instance allowing a [`CURRENCY_CODE`](/schema/CURRENCY_CODE) or `null`. Equivalent to `NULLABLE(CURRENCY_CODE)`.
  *
  * @example NULLABLE_CURRENCY_CODE.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/CurrencyCodeSchema/NULLABLE_CURRENCY_CODE

package/schema/DataSchema.d.ts

@@ -78,7 +78,7 @@ export declare class DataSchema<T extends Data> extends Schema<unknown> {
 /**
  * Create a `DataSchema` for a set of properties.
  *
- * *Factory for `DataSchema`.*
+ * Sugar factory for [`DataSchema`](/schema/DataSchema).
  *
  * @param props A named schema for each property of the data object.
  * @returns A `DataSchema` validating data with the given props.
@@ -89,7 +89,7 @@ export declare function DATA<T extends Data>(props: Schemas<T>): DataSchema<T>;
 /**
  * Create a schema for a valid data object with specified properties, or `null`.
  *
- * *Factory for `NullableSchema`.*
+ * Sugar factory for [`NullableSchema`](/schema/NullableSchema).
  *
  * @param props A named schema for each property of the data object.
  * @returns A `NullableSchema` wrapping a `DataSchema` with the given props.
@@ -100,7 +100,7 @@ export declare function NULLABLE_DATA<T extends Data>(props: Schemas<T>): Nullab
 /**
  * Create a `DataSchema` that validates partially, i.e. every property can be its value or `undefined`.
  *
- * *Factory for `DataSchema`.*
+ * Sugar factory for [`DataSchema`](/schema/DataSchema).
  *
  * @param source The props schemas or an existing `DataSchema` to make partial.
  * @returns A `DataSchema` whose every property is optional.
@@ -111,7 +111,7 @@ export declare function PARTIAL<T extends Data>(source: Schemas<T> | DataSchema<
 /**
  * Create a `DataSchema` that validates a data item, i.e. it has a string or number `.id` identifier property.
  *
- * *Factory for `DataSchema`.*
+ * Sugar factory for [`DataSchema`](/schema/DataSchema).
  *
  * @param id Schema for the item's `id` identifier property.
  * @param schemas The props schemas or an existing `DataSchema` for the rest of the item.

package/schema/DataSchema.js

@@ -85,7 +85,7 @@ function _getSchemaValue([, { value }]) {
 /**
  * Create a `DataSchema` for a set of properties.
  *
- * *Factory for `DataSchema`.*
+ * Sugar factory for [`DataSchema`](/schema/DataSchema).
  *
  * @param props A named schema for each property of the data object.
  * @returns A `DataSchema` validating data with the given props.
@@ -98,7 +98,7 @@ export function DATA(props) {
 /**
  * Create a schema for a valid data object with specified properties, or `null`.
  *
- * *Factory for `NullableSchema`.*
+ * Sugar factory for [`NullableSchema`](/schema/NullableSchema).
  *
  * @param props A named schema for each property of the data object.
  * @returns A `NullableSchema` wrapping a `DataSchema` with the given props.
@@ -120,7 +120,7 @@ function _optionalProp([, v]) {
 /**
  * Create a `DataSchema` that validates a data item, i.e. it has a string or number `.id` identifier property.
  *
- * *Factory for `DataSchema`.*
+ * Sugar factory for [`DataSchema`](/schema/DataSchema).
  *
  * @param id Schema for the item's `id` identifier property.
  * @param schemas The props schemas or an existing `DataSchema` for the rest of the item.

package/schema/DateSchema.d.ts

@@ -88,14 +88,14 @@ export declare class DateSchema extends Schema<string> {
     format(value: string): string;
 }
 /**
- * Valid date, e.g. `2005-09-12` (required because falsy values are invalid).
+ * Sugar instance of [`DateSchema`](/schema/DateSchema) for a required date. Equivalent to `new DateSchema({})`.
  *
  * @example DATE.validate("2005-09-12") // "2005-09-12"
  * @see https://dhoulb.github.io/shelving/schema/DateSchema/DATE
  */
 export declare const DATE: DateSchema;
 /**
- * Valid date, e.g. `2005-09-12`, or `null`.
+ * Sugar instance allowing a [`DATE`](/schema/DATE) or `null`. Equivalent to `NULLABLE(DATE)`.
  *
  * @example NULLABLE_DATE.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/DateSchema/NULLABLE_DATE

package/schema/DateSchema.js

@@ -79,14 +79,14 @@ export class DateSchema extends Schema {
     }
 }
 /**
- * Valid date, e.g. `2005-09-12` (required because falsy values are invalid).
+ * Sugar instance of [`DateSchema`](/schema/DateSchema) for a required date. Equivalent to `new DateSchema({})`.
  *
  * @example DATE.validate("2005-09-12") // "2005-09-12"
  * @see https://dhoulb.github.io/shelving/schema/DateSchema/DATE
  */
 export const DATE = new DateSchema({});
 /**
- * Valid date, e.g. `2005-09-12`, or `null`.
+ * Sugar instance allowing a [`DATE`](/schema/DATE) or `null`. Equivalent to `NULLABLE(DATE)`.
  *
  * @example NULLABLE_DATE.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/DateSchema/NULLABLE_DATE

package/schema/DateTimeSchema.d.ts

@@ -38,14 +38,14 @@ export declare class DateTimeSchema extends DateSchema {
     format(value: string): string;
 }
 /**
- * Valid datetime, e.g. `2005-09-12T08:00:00Z` (required because falsy values are invalid).
+ * Sugar instance of [`DateTimeSchema`](/schema/DateTimeSchema) for a required UTC datetime. Equivalent to `new DateTimeSchema({})`.
  *
  * @example DATETIME.validate("2005-09-12T08:00:00Z") // "2005-09-12T08:00:00.000Z"
  * @see https://dhoulb.github.io/shelving/schema/DateTimeSchema/DATETIME
  */
 export declare const DATETIME: DateTimeSchema;
 /**
- * Valid datetime, e.g. `2005-09-12T21:30:00Z`, or `null`.
+ * Sugar instance allowing a [`DATETIME`](/schema/DATETIME) or `null`. Equivalent to `NULLABLE(DATETIME)`.
  *
  * @example NULLABLE_DATETIME.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/DateTimeSchema/NULLABLE_DATETIME

package/schema/DateTimeSchema.js

@@ -46,14 +46,14 @@ export class DateTimeSchema extends DateSchema {
     }
 }
 /**
- * Valid datetime, e.g. `2005-09-12T08:00:00Z` (required because falsy values are invalid).
+ * Sugar instance of [`DateTimeSchema`](/schema/DateTimeSchema) for a required UTC datetime. Equivalent to `new DateTimeSchema({})`.
  *
  * @example DATETIME.validate("2005-09-12T08:00:00Z") // "2005-09-12T08:00:00.000Z"
  * @see https://dhoulb.github.io/shelving/schema/DateTimeSchema/DATETIME
  */
 export const DATETIME = new DateTimeSchema({});
 /**
- * Valid datetime, e.g. `2005-09-12T21:30:00Z`, or `null`.
+ * Sugar instance allowing a [`DATETIME`](/schema/DATETIME) or `null`. Equivalent to `NULLABLE(DATETIME)`.
  *
  * @example NULLABLE_DATETIME.validate(null) // null
  * @see https://dhoulb.github.io/shelving/schema/DateTimeSchema/NULLABLE_DATETIME

package/schema/DictionarySchema.d.ts

@@ -62,7 +62,7 @@ export declare class DictionarySchema<T> extends Schema<ImmutableDictionary<T>>
 /**
  * Create a schema for a valid dictionary object with specified entry values.
  *
- * *Factory for `DictionarySchema`.*
+ * Sugar factory for [`DictionarySchema`](/schema/DictionarySchema).
  *
  * @param items Schema every entry value in the dictionary must conform to.
  * @returns A `DictionarySchema` validating dictionaries of the given item type.

package/schema/DictionarySchema.js

@@ -64,7 +64,7 @@ export class DictionarySchema extends Schema {
 /**
  * Create a schema for a valid dictionary object with specified entry values.
  *
- * *Factory for `DictionarySchema`.*
+ * Sugar factory for [`DictionarySchema`](/schema/DictionarySchema).
  *
  * @param items Schema every entry value in the dictionary must conform to.
  * @returns A `DictionarySchema` validating dictionaries of the given item type.