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

package/src/Predicate.ts

@@ -46,12 +46,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}.
@@ -66,8 +68,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
  */
@@ -78,11 +81,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.
  *
@@ -95,8 +100,7 @@ export interface Predicate<in A> {
  * type TL = Predicate.PredicateTypeLambda
  * ```
  *
- * See also: {@link Predicate}
- *
+ * @see {@link Predicate}
  * @category type lambdas
  * @since 2.0.0
  */
@@ -107,12 +111,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.
@@ -130,8 +136,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
  */
@@ -142,11 +149,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.
  *
@@ -159,19 +168,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`.
    *
@@ -184,8 +195,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
    */
@@ -194,10 +205,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)
@@ -208,8 +221,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
    */
@@ -219,11 +231,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.
  *
@@ -237,18 +251,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`.
    *
@@ -261,8 +277,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
    */
@@ -272,10 +288,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`.
    *
@@ -288,8 +306,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
    */
@@ -298,10 +315,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)
@@ -312,8 +331,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
    */
@@ -323,11 +342,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.
@@ -344,8 +365,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
  */
@@ -353,11 +375,13 @@ export 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.
@@ -374,8 +398,9 @@ export 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
    */
@@ -383,11 +408,13 @@ export 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.
@@ -404,8 +431,9 @@ export 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
    */
@@ -415,11 +443,13 @@ export 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.
@@ -434,8 +464,8 @@ export 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
  */
@@ -443,11 +473,13 @@ export 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.
@@ -462,8 +494,8 @@ export 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
    */
@@ -471,11 +503,13 @@ export 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.
@@ -490,8 +524,8 @@ export 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
    */
@@ -501,11 +535,13 @@ export 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.
@@ -520,8 +556,8 @@ export 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
  */
@@ -529,11 +565,13 @@ export 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.
@@ -548,8 +586,8 @@ export 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
    */
@@ -557,11 +595,13 @@ export 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.
@@ -576,8 +616,8 @@ export 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
    */
@@ -587,11 +627,13 @@ export 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.
@@ -607,8 +649,8 @@ export const isTupleOfAtLeast: {
  * console.log(truthy)
  * ```
  *
- * See also: {@link isNullish}, {@link isNotNullish}
- *
+ * @see {@link isNullish}
+ * @see {@link isNotNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -619,10 +661,12 @@ export 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`.
  *
@@ -638,8 +682,8 @@ export function isTruthy(input: unknown): boolean {
  * }
  * ```
  *
- * See also: {@link isMap}, {@link isIterable}
- *
+ * @see {@link isMap}
+ * @see {@link isIterable}
  * @category guards
  * @since 2.0.0
  */
@@ -650,10 +694,12 @@ export 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`.
  *
@@ -669,8 +715,8 @@ export 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
  */
@@ -681,11 +727,13 @@ export 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"`.
  *
@@ -701,8 +749,9 @@ export 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
  */
@@ -713,10 +762,12 @@ export 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`.
@@ -733,8 +784,8 @@ export 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
  */
@@ -745,10 +796,12 @@ export 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"`.
  *
@@ -764,8 +817,8 @@ export 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
  */
@@ -776,10 +829,12 @@ export 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"`.
  *
@@ -795,8 +850,7 @@ export function isBoolean(input: unknown): input is boolean {
  * }
  * ```
  *
- * See also: {@link isNumber}
- *
+ * @see {@link isNumber}
  * @category guards
  * @since 2.0.0
  */
@@ -807,10 +861,12 @@ export 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"`.
  *
@@ -826,8 +882,7 @@ export function isBigInt(input: unknown): input is bigint {
  * }
  * ```
  *
- * See also: {@link isPropertyKey}
- *
+ * @see {@link isPropertyKey}
  * @category guards
  * @since 2.0.0
  */
@@ -838,10 +893,12 @@ export 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}.
  *
@@ -858,8 +915,9 @@ export 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
  */
@@ -870,10 +928,12 @@ export 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"`.
  *
@@ -889,8 +949,7 @@ export function isPropertyKey(u: unknown): u is PropertyKey {
  * }
  * ```
  *
- * See also: {@link isObjectKeyword}
- *
+ * @see {@link isObjectKeyword}
  * @category guards
  * @since 2.0.0
  */
@@ -901,10 +960,12 @@ export 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`.
  *
@@ -918,8 +979,8 @@ export 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
  */
@@ -930,10 +991,12 @@ export 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`.
  *
@@ -948,8 +1011,8 @@ export 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
  */
@@ -960,10 +1023,12 @@ export function isNotUndefined<A>(input: A): input is Exclude<A, undefined> {
 /**
  * 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`.
  *
@@ -977,8 +1042,8 @@ export function isNotUndefined<A>(input: A): input is Exclude<A, undefined> {
  * console.log(Predicate.isNull(data))
  * ```
  *
- * See also: {@link isNotNull}, {@link isNullish}
- *
+ * @see {@link isNotNull}
+ * @see {@link isNullish}
  * @category guards
  * @since 2.0.0
  */
@@ -989,10 +1054,12 @@ export 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`.
  *
@@ -1007,8 +1074,8 @@ export 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
  */
@@ -1019,10 +1086,12 @@ export 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`.
  *
@@ -1037,8 +1106,9 @@ export 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
  */
@@ -1049,10 +1119,12 @@ export 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`.
  *
@@ -1067,8 +1139,9 @@ export 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
  */
@@ -1079,10 +1152,12 @@ export 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`.
  *
@@ -1094,8 +1169,7 @@ export 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
  */
@@ -1106,10 +1180,12 @@ export 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`.
  *
@@ -1121,8 +1197,7 @@ export function isNever(_: unknown): _ is never {
  * console.log(Predicate.isUnknown(123))
  * ```
  *
- * See also: {@link isNever}
- *
+ * @see {@link isNever}
  * @category guards
  * @since 2.0.0
  */
@@ -1133,10 +1208,12 @@ export 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.
@@ -1149,8 +1226,8 @@ export 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
  */
@@ -1161,6 +1238,8 @@ export function isObjectOrArray(input: unknown): input is { [x: PropertyKey]: un
 /**
  * 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.
@@ -1174,8 +1253,8 @@ export function isObjectOrArray(input: unknown): input is { [x: PropertyKey]: un
  * console.log(Predicate.isObject([1, 2]))
  * ```
  *
- * See also: {@link isObjectOrArray}, {@link isReadonlyObject}
- *
+ * @see {@link isObjectOrArray}
+ * @see {@link isReadonlyObject}
  * @category guards
  * @since 2.0.0
  */
@@ -1187,6 +1266,8 @@ export function isObject(input: unknown): input is { [x: PropertyKey]: unknown }
  * 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.
@@ -1201,8 +1282,7 @@ export function isObject(input: unknown): input is { [x: PropertyKey]: unknown }
  * console.log(Predicate.isReadonlyObject(data))
  * ```
  *
- * See also: {@link isObject}
- *
+ * @see {@link isObject}
  * @category guards
  * @since 4.0.0
  */
@@ -1213,10 +1293,12 @@ export function isReadonlyObject(input: unknown): input is { readonly [x: Proper
 /**
  * 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`.
  *
@@ -1229,8 +1311,8 @@ export function isReadonlyObject(input: unknown): input is { readonly [x: Proper
  * console.log(Predicate.isObjectKeyword(null))
  * ```
  *
- * See also: {@link isObject}, {@link isObjectOrArray}
- *
+ * @see {@link isObject}
+ * @see {@link isObjectOrArray}
  * @category guards
  * @since 4.0.0
  */
@@ -1241,11 +1323,13 @@ export 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.
@@ -1263,8 +1347,8 @@ export 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
  */
@@ -1272,11 +1356,13 @@ export 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.
@@ -1294,8 +1380,8 @@ export const hasProperty: {
    * }
    * ```
    *
-   * See also: {@link isTagged}, {@link isObjectKeyword}
-   *
+   * @see {@link isTagged}
+   * @see {@link isObjectKeyword}
    * @category guards
    * @since 2.0.0
    */
@@ -1303,11 +1389,13 @@ export 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.
@@ -1325,8 +1413,8 @@ export const hasProperty: {
    * }
    * ```
    *
-   * See also: {@link isTagged}, {@link isObjectKeyword}
-   *
+   * @see {@link isTagged}
+   * @see {@link isObjectKeyword}
    * @category guards
    * @since 2.0.0
    */
@@ -1340,11 +1428,13 @@ export 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`.
  *
@@ -1358,8 +1448,7 @@ export const hasProperty: {
  * console.log(isOk({ _tag: "Ok", value: 1 }))
  * ```
  *
- * See also: {@link hasProperty}
- *
+ * @see {@link hasProperty}
  * @category guards
  * @since 2.0.0
  */
@@ -1367,11 +1456,13 @@ export 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`.
    *
@@ -1385,8 +1476,7 @@ export const isTagged: {
    * console.log(isOk({ _tag: "Ok", value: 1 }))
    * ```
    *
-   * See also: {@link hasProperty}
-   *
+   * @see {@link hasProperty}
    * @category guards
    * @since 2.0.0
    */
@@ -1394,11 +1484,13 @@ export 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`.
    *
@@ -1412,8 +1504,7 @@ export const isTagged: {
    * console.log(isOk({ _tag: "Ok", value: 1 }))
    * ```
    *
-   * See also: {@link hasProperty}
-   *
+   * @see {@link hasProperty}
    * @category guards
    * @since 2.0.0
    */
@@ -1426,10 +1517,12 @@ export 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`.
  *
@@ -1443,8 +1536,7 @@ export const isTagged: {
  * console.log(Predicate.isError(data))
  * ```
  *
- * See also: {@link isUnknown}
- *
+ * @see {@link isUnknown}
  * @category guards
  * @since 2.0.0
  */
@@ -1455,10 +1547,12 @@ export 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`.
  *
@@ -1472,8 +1566,8 @@ export 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
  */
@@ -1484,10 +1578,12 @@ export 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`.
  *
@@ -1501,8 +1597,7 @@ export 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
  */
@@ -1513,10 +1608,12 @@ export 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`.
@@ -1531,8 +1628,8 @@ export 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
  */
@@ -1543,10 +1640,12 @@ export 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.
  *
@@ -1560,8 +1659,7 @@ export 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
  */
@@ -1572,10 +1670,12 @@ export 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`.
  *
@@ -1589,8 +1689,7 @@ export 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
  */
@@ -1601,10 +1700,12 @@ export function isPromiseLike(input: unknown): input is PromiseLike<unknown> {
 /**
  * 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`.
  *
@@ -1618,8 +1719,7 @@ export function isPromiseLike(input: unknown): input is PromiseLike<unknown> {
  * console.log(Predicate.isRegExp(data))
  * ```
  *
- * See also: {@link isDate}
- *
+ * @see {@link isDate}
  * @category guards
  * @since 3.9.0
  */
@@ -1630,11 +1730,13 @@ export 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`.
@@ -1652,8 +1754,8 @@ export 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
  */
@@ -1661,11 +1763,13 @@ export 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`.
@@ -1683,8 +1787,8 @@ export const compose: {
    * console.log(isIntegerNumber(1))
    * ```
    *
-   * See also: {@link and}, {@link Refinement}
-   *
+   * @see {@link and}
+   * @see {@link Refinement}
    * @category combinators
    * @since 2.0.0
    */
@@ -1692,11 +1796,13 @@ export 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`.
@@ -1714,8 +1820,8 @@ export const compose: {
    * console.log(isIntegerNumber(1))
    * ```
    *
-   * See also: {@link and}, {@link Refinement}
-   *
+   * @see {@link and}
+   * @see {@link Refinement}
    * @category combinators
    * @since 2.0.0
    */
@@ -1723,11 +1829,13 @@ export 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`.
@@ -1745,8 +1853,8 @@ export const compose: {
    * console.log(isIntegerNumber(1))
    * ```
    *
-   * See also: {@link and}, {@link Refinement}
-   *
+   * @see {@link and}
+   * @see {@link Refinement}
    * @category combinators
    * @since 2.0.0
    */
@@ -1754,11 +1862,13 @@ export 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`.
@@ -1776,8 +1886,8 @@ export const compose: {
    * console.log(isIntegerNumber(1))
    * ```
    *
-   * See also: {@link and}, {@link Refinement}
-   *
+   * @see {@link and}
+   * @see {@link Refinement}
    * @category combinators
    * @since 2.0.0
    */
@@ -1791,11 +1901,13 @@ export 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.
@@ -1810,8 +1922,8 @@ export 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
  */
@@ -1836,11 +1948,13 @@ export function Tuple<const T extends ReadonlyArray<Predicate.Any>>(
 /**
  * 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.
@@ -1858,8 +1972,8 @@ export function Tuple<const T extends ReadonlyArray<Predicate.Any>>(
  * 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
  */
@@ -1885,10 +1999,12 @@ export function Struct<R extends Record<string, Predicate.Any>>(
 /**
  * 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.
  *
@@ -1902,8 +2018,9 @@ export function Struct<R extends Record<string, Predicate.Any>>(
  * 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
  */
@@ -1914,11 +2031,13 @@ export 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.
@@ -1933,8 +2052,8 @@ export 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
  */
@@ -1942,11 +2061,13 @@ export 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.
@@ -1961,8 +2082,8 @@ export const or: {
    * console.log(isStringOrNumber("a"))
    * ```
    *
-   * See also: {@link and}, {@link xor}
-   *
+   * @see {@link and}
+   * @see {@link xor}
    * @category combinators
    * @since 2.0.0
    */
@@ -1970,11 +2091,13 @@ export 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.
@@ -1989,8 +2112,8 @@ export const or: {
    * console.log(isStringOrNumber("a"))
    * ```
    *
-   * See also: {@link and}, {@link xor}
-   *
+   * @see {@link and}
+   * @see {@link xor}
    * @category combinators
    * @since 2.0.0
    */
@@ -1998,11 +2121,13 @@ export 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.
@@ -2017,8 +2142,8 @@ export const or: {
    * console.log(isStringOrNumber("a"))
    * ```
    *
-   * See also: {@link and}, {@link xor}
-   *
+   * @see {@link and}
+   * @see {@link xor}
    * @category combinators
    * @since 2.0.0
    */
@@ -2026,11 +2151,13 @@ export 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.
@@ -2045,8 +2172,8 @@ export const or: {
    * console.log(isStringOrNumber("a"))
    * ```
    *
-   * See also: {@link and}, {@link xor}
-   *
+   * @see {@link and}
+   * @see {@link xor}
    * @category combinators
    * @since 2.0.0
    */
@@ -2056,11 +2183,13 @@ export 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.
@@ -2083,8 +2212,8 @@ export const or: {
  * }
  * ```
  *
- * See also: {@link or}, {@link not}
- *
+ * @see {@link or}
+ * @see {@link not}
  * @category combinators
  * @since 2.0.0
  */
@@ -2092,11 +2221,13 @@ export 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.
@@ -2119,8 +2250,8 @@ export const and: {
    * }
    * ```
    *
-   * See also: {@link or}, {@link not}
-   *
+   * @see {@link or}
+   * @see {@link not}
    * @category combinators
    * @since 2.0.0
    */
@@ -2128,11 +2259,13 @@ export 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.
@@ -2155,8 +2288,8 @@ export const and: {
    * }
    * ```
    *
-   * See also: {@link or}, {@link not}
-   *
+   * @see {@link or}
+   * @see {@link not}
    * @category combinators
    * @since 2.0.0
    */
@@ -2164,11 +2297,13 @@ export 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.
@@ -2191,8 +2326,8 @@ export const and: {
    * }
    * ```
    *
-   * See also: {@link or}, {@link not}
-   *
+   * @see {@link or}
+   * @see {@link not}
    * @category combinators
    * @since 2.0.0
    */
@@ -2200,11 +2335,13 @@ export 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.
@@ -2227,8 +2364,8 @@ export const and: {
    * }
    * ```
    *
-   * See also: {@link or}, {@link not}
-   *
+   * @see {@link or}
+   * @see {@link not}
    * @category combinators
    * @since 2.0.0
    */
@@ -2238,10 +2375,12 @@ export 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.
  *
@@ -2257,8 +2396,8 @@ export const and: {
  * console.log(either(-2))
  * ```
  *
- * See also: {@link or}, {@link and}
- *
+ * @see {@link or}
+ * @see {@link and}
  * @category combinators
  * @since 2.0.0
  */
@@ -2266,10 +2405,12 @@ export 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.
    *
@@ -2285,8 +2426,8 @@ export const xor: {
    * console.log(either(-2))
    * ```
    *
-   * See also: {@link or}, {@link and}
-   *
+   * @see {@link or}
+   * @see {@link and}
    * @category combinators
    * @since 2.0.0
    */
@@ -2294,10 +2435,12 @@ export 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.
    *
@@ -2313,8 +2456,8 @@ export const xor: {
    * console.log(either(-2))
    * ```
    *
-   * See also: {@link or}, {@link and}
-   *
+   * @see {@link or}
+   * @see {@link and}
    * @category combinators
    * @since 2.0.0
    */
@@ -2324,10 +2467,12 @@ export 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.
  *
@@ -2342,8 +2487,7 @@ export const xor: {
  * console.log(same(3))
  * ```
  *
- * See also: {@link xor}
- *
+ * @see {@link xor}
  * @category combinators
  * @since 2.0.0
  */
@@ -2351,10 +2495,12 @@ export 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.
    *
@@ -2369,8 +2515,7 @@ export const eqv: {
    * console.log(same(3))
    * ```
    *
-   * See also: {@link xor}
-   *
+   * @see {@link xor}
    * @category combinators
    * @since 2.0.0
    */
@@ -2378,10 +2523,12 @@ export 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.
    *
@@ -2396,8 +2543,7 @@ export const eqv: {
    * console.log(same(3))
    * ```
    *
-   * See also: {@link xor}
-   *
+   * @see {@link xor}
    * @category combinators
    * @since 2.0.0
    */
@@ -2407,11 +2553,13 @@ export 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`.
  *
@@ -2427,8 +2575,8 @@ export const eqv: {
  * console.log(implies(16))
  * ```
  *
- * See also: {@link and}, {@link or}
- *
+ * @see {@link and}
+ * @see {@link or}
  * @category combinators
  * @since 2.0.0
  */
@@ -2436,11 +2584,13 @@ export 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`.
    *
@@ -2456,8 +2606,8 @@ export const implies: {
    * console.log(implies(16))
    * ```
    *
-   * See also: {@link and}, {@link or}
-   *
+   * @see {@link and}
+   * @see {@link or}
    * @category combinators
    * @since 2.0.0
    */
@@ -2465,11 +2615,13 @@ export 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`.
    *
@@ -2485,8 +2637,8 @@ export const implies: {
    * console.log(implies(16))
    * ```
    *
-   * See also: {@link and}, {@link or}
-   *
+   * @see {@link and}
+   * @see {@link or}
    * @category combinators
    * @since 2.0.0
    */
@@ -2499,10 +2651,12 @@ export 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}.
  *
@@ -2516,8 +2670,8 @@ export const implies: {
  * console.log(neither(true))
  * ```
  *
- * See also: {@link or}, {@link not}
- *
+ * @see {@link or}
+ * @see {@link not}
  * @category combinators
  * @since 2.0.0
  */
@@ -2525,10 +2679,12 @@ export 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}.
    *
@@ -2542,8 +2698,8 @@ export const nor: {
    * console.log(neither(true))
    * ```
    *
-   * See also: {@link or}, {@link not}
-   *
+   * @see {@link or}
+   * @see {@link not}
    * @category combinators
    * @since 2.0.0
    */
@@ -2551,10 +2707,12 @@ export 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}.
    *
@@ -2568,8 +2726,8 @@ export const nor: {
    * console.log(neither(true))
    * ```
    *
-   * See also: {@link or}, {@link not}
-   *
+   * @see {@link or}
+   * @see {@link not}
    * @category combinators
    * @since 2.0.0
    */
@@ -2582,10 +2740,12 @@ export 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}.
  *
@@ -2599,8 +2759,8 @@ export const nor: {
  * console.log(notBoth("a"))
  * ```
  *
- * See also: {@link and}, {@link not}
- *
+ * @see {@link and}
+ * @see {@link not}
  * @category combinators
  * @since 2.0.0
  */
@@ -2608,10 +2768,12 @@ export 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}.
    *
@@ -2625,8 +2787,8 @@ export const nand: {
    * console.log(notBoth("a"))
    * ```
    *
-   * See also: {@link and}, {@link not}
-   *
+   * @see {@link and}
+   * @see {@link not}
    * @category combinators
    * @since 2.0.0
    */
@@ -2634,10 +2796,12 @@ export 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}.
    *
@@ -2651,8 +2815,8 @@ export const nand: {
    * console.log(notBoth("a"))
    * ```
    *
-   * See also: {@link and}, {@link not}
-   *
+   * @see {@link and}
+   * @see {@link not}
    * @category combinators
    * @since 2.0.0
    */
@@ -2665,10 +2829,12 @@ export 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.
@@ -2683,8 +2849,8 @@ export const nand: {
  * console.log(allChecks(2))
  * ```
  *
- * See also: {@link some}, {@link and}
- *
+ * @see {@link some}
+ * @see {@link and}
  * @category elements
  * @since 2.0.0
  */
@@ -2702,10 +2868,12 @@ export function every<A>(collection: Iterable<Predicate<A>>): Predicate<A> {
 /**
  * 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.
@@ -2720,8 +2888,8 @@ export function every<A>(collection: Iterable<Predicate<A>>): Predicate<A> {
  * console.log(anyCheck("ok"))
  * ```
  *
- * See also: {@link every}, {@link or}
- *
+ * @see {@link every}
+ * @see {@link or}
  * @category elements
  * @since 2.0.0
  */