effect 4.0.0-beta.69 → 4.0.0-beta.70

package/dist/Predicate.js

@@ -43,11 +43,13 @@ import { dual } from "./Function.js";
 /**
  * Transforms the input of a predicate using a mapping function.
  *
- * When to use:
+ * **When to use**
+ *
  * - You have a predicate on `A` and want one on `B` via `B -> A`.
  * - You want to check derived values (lengths, projections, etc.).
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns a new predicate that applies `f` before `self`.
  * - No short-circuit beyond what `self` does.
@@ -64,8 +66,9 @@ import { dual } from "./Function.js";
  * console.log(isLongerThan2("hello"))
  * ```
  *
- * See also: {@link Predicate}, {@link and}, {@link not}
- *
+ * @see {@link Predicate}
+ * @see {@link and}
+ * @see {@link not}
  * @category combinators
  * @since 2.0.0
  */
@@ -73,11 +76,13 @@ export const mapInput = /*#__PURE__*/dual(2, (self, f) => b => self(f(b)));
 /**
  * Checks whether a readonly array has exactly `n` elements.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need a runtime check for tuple length.
  * - You want to narrow `ReadonlyArray<T>` to `TupleOf<N, T>`.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Only checks length, not element types.
  * - Returns a refinement on the array type.
@@ -92,8 +97,8 @@ export const mapInput = /*#__PURE__*/dual(2, (self, f) => b => self(f(b)));
  * console.log(isPair([1, 2]))
  * ```
  *
- * See also: {@link isTupleOfAtLeast}, {@link Tuple}
- *
+ * @see {@link isTupleOfAtLeast}
+ * @see {@link Tuple}
  * @category guards
  * @since 3.3.0
  */
@@ -101,11 +106,13 @@ export const isTupleOf = /*#__PURE__*/dual(2, (self, n) => self.length === n);
 /**
  * Checks whether a readonly array has at least `n` elements.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need a runtime check for tuple-like minimum length.
  * - You want to narrow `ReadonlyArray<T>` to `TupleOfAtLeast<N, T>`.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Only checks length, not element types.
  * - Returns a refinement on the array type.
@@ -120,8 +127,8 @@ export const isTupleOf = /*#__PURE__*/dual(2, (self, n) => self.length === n);
  * console.log(hasAtLeast2([1, 2, 3]))
  * ```
  *
- * See also: {@link isTupleOf}, {@link Tuple}
- *
+ * @see {@link isTupleOf}
+ * @see {@link Tuple}
  * @category guards
  * @since 3.3.0
  */
@@ -129,11 +136,13 @@ export const isTupleOfAtLeast = /*#__PURE__*/dual(2, (self, n) => self.length >=
 /**
  * Checks whether a value is truthy.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want a predicate that mirrors JavaScript truthiness.
  * - You need to filter out falsy values like `0`, "", and `false`.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `!!input` under the hood.
  * - Treats `0`, "", `false`, `null`, and `undefined` as false.
@@ -149,8 +158,8 @@ export const isTupleOfAtLeast = /*#__PURE__*/dual(2, (self, n) => self.length >=
  * console.log(truthy)
  * ```
  *
- * See also: {@link isNullish}, {@link isNotNullish}
- *
+ * @see {@link isNullish}
+ * @see {@link isNotNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -160,10 +169,12 @@ export function isTruthy(input) {
 /**
  * Checks whether a value is a `Set`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need a runtime guard for `Set` values.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `instanceof Set`.
  *
@@ -179,8 +190,8 @@ export function isTruthy(input) {
  * }
  * ```
  *
- * See also: {@link isMap}, {@link isIterable}
- *
+ * @see {@link isMap}
+ * @see {@link isIterable}
  * @category guards
  * @since 2.0.0
  */
@@ -190,10 +201,12 @@ export function isSet(input) {
 /**
  * Checks whether a value is a `Map`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need a runtime guard for `Map` values.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `instanceof Map`.
  *
@@ -209,8 +222,8 @@ export function isSet(input) {
  * }
  * ```
  *
- * See also: {@link isSet}, {@link isIterable}
- *
+ * @see {@link isSet}
+ * @see {@link isIterable}
  * @category guards
  * @since 2.0.0
  */
@@ -220,11 +233,13 @@ export function isMap(input) {
 /**
  * Checks whether a value is a `string`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to guard an `unknown` value as a string.
  * - You want to narrow in `if` statements.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `typeof input === "string"`.
  *
@@ -240,8 +255,9 @@ export function isMap(input) {
  * }
  * ```
  *
- * See also: {@link isNumber}, {@link isBoolean}, {@link Refinement}
- *
+ * @see {@link isNumber}
+ * @see {@link isBoolean}
+ * @see {@link Refinement}
  * @category guards
  * @since 2.0.0
  */
@@ -251,10 +267,12 @@ export function isString(input) {
 /**
  * Checks whether a value is a `number`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to guard an `unknown` value as a number.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `typeof input === "number"`.
  * - Does not exclude `NaN` or `Infinity`.
@@ -271,8 +289,8 @@ export function isString(input) {
  * }
  * ```
  *
- * See also: {@link isBigInt}, {@link isString}
- *
+ * @see {@link isBigInt}
+ * @see {@link isString}
  * @category guards
  * @since 2.0.0
  */
@@ -282,10 +300,12 @@ export function isNumber(input) {
 /**
  * Checks whether a value is a `boolean`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to guard an `unknown` value as a boolean.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `typeof input === "boolean"`.
  *
@@ -301,8 +321,8 @@ export function isNumber(input) {
  * }
  * ```
  *
- * See also: {@link isString}, {@link isNumber}
- *
+ * @see {@link isString}
+ * @see {@link isNumber}
  * @category guards
  * @since 2.0.0
  */
@@ -312,10 +332,12 @@ export function isBoolean(input) {
 /**
  * Checks whether a value is a `bigint`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to guard an `unknown` value as a bigint.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `typeof input === "bigint"`.
  *
@@ -331,8 +353,7 @@ export function isBoolean(input) {
  * }
  * ```
  *
- * See also: {@link isNumber}
- *
+ * @see {@link isNumber}
  * @category guards
  * @since 2.0.0
  */
@@ -342,10 +363,12 @@ export function isBigInt(input) {
 /**
  * Checks whether a value is a `symbol`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to guard an `unknown` value as a symbol.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `typeof input === "symbol"`.
  *
@@ -361,8 +384,7 @@ export function isBigInt(input) {
  * }
  * ```
  *
- * See also: {@link isPropertyKey}
- *
+ * @see {@link isPropertyKey}
  * @category guards
  * @since 2.0.0
  */
@@ -372,10 +394,12 @@ export function isSymbol(input) {
 /**
  * Checks whether a value is a valid `PropertyKey` (string, number, or symbol).
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to guard unknown keys before indexing.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses {@link isString}, {@link isNumber}, and {@link isSymbol}.
  *
@@ -392,8 +416,9 @@ export function isSymbol(input) {
  * }
  * ```
  *
- * See also: {@link isString}, {@link isNumber}, {@link isSymbol}
- *
+ * @see {@link isString}
+ * @see {@link isNumber}
+ * @see {@link isSymbol}
  * @category guards
  * @since 4.0.0
  */
@@ -403,10 +428,12 @@ export function isPropertyKey(u) {
 /**
  * Checks whether a value is a `function`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to guard an `unknown` value as callable.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `typeof input === "function"`.
  *
@@ -422,8 +449,7 @@ export function isPropertyKey(u) {
  * }
  * ```
  *
- * See also: {@link isObjectKeyword}
- *
+ * @see {@link isObjectKeyword}
  * @category guards
  * @since 2.0.0
  */
@@ -433,10 +459,12 @@ export function isFunction(input) {
 /**
  * Checks whether a value is `undefined`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need a guard for optional values.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `input === undefined`.
  *
@@ -450,8 +478,8 @@ export function isFunction(input) {
  * console.log(Predicate.isUndefined(data))
  * ```
  *
- * See also: {@link isNotUndefined}, {@link isNullish}
- *
+ * @see {@link isNotUndefined}
+ * @see {@link isNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -461,10 +489,12 @@ export function isUndefined(input) {
 /**
  * Checks whether a value is not `undefined`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to filter out `undefined` while preserving other falsy values.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns a refinement that excludes `undefined`.
  *
@@ -479,8 +509,8 @@ export function isUndefined(input) {
  * console.log(defined)
  * ```
  *
- * See also: {@link isUndefined}, {@link isNotNullish}
- *
+ * @see {@link isUndefined}
+ * @see {@link isNotNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -490,10 +520,12 @@ export function isNotUndefined(input) {
 /**
  * Checks whether a value is `null`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need a guard for nullable values.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `input === null`.
  *
@@ -507,8 +539,8 @@ export function isNotUndefined(input) {
  * console.log(Predicate.isNull(data))
  * ```
  *
- * See also: {@link isNotNull}, {@link isNullish}
- *
+ * @see {@link isNotNull}
+ * @see {@link isNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -518,10 +550,12 @@ export function isNull(input) {
 /**
  * Checks whether a value is not `null`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to filter out `null` while preserving other falsy values.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns a refinement that excludes `null`.
  *
@@ -536,8 +570,8 @@ export function isNull(input) {
  * console.log(nonNull)
  * ```
  *
- * See also: {@link isNull}, {@link isNotNullish}
- *
+ * @see {@link isNull}
+ * @see {@link isNotNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -547,10 +581,12 @@ export function isNotNull(input) {
 /**
  * Checks whether a value is `null` or `undefined`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to guard nullish values explicitly.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `input === null || input === undefined`.
  *
@@ -565,8 +601,9 @@ export function isNotNull(input) {
  * console.log(nullish)
  * ```
  *
- * See also: {@link isNotNullish}, {@link isUndefined}, {@link isNull}
- *
+ * @see {@link isNotNullish}
+ * @see {@link isUndefined}
+ * @see {@link isNull}
  * @category guards
  * @since 4.0.0
  */
@@ -576,10 +613,12 @@ export function isNullish(input) {
 /**
  * Checks whether a value is not `null` and not `undefined`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to filter out nullish values but keep other falsy ones.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `input != null`.
  *
@@ -594,8 +633,9 @@ export function isNullish(input) {
  * console.log(present)
  * ```
  *
- * See also: {@link isNullish}, {@link isNotNull}, {@link isNotUndefined}
- *
+ * @see {@link isNullish}
+ * @see {@link isNotNull}
+ * @see {@link isNotUndefined}
  * @category guards
  * @since 4.0.0
  */
@@ -605,10 +645,12 @@ export function isNotNullish(input) {
 /**
  * A guard that always returns `false`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need a predicate that never accepts, e.g. in default branches.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Always returns `false`.
  *
@@ -620,8 +662,7 @@ export function isNotNullish(input) {
  * console.log(Predicate.isNever("anything"))
  * ```
  *
- * See also: {@link isUnknown}
- *
+ * @see {@link isUnknown}
  * @category guards
  * @since 2.0.0
  */
@@ -631,10 +672,12 @@ export function isNever(_) {
 /**
  * A guard that always returns `true`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need a predicate that always accepts, e.g. as a placeholder.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Always returns `true`.
  *
@@ -646,8 +689,7 @@ export function isNever(_) {
  * console.log(Predicate.isUnknown(123))
  * ```
  *
- * See also: {@link isNever}
- *
+ * @see {@link isNever}
  * @category guards
  * @since 2.0.0
  */
@@ -657,10 +699,12 @@ export function isUnknown(_) {
 /**
  * Checks whether a value is an object or an array (non-null object).
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to accept plain objects and arrays, but not `null`.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `typeof input === "object" && input !== null`.
  * - Includes arrays.
@@ -673,8 +717,8 @@ export function isUnknown(_) {
  * console.log(Predicate.isObjectOrArray([]))
  * ```
  *
- * See also: {@link isObject}, {@link isObjectKeyword}
- *
+ * @see {@link isObject}
+ * @see {@link isObjectKeyword}
  * @category guards
  * @since 4.0.0
  */
@@ -684,6 +728,8 @@ export function isObjectOrArray(input) {
 /**
  * Checks whether a value is a non-null object value that is not an array.
  *
+ * **Details**
+ *
  * This is a structural runtime check using `typeof input === "object"`, so it
  * also accepts object instances such as `Date`, `Map`, class instances, and
  * typed arrays. It excludes `null` and arrays.
@@ -697,8 +743,8 @@ export function isObjectOrArray(input) {
  * console.log(Predicate.isObject([1, 2]))
  * ```
  *
- * See also: {@link isObjectOrArray}, {@link isReadonlyObject}
- *
+ * @see {@link isObjectOrArray}
+ * @see {@link isReadonlyObject}
  * @category guards
  * @since 2.0.0
  */
@@ -709,6 +755,8 @@ export function isObject(input) {
  * Checks whether a value is a non-null, non-array object and narrows it to a
  * readonly indexable object type.
  *
+ * **Details**
+ *
  * Readonly-ness is a TypeScript type-level view; it is not observable at
  * runtime. This delegates to `isObject`, so class instances and built-in object
  * instances are accepted.
@@ -723,8 +771,7 @@ export function isObject(input) {
  * console.log(Predicate.isReadonlyObject(data))
  * ```
  *
- * See also: {@link isObject}
- *
+ * @see {@link isObject}
  * @category guards
  * @since 4.0.0
  */
@@ -734,10 +781,12 @@ export function isReadonlyObject(input) {
 /**
  * Checks whether a value is an `object` in the JavaScript sense (objects, arrays, functions).
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to accept arrays and functions as well as objects.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns `true` for arrays and functions, `false` for `null`.
  *
@@ -750,8 +799,8 @@ export function isReadonlyObject(input) {
  * console.log(Predicate.isObjectKeyword(null))
  * ```
  *
- * See also: {@link isObject}, {@link isObjectOrArray}
- *
+ * @see {@link isObject}
+ * @see {@link isObjectOrArray}
  * @category guards
  * @since 4.0.0
  */
@@ -761,11 +810,13 @@ export function isObjectKeyword(input) {
 /**
  * Checks whether a value has a given property key.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to guard property access on `unknown` values.
  * - You want a simple structural guard for objects.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses the `in` operator and {@link isObjectKeyword}.
  * - Does not check property value types.
@@ -783,8 +834,8 @@ export function isObjectKeyword(input) {
  * }
  * ```
  *
- * See also: {@link isTagged}, {@link isObjectKeyword}
- *
+ * @see {@link isTagged}
+ * @see {@link isObjectKeyword}
  * @category guards
  * @since 2.0.0
  */
@@ -792,11 +843,13 @@ export const hasProperty = /*#__PURE__*/dual(2, (self, property) => isObjectKeyw
 /**
  * Checks whether a value has a `_tag` property equal to the given tag.
  *
- * When to use:
+ * **When to use**
+ *
  * - You model tagged unions with a `_tag` field.
  * - You want a quick, structural guard for tagged values.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses {@link hasProperty} and strict equality on `_tag`.
  *
@@ -810,8 +863,7 @@ export const hasProperty = /*#__PURE__*/dual(2, (self, property) => isObjectKeyw
  * console.log(isOk({ _tag: "Ok", value: 1 }))
  * ```
  *
- * See also: {@link hasProperty}
- *
+ * @see {@link hasProperty}
  * @category guards
  * @since 2.0.0
  */
@@ -819,10 +871,12 @@ export const isTagged = /*#__PURE__*/dual(2, (self, tag) => hasProperty(self, "_
 /**
  * Checks whether a value is an `Error`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to guard errors caught from unknown sources.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `instanceof Error`.
  *
@@ -836,8 +890,7 @@ export const isTagged = /*#__PURE__*/dual(2, (self, tag) => hasProperty(self, "_
  * console.log(Predicate.isError(data))
  * ```
  *
- * See also: {@link isUnknown}
- *
+ * @see {@link isUnknown}
  * @category guards
  * @since 2.0.0
  */
@@ -847,10 +900,12 @@ export function isError(input) {
 /**
  * Checks whether a value is a `Uint8Array`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to guard binary data at runtime.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `instanceof Uint8Array`.
  *
@@ -864,8 +919,8 @@ export function isError(input) {
  * console.log(Predicate.isUint8Array(data))
  * ```
  *
- * See also: {@link isIterable}, {@link isSet}
- *
+ * @see {@link isIterable}
+ * @see {@link isSet}
  * @category guards
  * @since 2.0.0
  */
@@ -875,10 +930,12 @@ export function isUint8Array(input) {
 /**
  * Checks whether a value is a `Date`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to guard dates at runtime.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `instanceof Date`.
  *
@@ -892,8 +949,7 @@ export function isUint8Array(input) {
  * console.log(Predicate.isDate(data))
  * ```
  *
- * See also: {@link isRegExp}
- *
+ * @see {@link isRegExp}
  * @category guards
  * @since 2.0.0
  */
@@ -903,10 +959,12 @@ export function isDate(input) {
 /**
  * Checks whether a value is iterable.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need a guard before iterating an unknown value.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Accepts strings as iterable.
  * - Uses {@link hasProperty} for `Symbol.iterator`.
@@ -921,8 +979,8 @@ export function isDate(input) {
  * console.log(Predicate.isIterable(data))
  * ```
  *
- * See also: {@link isSet}, {@link isMap}
- *
+ * @see {@link isSet}
+ * @see {@link isMap}
  * @category guards
  * @since 2.0.0
  */
@@ -932,10 +990,12 @@ export function isIterable(input) {
 /**
  * Checks whether a value is a `Promise`-like object with `then` and `catch`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to detect promise instances across realms.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Structural check for `then` and `catch` functions.
  *
@@ -949,8 +1009,7 @@ export function isIterable(input) {
  * console.log(Predicate.isPromise(data))
  * ```
  *
- * See also: {@link isPromiseLike}
- *
+ * @see {@link isPromiseLike}
  * @category guards
  * @since 2.0.0
  */
@@ -960,10 +1019,12 @@ export function isPromise(input) {
 /**
  * Checks whether a value is `PromiseLike` (has a `then` method).
  *
- * When to use:
+ * **When to use**
+ *
  * - You only need `then` to interop with promise-like values.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Structural check for a callable `then`.
  *
@@ -977,8 +1038,7 @@ export function isPromise(input) {
  * console.log(Predicate.isPromiseLike(data))
  * ```
  *
- * See also: {@link isPromise}
- *
+ * @see {@link isPromise}
  * @category guards
  * @since 2.0.0
  */
@@ -988,10 +1048,12 @@ export function isPromiseLike(input) {
 /**
  * Checks whether a value is a `RegExp`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need a runtime guard for regular expressions.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Uses `instanceof RegExp`.
  *
@@ -1005,8 +1067,7 @@ export function isPromiseLike(input) {
  * console.log(Predicate.isRegExp(data))
  * ```
  *
- * See also: {@link isDate}
- *
+ * @see {@link isDate}
  * @category guards
  * @since 3.9.0
  */
@@ -1016,11 +1077,13 @@ export function isRegExp(input) {
 /**
  * Composes two predicates or refinements into one.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to chain two refinements for progressive narrowing.
  * - You want a predicate that applies two checks in sequence.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - For refinements, the output type is narrowed by both.
  * - Short-circuits on the first `false`.
@@ -1038,8 +1101,8 @@ export function isRegExp(input) {
  * console.log(isIntegerNumber(1))
  * ```
  *
- * See also: {@link and}, {@link Refinement}
- *
+ * @see {@link and}
+ * @see {@link Refinement}
  * @category combinators
  * @since 2.0.0
  */
@@ -1047,11 +1110,13 @@ export const compose = /*#__PURE__*/dual(2, (ab, bc) => a => ab(a) && bc(a));
 /**
  * Creates a predicate for tuples by applying predicates to each element.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to validate tuple positions independently.
  * - You want to lift element predicates into a tuple predicate.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns a refinement if any element predicate is a refinement.
  * - Stops at the first failing element.
@@ -1066,8 +1131,8 @@ export const compose = /*#__PURE__*/dual(2, (ab, bc) => a => ab(a) && bc(a));
  * console.log(tupleCheck([1, "ok"]))
  * ```
  *
- * See also: {@link Struct}, {@link isTupleOf}
- *
+ * @see {@link Struct}
+ * @see {@link isTupleOf}
  * @category combinators
  * @since 4.0.0
  */
@@ -1084,11 +1149,13 @@ export function Tuple(elements) {
 /**
  * Creates a predicate for objects by applying predicates to named properties.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to validate a record shape at runtime.
  * - You want to lift property predicates into an object predicate.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns a refinement if any field predicate is a refinement.
  * - Checks only the specified keys; extra keys are ignored.
@@ -1106,8 +1173,8 @@ export function Tuple(elements) {
  * console.log(userCheck({ id: 1, name: "Ada" }))
  * ```
  *
- * See also: {@link Tuple}, {@link hasProperty}
- *
+ * @see {@link Tuple}
+ * @see {@link hasProperty}
  * @category combinators
  * @since 4.0.0
  */
@@ -1125,10 +1192,12 @@ export function Struct(fields) {
 /**
  * Negates a predicate.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want the inverse of an existing predicate.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns a new predicate that flips the boolean result.
  *
@@ -1142,8 +1211,9 @@ export function Struct(fields) {
  * console.log(isNotString(1))
  * ```
  *
- * See also: {@link and}, {@link or}, {@link xor}
- *
+ * @see {@link and}
+ * @see {@link or}
+ * @see {@link xor}
  * @category combinators
  * @since 2.0.0
  */
@@ -1153,11 +1223,13 @@ export function not(self) {
 /**
  * Creates a predicate that returns `true` if either predicate is `true`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to accept values that satisfy at least one condition.
  * - You want to combine refinements with union narrowing.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Short-circuits on the first `true`.
  * - For refinements, the output type is a union.
@@ -1172,8 +1244,8 @@ export function not(self) {
  * console.log(isStringOrNumber("a"))
  * ```
  *
- * See also: {@link and}, {@link xor}
- *
+ * @see {@link and}
+ * @see {@link xor}
  * @category combinators
  * @since 2.0.0
  */
@@ -1181,11 +1253,13 @@ export const or = /*#__PURE__*/dual(2, (self, that) => a => self(a) || that(a));
 /**
  * Creates a predicate that returns `true` only if both predicates are `true`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to accept values that satisfy multiple conditions.
  * - You want to combine refinements with intersection narrowing.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Short-circuits on the first `false`.
  * - For refinements, the output type is an intersection.
@@ -1208,8 +1282,8 @@ export const or = /*#__PURE__*/dual(2, (self, that) => a => self(a) || that(a));
  * }
  * ```
  *
- * See also: {@link or}, {@link not}
- *
+ * @see {@link or}
+ * @see {@link not}
  * @category combinators
  * @since 2.0.0
  */
@@ -1217,10 +1291,12 @@ export const and = /*#__PURE__*/dual(2, (self, that) => a => self(a) && that(a))
 /**
  * Creates a predicate that returns `true` if exactly one predicate is `true`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want an exclusive-or between two conditions.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns `true` when results differ.
  *
@@ -1236,8 +1312,8 @@ export const and = /*#__PURE__*/dual(2, (self, that) => a => self(a) && that(a))
  * console.log(either(-2))
  * ```
  *
- * See also: {@link or}, {@link and}
- *
+ * @see {@link or}
+ * @see {@link and}
  * @category combinators
  * @since 2.0.0
  */
@@ -1245,10 +1321,12 @@ export const xor = /*#__PURE__*/dual(2, (self, that) => a => self(a) !== that(a)
 /**
  * Creates a predicate that returns `true` when both predicates agree.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want to check equivalence of two predicates.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns `true` when both results are equal.
  *
@@ -1263,8 +1341,7 @@ export const xor = /*#__PURE__*/dual(2, (self, that) => a => self(a) !== that(a)
  * console.log(same(3))
  * ```
  *
- * See also: {@link xor}
- *
+ * @see {@link xor}
  * @category combinators
  * @since 2.0.0
  */
@@ -1272,11 +1349,13 @@ export const eqv = /*#__PURE__*/dual(2, (self, that) => a => self(a) === that(a)
 /**
  * Creates a predicate representing logical implication: if `antecedent`, then `consequent`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want a rule that only applies when a precondition holds.
  * - You model constraints like "if A then B".
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns `true` when the antecedent is `false`.
  *
@@ -1292,8 +1371,8 @@ export const eqv = /*#__PURE__*/dual(2, (self, that) => a => self(a) === that(a)
  * console.log(implies(16))
  * ```
  *
- * See also: {@link and}, {@link or}
- *
+ * @see {@link and}
+ * @see {@link or}
  * @category combinators
  * @since 2.0.0
  */
@@ -1301,10 +1380,12 @@ export const implies = /*#__PURE__*/dual(2, (antecedent, consequent) => a => ant
 /**
  * Creates a predicate that returns `true` when neither predicate is `true`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want the logical NOR of two conditions.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns the negation of {@link or}.
  *
@@ -1318,8 +1399,8 @@ export const implies = /*#__PURE__*/dual(2, (antecedent, consequent) => a => ant
  * console.log(neither(true))
  * ```
  *
- * See also: {@link or}, {@link not}
- *
+ * @see {@link or}
+ * @see {@link not}
  * @category combinators
  * @since 2.0.0
  */
@@ -1327,10 +1408,12 @@ export const nor = /*#__PURE__*/dual(2, (self, that) => a => !(self(a) || that(a
 /**
  * Creates a predicate that returns `true` unless both predicates are `true`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want the logical NAND of two conditions.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Returns the negation of {@link and}.
  *
@@ -1344,8 +1427,8 @@ export const nor = /*#__PURE__*/dual(2, (self, that) => a => !(self(a) || that(a
  * console.log(notBoth("a"))
  * ```
  *
- * See also: {@link and}, {@link not}
- *
+ * @see {@link and}
+ * @see {@link not}
  * @category combinators
  * @since 2.0.0
  */
@@ -1353,10 +1436,12 @@ export const nand = /*#__PURE__*/dual(2, (self, that) => a => !(self(a) && that(
 /**
  * Creates a predicate that returns `true` if all predicates in the collection return `true`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You have a dynamic list of predicates to apply.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Short-circuits on the first `false`.
  * - Iterates the collection each time the predicate is called.
@@ -1371,8 +1456,8 @@ export const nand = /*#__PURE__*/dual(2, (self, that) => a => !(self(a) && that(
  * console.log(allChecks(2))
  * ```
  *
- * See also: {@link some}, {@link and}
- *
+ * @see {@link some}
+ * @see {@link and}
  * @category elements
  * @since 2.0.0
  */
@@ -1389,10 +1474,12 @@ export function every(collection) {
 /**
  * Creates a predicate that returns `true` if any predicate in the collection returns `true`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You have a dynamic list of predicates and only need one to pass.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure; does not mutate input.
  * - Short-circuits on the first `true`.
  * - Iterates the collection each time the predicate is called.
@@ -1407,8 +1494,8 @@ export function every(collection) {
  * console.log(anyCheck("ok"))
  * ```
  *
- * See also: {@link every}, {@link or}
- *
+ * @see {@link every}
+ * @see {@link or}
  * @category elements
  * @since 2.0.0
  */