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

package/dist/Predicate.d.ts

@@ -3,12 +3,14 @@ import type { TupleOf, TupleOfAtLeast } from "./Types.ts";
 /**
  * A function that decides whether a value of type `A` satisfies a condition.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want a reusable boolean check for `A`.
  * - You plan to combine checks with {@link and}/{@link or}.
  * - You want a simple filter predicate for arrays or iterables.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure function; does not mutate input.
  * - Returns `true` or `false`; never throws by itself.
  * - Does not narrow types unless you use {@link Refinement}.
@@ -23,8 +25,9 @@ import type { TupleOf, TupleOfAtLeast } from "./Types.ts";
  * console.log(isPositive(1))
  * ```
  *
- * See also: {@link Refinement}, {@link mapInput}, {@link and}
- *
+ * @see {@link Refinement}
+ * @see {@link mapInput}
+ * @see {@link and}
  * @category models
  * @since 2.0.0
  */
@@ -34,11 +37,13 @@ export interface Predicate<in A> {
 /**
  * Type-level lambda for higher-kinded usage of {@link Predicate}.
  *
- * When to use:
+ * **When to use**
+ *
  * - You are defining APIs that abstract over predicates with HKTs.
  * - You need a `TypeLambda` instance for predicate-based type classes.
  *
- * Behavior:
+ * **Details**
+ *
  * - Type-only; no runtime value is created.
  * - Does not affect emitted JavaScript.
  *
@@ -51,8 +56,7 @@ export interface Predicate<in A> {
  * type TL = Predicate.PredicateTypeLambda
  * ```
  *
- * See also: {@link Predicate}
- *
+ * @see {@link Predicate}
  * @category type lambdas
  * @since 2.0.0
  */
@@ -62,12 +66,14 @@ export interface PredicateTypeLambda extends TypeLambda {
 /**
  * A predicate that also narrows the input type when it returns `true`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You want a runtime check that refines `A` to `B` for TypeScript.
  * - You want to compose multiple type guards with {@link compose}.
  * - You need to guard `unknown` values safely.
  *
- * Behavior:
+ * **Details**
+ *
  * - Pure function; does not mutate input.
  * - Returns a type predicate (`a is B`).
  * - Use with `if`/`filter` to narrow types.
@@ -85,8 +91,9 @@ export interface PredicateTypeLambda extends TypeLambda {
  * }
  * ```
  *
- * See also: {@link Predicate}, {@link compose}, {@link isString}
- *
+ * @see {@link Predicate}
+ * @see {@link compose}
+ * @see {@link isString}
  * @category models
  * @since 2.0.0
  */
@@ -96,11 +103,13 @@ export interface Refinement<in A, out B extends A> {
 /**
  * Type-level utilities for working with {@link Predicate} types.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to extract input types from predicate signatures.
  * - You want to write generic helpers over predicate types.
  *
- * Behavior:
+ * **Details**
+ *
  * - Type-only; no runtime value is created.
  * - The namespace is erased at runtime.
  *
@@ -113,19 +122,21 @@ export interface Refinement<in A, out B extends A> {
  * type Input = Predicate.Predicate.In<IsString>
  * ```
  *
- * See also: {@link Predicate}, {@link Refinement}
- *
+ * @see {@link Predicate}
+ * @see {@link Refinement}
  * @since 3.6.0
  */
 export declare namespace Predicate {
     /**
      * Extracts the input type `A` from a `Predicate<A>`.
      *
-     * When to use:
+     * **When to use**
+     *
      * - You want to infer the input type from a predicate type.
      * - You are defining generic utilities over predicates.
      *
-     * Behavior:
+     * **Details**
+     *
      * - Type-only; no runtime value is created.
      * - Resolves to `never` if the type does not match `Predicate`.
      *
@@ -138,8 +149,8 @@ export declare namespace Predicate {
      * type Input = Predicate.Predicate.In<P>
      * ```
      *
-     * See also: {@link Predicate.Any}, {@link Refinement.In}
-     *
+     * @see {@link Predicate.Any}
+     * @see {@link Refinement.In}
      * @category type-level
      * @since 3.6.0
      */
@@ -147,10 +158,12 @@ export declare namespace Predicate {
     /**
      * A utility type representing any predicate type.
      *
-     * When to use:
+     * **When to use**
+     *
      * - You need a constraint for "any predicate" in generic code.
      *
-     * Behavior:
+     * **Details**
+     *
      * - Type-only; no runtime value is created.
      *
      * **Example** (Generic constraint)
@@ -161,8 +174,7 @@ export declare namespace Predicate {
      * type AnyPredicate = Predicate.Predicate.Any
      * ```
      *
-     * See also: {@link Predicate.In}
-     *
+     * @see {@link Predicate.In}
      * @category type-level
      * @since 3.6.0
      */
@@ -171,11 +183,13 @@ export declare namespace Predicate {
 /**
  * Type-level utilities for working with {@link Refinement} types.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need to extract input/output types from refinement signatures.
  * - You want to write generic helpers over refinements.
  *
- * Behavior:
+ * **Details**
+ *
  * - Type-only; no runtime value is created.
  * - The namespace is erased at runtime.
  *
@@ -189,18 +203,20 @@ export declare namespace Predicate {
  * type Output = Predicate.Refinement.Out<IsString>
  * ```
  *
- * See also: {@link Refinement}, {@link Predicate}
- *
+ * @see {@link Refinement}
+ * @see {@link Predicate}
  * @since 3.6.0
  */
 export declare namespace Refinement {
     /**
      * Extracts the input type `A` from a `Refinement<A, B>`.
      *
-     * When to use:
+     * **When to use**
+     *
      * - You want to infer the input type from a refinement type.
      *
-     * Behavior:
+     * **Details**
+     *
      * - Type-only; no runtime value is created.
      * - Resolves to `never` if the type does not match `Refinement`.
      *
@@ -213,8 +229,8 @@ export declare namespace Refinement {
      * type Input = Predicate.Refinement.In<R>
      * ```
      *
-     * See also: {@link Refinement.Out}, {@link Predicate.In}
-     *
+     * @see {@link Refinement.Out}
+     * @see {@link Predicate.In}
      * @category type-level
      * @since 3.6.0
      */
@@ -222,10 +238,12 @@ export declare namespace Refinement {
     /**
      * Extracts the output type `B` from a `Refinement<A, B>`.
      *
-     * When to use:
+     * **When to use**
+     *
      * - You want to infer the narrowed type from a refinement type.
      *
-     * Behavior:
+     * **Details**
+     *
      * - Type-only; no runtime value is created.
      * - Resolves to `never` if the type does not match `Refinement`.
      *
@@ -238,8 +256,7 @@ export declare namespace Refinement {
      * type Output = Predicate.Refinement.Out<R>
      * ```
      *
-     * See also: {@link Refinement.In}
-     *
+     * @see {@link Refinement.In}
      * @category type-level
      * @since 3.6.0
      */
@@ -247,10 +264,12 @@ export declare namespace Refinement {
     /**
      * A utility type representing any refinement type.
      *
-     * When to use:
+     * **When to use**
+     *
      * - You need a constraint for "any refinement" in generic code.
      *
-     * Behavior:
+     * **Details**
+     *
      * - Type-only; no runtime value is created.
      *
      * **Example** (Generic constraint)
@@ -261,8 +280,8 @@ export declare namespace Refinement {
      * type AnyRefinement = Predicate.Refinement.Any
      * ```
      *
-     * See also: {@link Refinement.In}, {@link Refinement.Out}
-     *
+     * @see {@link Refinement.In}
+     * @see {@link Refinement.Out}
      * @category type-level
      * @since 3.6.0
      */
@@ -271,11 +290,13 @@ export declare namespace Refinement {
 /**
  * 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.
@@ -292,8 +313,9 @@ export declare namespace Refinement {
  * 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
  */
@@ -301,11 +323,13 @@ export declare const mapInput: {
     /**
      * 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.
@@ -322,8 +346,9 @@ export declare const mapInput: {
      * 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
      */
@@ -331,11 +356,13 @@ export declare const mapInput: {
     /**
      * 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.
@@ -352,8 +379,9 @@ export declare const mapInput: {
      * 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
      */
@@ -362,11 +390,13 @@ export declare const mapInput: {
 /**
  * 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.
@@ -381,8 +411,8 @@ export declare const mapInput: {
  * console.log(isPair([1, 2]))
  * ```
  *
- * See also: {@link isTupleOfAtLeast}, {@link Tuple}
- *
+ * @see {@link isTupleOfAtLeast}
+ * @see {@link Tuple}
  * @category guards
  * @since 3.3.0
  */
@@ -390,11 +420,13 @@ export declare const isTupleOf: {
     /**
      * 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.
@@ -409,8 +441,8 @@ export declare const isTupleOf: {
      * console.log(isPair([1, 2]))
      * ```
      *
-     * See also: {@link isTupleOfAtLeast}, {@link Tuple}
-     *
+     * @see {@link isTupleOfAtLeast}
+     * @see {@link Tuple}
      * @category guards
      * @since 3.3.0
      */
@@ -418,11 +450,13 @@ export declare const isTupleOf: {
     /**
      * 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.
@@ -437,8 +471,8 @@ export declare const isTupleOf: {
      * console.log(isPair([1, 2]))
      * ```
      *
-     * See also: {@link isTupleOfAtLeast}, {@link Tuple}
-     *
+     * @see {@link isTupleOfAtLeast}
+     * @see {@link Tuple}
      * @category guards
      * @since 3.3.0
      */
@@ -447,11 +481,13 @@ export declare const isTupleOf: {
 /**
  * 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.
@@ -466,8 +502,8 @@ export declare const isTupleOf: {
  * console.log(hasAtLeast2([1, 2, 3]))
  * ```
  *
- * See also: {@link isTupleOf}, {@link Tuple}
- *
+ * @see {@link isTupleOf}
+ * @see {@link Tuple}
  * @category guards
  * @since 3.3.0
  */
@@ -475,11 +511,13 @@ export declare const isTupleOfAtLeast: {
     /**
      * 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.
@@ -494,8 +532,8 @@ export declare const isTupleOfAtLeast: {
      * console.log(hasAtLeast2([1, 2, 3]))
      * ```
      *
-     * See also: {@link isTupleOf}, {@link Tuple}
-     *
+     * @see {@link isTupleOf}
+     * @see {@link Tuple}
      * @category guards
      * @since 3.3.0
      */
@@ -503,11 +541,13 @@ export declare const isTupleOfAtLeast: {
     /**
      * 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.
@@ -522,8 +562,8 @@ export declare const isTupleOfAtLeast: {
      * console.log(hasAtLeast2([1, 2, 3]))
      * ```
      *
-     * See also: {@link isTupleOf}, {@link Tuple}
-     *
+     * @see {@link isTupleOf}
+     * @see {@link Tuple}
      * @category guards
      * @since 3.3.0
      */
@@ -532,11 +572,13 @@ export declare const isTupleOfAtLeast: {
 /**
  * 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.
@@ -552,8 +594,8 @@ export declare const isTupleOfAtLeast: {
  * console.log(truthy)
  * ```
  *
- * See also: {@link isNullish}, {@link isNotNullish}
- *
+ * @see {@link isNullish}
+ * @see {@link isNotNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -561,10 +603,12 @@ export declare function isTruthy(input: unknown): boolean;
 /**
  * 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`.
  *
@@ -580,8 +624,8 @@ export declare function isTruthy(input: unknown): boolean;
  * }
  * ```
  *
- * See also: {@link isMap}, {@link isIterable}
- *
+ * @see {@link isMap}
+ * @see {@link isIterable}
  * @category guards
  * @since 2.0.0
  */
@@ -589,10 +633,12 @@ export declare function isSet(input: unknown): input is Set<unknown>;
 /**
  * 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`.
  *
@@ -608,8 +654,8 @@ export declare function isSet(input: unknown): input is Set<unknown>;
  * }
  * ```
  *
- * See also: {@link isSet}, {@link isIterable}
- *
+ * @see {@link isSet}
+ * @see {@link isIterable}
  * @category guards
  * @since 2.0.0
  */
@@ -617,11 +663,13 @@ export declare function isMap(input: unknown): input is Map<unknown, unknown>;
 /**
  * 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"`.
  *
@@ -637,8 +685,9 @@ export declare function isMap(input: unknown): input is Map<unknown, unknown>;
  * }
  * ```
  *
- * See also: {@link isNumber}, {@link isBoolean}, {@link Refinement}
- *
+ * @see {@link isNumber}
+ * @see {@link isBoolean}
+ * @see {@link Refinement}
  * @category guards
  * @since 2.0.0
  */
@@ -646,10 +695,12 @@ export declare function isString(input: unknown): input is string;
 /**
  * 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`.
@@ -666,8 +717,8 @@ export declare function isString(input: unknown): input is string;
  * }
  * ```
  *
- * See also: {@link isBigInt}, {@link isString}
- *
+ * @see {@link isBigInt}
+ * @see {@link isString}
  * @category guards
  * @since 2.0.0
  */
@@ -675,10 +726,12 @@ export declare function isNumber(input: unknown): input is number;
 /**
  * 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"`.
  *
@@ -694,8 +747,8 @@ export declare function isNumber(input: unknown): input is number;
  * }
  * ```
  *
- * See also: {@link isString}, {@link isNumber}
- *
+ * @see {@link isString}
+ * @see {@link isNumber}
  * @category guards
  * @since 2.0.0
  */
@@ -703,10 +756,12 @@ export declare function isBoolean(input: unknown): input is boolean;
 /**
  * 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"`.
  *
@@ -722,8 +777,7 @@ export declare function isBoolean(input: unknown): input is boolean;
  * }
  * ```
  *
- * See also: {@link isNumber}
- *
+ * @see {@link isNumber}
  * @category guards
  * @since 2.0.0
  */
@@ -731,10 +785,12 @@ export declare function isBigInt(input: unknown): input is bigint;
 /**
  * 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"`.
  *
@@ -750,8 +806,7 @@ export declare function isBigInt(input: unknown): input is bigint;
  * }
  * ```
  *
- * See also: {@link isPropertyKey}
- *
+ * @see {@link isPropertyKey}
  * @category guards
  * @since 2.0.0
  */
@@ -759,10 +814,12 @@ export declare function isSymbol(input: unknown): input is symbol;
 /**
  * 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}.
  *
@@ -779,8 +836,9 @@ export declare function isSymbol(input: unknown): input is symbol;
  * }
  * ```
  *
- * See also: {@link isString}, {@link isNumber}, {@link isSymbol}
- *
+ * @see {@link isString}
+ * @see {@link isNumber}
+ * @see {@link isSymbol}
  * @category guards
  * @since 4.0.0
  */
@@ -788,10 +846,12 @@ export declare function isPropertyKey(u: unknown): u is PropertyKey;
 /**
  * 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"`.
  *
@@ -807,8 +867,7 @@ export declare function isPropertyKey(u: unknown): u is PropertyKey;
  * }
  * ```
  *
- * See also: {@link isObjectKeyword}
- *
+ * @see {@link isObjectKeyword}
  * @category guards
  * @since 2.0.0
  */
@@ -816,10 +875,12 @@ export declare function isFunction(input: unknown): input is Function;
 /**
  * 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`.
  *
@@ -833,8 +894,8 @@ export declare function isFunction(input: unknown): input is Function;
  * console.log(Predicate.isUndefined(data))
  * ```
  *
- * See also: {@link isNotUndefined}, {@link isNullish}
- *
+ * @see {@link isNotUndefined}
+ * @see {@link isNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -842,10 +903,12 @@ export declare function isUndefined(input: unknown): input is undefined;
 /**
  * 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`.
  *
@@ -860,8 +923,8 @@ export declare function isUndefined(input: unknown): input is undefined;
  * console.log(defined)
  * ```
  *
- * See also: {@link isUndefined}, {@link isNotNullish}
- *
+ * @see {@link isUndefined}
+ * @see {@link isNotNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -869,10 +932,12 @@ export declare function isNotUndefined<A>(input: A): input is Exclude<A, undefin
 /**
  * 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`.
  *
@@ -886,8 +951,8 @@ export declare function isNotUndefined<A>(input: A): input is Exclude<A, undefin
  * console.log(Predicate.isNull(data))
  * ```
  *
- * See also: {@link isNotNull}, {@link isNullish}
- *
+ * @see {@link isNotNull}
+ * @see {@link isNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -895,10 +960,12 @@ export declare function isNull(input: unknown): input is null;
 /**
  * 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`.
  *
@@ -913,8 +980,8 @@ export declare function isNull(input: unknown): input is null;
  * console.log(nonNull)
  * ```
  *
- * See also: {@link isNull}, {@link isNotNullish}
- *
+ * @see {@link isNull}
+ * @see {@link isNotNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -922,10 +989,12 @@ export declare function isNotNull<A>(input: A): input is Exclude<A, null>;
 /**
  * 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`.
  *
@@ -940,8 +1009,9 @@ export declare function isNotNull<A>(input: A): input is Exclude<A, null>;
  * 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
  */
@@ -949,10 +1019,12 @@ export declare function isNullish<A>(input: A): input is A & (null | undefined);
 /**
  * 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`.
  *
@@ -967,8 +1039,9 @@ export declare function isNullish<A>(input: A): input is A & (null | undefined);
  * 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
  */
@@ -976,10 +1049,12 @@ export declare function isNotNullish<A>(input: A): input is NonNullable<A>;
 /**
  * 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`.
  *
@@ -991,8 +1066,7 @@ export declare function isNotNullish<A>(input: A): input is NonNullable<A>;
  * console.log(Predicate.isNever("anything"))
  * ```
  *
- * See also: {@link isUnknown}
- *
+ * @see {@link isUnknown}
  * @category guards
  * @since 2.0.0
  */
@@ -1000,10 +1074,12 @@ export declare function isNever(_: unknown): _ is never;
 /**
  * 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`.
  *
@@ -1015,8 +1091,7 @@ export declare function isNever(_: unknown): _ is never;
  * console.log(Predicate.isUnknown(123))
  * ```
  *
- * See also: {@link isNever}
- *
+ * @see {@link isNever}
  * @category guards
  * @since 2.0.0
  */
@@ -1024,10 +1099,12 @@ export declare function isUnknown(_: unknown): _ is unknown;
 /**
  * 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.
@@ -1040,8 +1117,8 @@ export declare function isUnknown(_: unknown): _ is unknown;
  * console.log(Predicate.isObjectOrArray([]))
  * ```
  *
- * See also: {@link isObject}, {@link isObjectKeyword}
- *
+ * @see {@link isObject}
+ * @see {@link isObjectKeyword}
  * @category guards
  * @since 4.0.0
  */
@@ -1051,6 +1128,8 @@ export declare function isObjectOrArray(input: unknown): input is {
 /**
  * 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.
@@ -1064,8 +1143,8 @@ export declare function isObjectOrArray(input: unknown): input is {
  * console.log(Predicate.isObject([1, 2]))
  * ```
  *
- * See also: {@link isObjectOrArray}, {@link isReadonlyObject}
- *
+ * @see {@link isObjectOrArray}
+ * @see {@link isReadonlyObject}
  * @category guards
  * @since 2.0.0
  */
@@ -1076,6 +1155,8 @@ export declare function isObject(input: unknown): input is {
  * 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.
@@ -1090,8 +1171,7 @@ export declare function isObject(input: unknown): input is {
  * console.log(Predicate.isReadonlyObject(data))
  * ```
  *
- * See also: {@link isObject}
- *
+ * @see {@link isObject}
  * @category guards
  * @since 4.0.0
  */
@@ -1101,10 +1181,12 @@ export declare function isReadonlyObject(input: unknown): input is {
 /**
  * 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`.
  *
@@ -1117,8 +1199,8 @@ export declare function isReadonlyObject(input: unknown): input is {
  * console.log(Predicate.isObjectKeyword(null))
  * ```
  *
- * See also: {@link isObject}, {@link isObjectOrArray}
- *
+ * @see {@link isObject}
+ * @see {@link isObjectOrArray}
  * @category guards
  * @since 4.0.0
  */
@@ -1126,11 +1208,13 @@ export declare function isObjectKeyword(input: unknown): input is object;
 /**
  * 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.
@@ -1148,8 +1232,8 @@ export declare function isObjectKeyword(input: unknown): input is object;
  * }
  * ```
  *
- * See also: {@link isTagged}, {@link isObjectKeyword}
- *
+ * @see {@link isTagged}
+ * @see {@link isObjectKeyword}
  * @category guards
  * @since 2.0.0
  */
@@ -1157,11 +1241,13 @@ export declare const hasProperty: {
     /**
      * 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.
@@ -1179,8 +1265,8 @@ export declare const hasProperty: {
      * }
      * ```
      *
-     * See also: {@link isTagged}, {@link isObjectKeyword}
-     *
+     * @see {@link isTagged}
+     * @see {@link isObjectKeyword}
      * @category guards
      * @since 2.0.0
      */
@@ -1190,11 +1276,13 @@ export declare const hasProperty: {
     /**
      * 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.
@@ -1212,8 +1300,8 @@ export declare const hasProperty: {
      * }
      * ```
      *
-     * See also: {@link isTagged}, {@link isObjectKeyword}
-     *
+     * @see {@link isTagged}
+     * @see {@link isObjectKeyword}
      * @category guards
      * @since 2.0.0
      */
@@ -1224,11 +1312,13 @@ export declare const hasProperty: {
 /**
  * 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`.
  *
@@ -1242,8 +1332,7 @@ export declare const hasProperty: {
  * console.log(isOk({ _tag: "Ok", value: 1 }))
  * ```
  *
- * See also: {@link hasProperty}
- *
+ * @see {@link hasProperty}
  * @category guards
  * @since 2.0.0
  */
@@ -1251,11 +1340,13 @@ export declare const isTagged: {
     /**
      * 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`.
      *
@@ -1269,8 +1360,7 @@ export declare const isTagged: {
      * console.log(isOk({ _tag: "Ok", value: 1 }))
      * ```
      *
-     * See also: {@link hasProperty}
-     *
+     * @see {@link hasProperty}
      * @category guards
      * @since 2.0.0
      */
@@ -1280,11 +1370,13 @@ export declare const isTagged: {
     /**
      * 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`.
      *
@@ -1298,8 +1390,7 @@ export declare const isTagged: {
      * console.log(isOk({ _tag: "Ok", value: 1 }))
      * ```
      *
-     * See also: {@link hasProperty}
-     *
+     * @see {@link hasProperty}
      * @category guards
      * @since 2.0.0
      */
@@ -1310,10 +1401,12 @@ export declare const isTagged: {
 /**
  * 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`.
  *
@@ -1327,8 +1420,7 @@ export declare const isTagged: {
  * console.log(Predicate.isError(data))
  * ```
  *
- * See also: {@link isUnknown}
- *
+ * @see {@link isUnknown}
  * @category guards
  * @since 2.0.0
  */
@@ -1336,10 +1428,12 @@ export declare function isError(input: unknown): input is Error;
 /**
  * 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`.
  *
@@ -1353,8 +1447,8 @@ export declare function isError(input: unknown): input is Error;
  * console.log(Predicate.isUint8Array(data))
  * ```
  *
- * See also: {@link isIterable}, {@link isSet}
- *
+ * @see {@link isIterable}
+ * @see {@link isSet}
  * @category guards
  * @since 2.0.0
  */
@@ -1362,10 +1456,12 @@ export declare function isUint8Array(input: unknown): input is Uint8Array;
 /**
  * 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`.
  *
@@ -1379,8 +1475,7 @@ export declare function isUint8Array(input: unknown): input is Uint8Array;
  * console.log(Predicate.isDate(data))
  * ```
  *
- * See also: {@link isRegExp}
- *
+ * @see {@link isRegExp}
  * @category guards
  * @since 2.0.0
  */
@@ -1388,10 +1483,12 @@ export declare function isDate(input: unknown): input is Date;
 /**
  * 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`.
@@ -1406,8 +1503,8 @@ export declare function isDate(input: unknown): input is Date;
  * console.log(Predicate.isIterable(data))
  * ```
  *
- * See also: {@link isSet}, {@link isMap}
- *
+ * @see {@link isSet}
+ * @see {@link isMap}
  * @category guards
  * @since 2.0.0
  */
@@ -1415,10 +1512,12 @@ export declare function isIterable(input: unknown): input is Iterable<unknown>;
 /**
  * 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.
  *
@@ -1432,8 +1531,7 @@ export declare function isIterable(input: unknown): input is Iterable<unknown>;
  * console.log(Predicate.isPromise(data))
  * ```
  *
- * See also: {@link isPromiseLike}
- *
+ * @see {@link isPromiseLike}
  * @category guards
  * @since 2.0.0
  */
@@ -1441,10 +1539,12 @@ export declare function isPromise(input: unknown): input is Promise<unknown>;
 /**
  * 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`.
  *
@@ -1458,8 +1558,7 @@ export declare function isPromise(input: unknown): input is Promise<unknown>;
  * console.log(Predicate.isPromiseLike(data))
  * ```
  *
- * See also: {@link isPromise}
- *
+ * @see {@link isPromise}
  * @category guards
  * @since 2.0.0
  */
@@ -1467,10 +1566,12 @@ export declare function isPromiseLike(input: unknown): input is PromiseLike<unkn
 /**
  * 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`.
  *
@@ -1484,8 +1585,7 @@ export declare function isPromiseLike(input: unknown): input is PromiseLike<unkn
  * console.log(Predicate.isRegExp(data))
  * ```
  *
- * See also: {@link isDate}
- *
+ * @see {@link isDate}
  * @category guards
  * @since 3.9.0
  */
@@ -1493,11 +1593,13 @@ export declare function isRegExp(input: unknown): input is RegExp;
 /**
  * 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`.
@@ -1515,8 +1617,8 @@ export declare function isRegExp(input: unknown): input is RegExp;
  * console.log(isIntegerNumber(1))
  * ```
  *
- * See also: {@link and}, {@link Refinement}
- *
+ * @see {@link and}
+ * @see {@link Refinement}
  * @category combinators
  * @since 2.0.0
  */
@@ -1524,11 +1626,13 @@ export declare const compose: {
     /**
      * 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`.
@@ -1546,8 +1650,8 @@ export declare const compose: {
      * console.log(isIntegerNumber(1))
      * ```
      *
-     * See also: {@link and}, {@link Refinement}
-     *
+     * @see {@link and}
+     * @see {@link Refinement}
      * @category combinators
      * @since 2.0.0
      */
@@ -1555,11 +1659,13 @@ export declare const compose: {
     /**
      * 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`.
@@ -1577,8 +1683,8 @@ export declare const compose: {
      * console.log(isIntegerNumber(1))
      * ```
      *
-     * See also: {@link and}, {@link Refinement}
-     *
+     * @see {@link and}
+     * @see {@link Refinement}
      * @category combinators
      * @since 2.0.0
      */
@@ -1586,11 +1692,13 @@ export declare const compose: {
     /**
      * 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`.
@@ -1608,8 +1716,8 @@ export declare const compose: {
      * console.log(isIntegerNumber(1))
      * ```
      *
-     * See also: {@link and}, {@link Refinement}
-     *
+     * @see {@link and}
+     * @see {@link Refinement}
      * @category combinators
      * @since 2.0.0
      */
@@ -1617,11 +1725,13 @@ export declare const compose: {
     /**
      * 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`.
@@ -1639,8 +1749,8 @@ export declare const compose: {
      * console.log(isIntegerNumber(1))
      * ```
      *
-     * See also: {@link and}, {@link Refinement}
-     *
+     * @see {@link and}
+     * @see {@link Refinement}
      * @category combinators
      * @since 2.0.0
      */
@@ -1649,11 +1759,13 @@ export declare const compose: {
 /**
  * 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.
@@ -1668,8 +1780,8 @@ export declare const compose: {
  * console.log(tupleCheck([1, "ok"]))
  * ```
  *
- * See also: {@link Struct}, {@link isTupleOf}
- *
+ * @see {@link Struct}
+ * @see {@link isTupleOf}
  * @category combinators
  * @since 4.0.0
  */
@@ -1683,11 +1795,13 @@ export declare function Tuple<const T extends ReadonlyArray<Predicate.Any>>(elem
 /**
  * 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.
@@ -1705,8 +1819,8 @@ export declare function Tuple<const T extends ReadonlyArray<Predicate.Any>>(elem
  * 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
  */
@@ -1720,10 +1834,12 @@ export declare function Struct<R extends Record<string, Predicate.Any>>(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.
  *
@@ -1737,8 +1853,9 @@ export declare function Struct<R extends Record<string, Predicate.Any>>(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
  */
@@ -1746,11 +1863,13 @@ export declare function not<A>(self: Predicate<A>): Predicate<A>;
 /**
  * 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.
@@ -1765,8 +1884,8 @@ export declare function not<A>(self: Predicate<A>): Predicate<A>;
  * console.log(isStringOrNumber("a"))
  * ```
  *
- * See also: {@link and}, {@link xor}
- *
+ * @see {@link and}
+ * @see {@link xor}
  * @category combinators
  * @since 2.0.0
  */
@@ -1774,11 +1893,13 @@ export declare const or: {
     /**
      * 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.
@@ -1793,8 +1914,8 @@ export declare const or: {
      * console.log(isStringOrNumber("a"))
      * ```
      *
-     * See also: {@link and}, {@link xor}
-     *
+     * @see {@link and}
+     * @see {@link xor}
      * @category combinators
      * @since 2.0.0
      */
@@ -1802,11 +1923,13 @@ export declare const or: {
     /**
      * 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.
@@ -1821,8 +1944,8 @@ export declare const or: {
      * console.log(isStringOrNumber("a"))
      * ```
      *
-     * See also: {@link and}, {@link xor}
-     *
+     * @see {@link and}
+     * @see {@link xor}
      * @category combinators
      * @since 2.0.0
      */
@@ -1830,11 +1953,13 @@ export declare const or: {
     /**
      * 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.
@@ -1849,8 +1974,8 @@ export declare const or: {
      * console.log(isStringOrNumber("a"))
      * ```
      *
-     * See also: {@link and}, {@link xor}
-     *
+     * @see {@link and}
+     * @see {@link xor}
      * @category combinators
      * @since 2.0.0
      */
@@ -1858,11 +1983,13 @@ export declare const or: {
     /**
      * 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.
@@ -1877,8 +2004,8 @@ export declare const or: {
      * console.log(isStringOrNumber("a"))
      * ```
      *
-     * See also: {@link and}, {@link xor}
-     *
+     * @see {@link and}
+     * @see {@link xor}
      * @category combinators
      * @since 2.0.0
      */
@@ -1887,11 +2014,13 @@ export declare const or: {
 /**
  * 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.
@@ -1914,8 +2043,8 @@ export declare const or: {
  * }
  * ```
  *
- * See also: {@link or}, {@link not}
- *
+ * @see {@link or}
+ * @see {@link not}
  * @category combinators
  * @since 2.0.0
  */
@@ -1923,11 +2052,13 @@ export declare const and: {
     /**
      * 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.
@@ -1950,8 +2081,8 @@ export declare const and: {
      * }
      * ```
      *
-     * See also: {@link or}, {@link not}
-     *
+     * @see {@link or}
+     * @see {@link not}
      * @category combinators
      * @since 2.0.0
      */
@@ -1959,11 +2090,13 @@ export declare const and: {
     /**
      * 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.
@@ -1986,8 +2119,8 @@ export declare const and: {
      * }
      * ```
      *
-     * See also: {@link or}, {@link not}
-     *
+     * @see {@link or}
+     * @see {@link not}
      * @category combinators
      * @since 2.0.0
      */
@@ -1995,11 +2128,13 @@ export declare const and: {
     /**
      * 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.
@@ -2022,8 +2157,8 @@ export declare const and: {
      * }
      * ```
      *
-     * See also: {@link or}, {@link not}
-     *
+     * @see {@link or}
+     * @see {@link not}
      * @category combinators
      * @since 2.0.0
      */
@@ -2031,11 +2166,13 @@ export declare const and: {
     /**
      * 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.
@@ -2058,8 +2195,8 @@ export declare const and: {
      * }
      * ```
      *
-     * See also: {@link or}, {@link not}
-     *
+     * @see {@link or}
+     * @see {@link not}
      * @category combinators
      * @since 2.0.0
      */
@@ -2068,10 +2205,12 @@ export declare const and: {
 /**
  * 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.
  *
@@ -2087,8 +2226,8 @@ export declare const and: {
  * console.log(either(-2))
  * ```
  *
- * See also: {@link or}, {@link and}
- *
+ * @see {@link or}
+ * @see {@link and}
  * @category combinators
  * @since 2.0.0
  */
@@ -2096,10 +2235,12 @@ export declare const xor: {
     /**
      * 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.
      *
@@ -2115,8 +2256,8 @@ export declare const xor: {
      * console.log(either(-2))
      * ```
      *
-     * See also: {@link or}, {@link and}
-     *
+     * @see {@link or}
+     * @see {@link and}
      * @category combinators
      * @since 2.0.0
      */
@@ -2124,10 +2265,12 @@ export declare const xor: {
     /**
      * 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.
      *
@@ -2143,8 +2286,8 @@ export declare const xor: {
      * console.log(either(-2))
      * ```
      *
-     * See also: {@link or}, {@link and}
-     *
+     * @see {@link or}
+     * @see {@link and}
      * @category combinators
      * @since 2.0.0
      */
@@ -2153,10 +2296,12 @@ export declare const xor: {
 /**
  * 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.
  *
@@ -2171,8 +2316,7 @@ export declare const xor: {
  * console.log(same(3))
  * ```
  *
- * See also: {@link xor}
- *
+ * @see {@link xor}
  * @category combinators
  * @since 2.0.0
  */
@@ -2180,10 +2324,12 @@ export declare const eqv: {
     /**
      * 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.
      *
@@ -2198,8 +2344,7 @@ export declare const eqv: {
      * console.log(same(3))
      * ```
      *
-     * See also: {@link xor}
-     *
+     * @see {@link xor}
      * @category combinators
      * @since 2.0.0
      */
@@ -2207,10 +2352,12 @@ export declare const eqv: {
     /**
      * 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.
      *
@@ -2225,8 +2372,7 @@ export declare const eqv: {
      * console.log(same(3))
      * ```
      *
-     * See also: {@link xor}
-     *
+     * @see {@link xor}
      * @category combinators
      * @since 2.0.0
      */
@@ -2235,11 +2381,13 @@ export declare const eqv: {
 /**
  * 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`.
  *
@@ -2255,8 +2403,8 @@ export declare const eqv: {
  * console.log(implies(16))
  * ```
  *
- * See also: {@link and}, {@link or}
- *
+ * @see {@link and}
+ * @see {@link or}
  * @category combinators
  * @since 2.0.0
  */
@@ -2264,11 +2412,13 @@ export declare const implies: {
     /**
      * 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`.
      *
@@ -2284,8 +2434,8 @@ export declare const implies: {
      * console.log(implies(16))
      * ```
      *
-     * See also: {@link and}, {@link or}
-     *
+     * @see {@link and}
+     * @see {@link or}
      * @category combinators
      * @since 2.0.0
      */
@@ -2293,11 +2443,13 @@ export declare const implies: {
     /**
      * 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`.
      *
@@ -2313,8 +2465,8 @@ export declare const implies: {
      * console.log(implies(16))
      * ```
      *
-     * See also: {@link and}, {@link or}
-     *
+     * @see {@link and}
+     * @see {@link or}
      * @category combinators
      * @since 2.0.0
      */
@@ -2323,10 +2475,12 @@ export declare const implies: {
 /**
  * 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}.
  *
@@ -2340,8 +2494,8 @@ export declare const implies: {
  * console.log(neither(true))
  * ```
  *
- * See also: {@link or}, {@link not}
- *
+ * @see {@link or}
+ * @see {@link not}
  * @category combinators
  * @since 2.0.0
  */
@@ -2349,10 +2503,12 @@ export declare const nor: {
     /**
      * 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}.
      *
@@ -2366,8 +2522,8 @@ export declare const nor: {
      * console.log(neither(true))
      * ```
      *
-     * See also: {@link or}, {@link not}
-     *
+     * @see {@link or}
+     * @see {@link not}
      * @category combinators
      * @since 2.0.0
      */
@@ -2375,10 +2531,12 @@ export declare const nor: {
     /**
      * 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}.
      *
@@ -2392,8 +2550,8 @@ export declare const nor: {
      * console.log(neither(true))
      * ```
      *
-     * See also: {@link or}, {@link not}
-     *
+     * @see {@link or}
+     * @see {@link not}
      * @category combinators
      * @since 2.0.0
      */
@@ -2402,10 +2560,12 @@ export declare const nor: {
 /**
  * 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}.
  *
@@ -2419,8 +2579,8 @@ export declare const nor: {
  * console.log(notBoth("a"))
  * ```
  *
- * See also: {@link and}, {@link not}
- *
+ * @see {@link and}
+ * @see {@link not}
  * @category combinators
  * @since 2.0.0
  */
@@ -2428,10 +2588,12 @@ export declare const nand: {
     /**
      * 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}.
      *
@@ -2445,8 +2607,8 @@ export declare const nand: {
      * console.log(notBoth("a"))
      * ```
      *
-     * See also: {@link and}, {@link not}
-     *
+     * @see {@link and}
+     * @see {@link not}
      * @category combinators
      * @since 2.0.0
      */
@@ -2454,10 +2616,12 @@ export declare const nand: {
     /**
      * 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}.
      *
@@ -2471,8 +2635,8 @@ export declare const nand: {
      * console.log(notBoth("a"))
      * ```
      *
-     * See also: {@link and}, {@link not}
-     *
+     * @see {@link and}
+     * @see {@link not}
      * @category combinators
      * @since 2.0.0
      */
@@ -2481,10 +2645,12 @@ export declare const nand: {
 /**
  * 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.
@@ -2499,8 +2665,8 @@ export declare const nand: {
  * console.log(allChecks(2))
  * ```
  *
- * See also: {@link some}, {@link and}
- *
+ * @see {@link some}
+ * @see {@link and}
  * @category elements
  * @since 2.0.0
  */
@@ -2508,10 +2674,12 @@ export declare function every<A>(collection: Iterable<Predicate<A>>): Predicate<
 /**
  * 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.
@@ -2526,8 +2694,8 @@ export declare function every<A>(collection: Iterable<Predicate<A>>): Predicate<
  * console.log(anyCheck("ok"))
  * ```
  *
- * See also: {@link every}, {@link or}
- *
+ * @see {@link every}
+ * @see {@link or}
  * @category elements
  * @since 2.0.0
  */