effect 4.0.0-beta.70 → 4.0.0-beta.72

package/dist/Predicate.d.ts

@@ -5,13 +5,12 @@ import type { TupleOf, TupleOfAtLeast } from "./Types.ts";
  *
  * **When to use**
  *
- * - You want a reusable boolean check for `A`.
+ * Use when 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.
  *
  * **Details**
  *
- * - Pure function; does not mutate input.
  * - Returns `true` or `false`; never throws by itself.
  * - Does not narrow types unless you use {@link Refinement}.
  *
@@ -39,7 +38,7 @@ export interface Predicate<in A> {
  *
  * **When to use**
  *
- * - You are defining APIs that abstract over predicates with HKTs.
+ * Use when you are defining APIs that abstract over predicates with HKTs.
  * - You need a `TypeLambda` instance for predicate-based type classes.
  *
  * **Details**
@@ -68,13 +67,12 @@ export interface PredicateTypeLambda extends TypeLambda {
  *
  * **When to use**
  *
- * - You want a runtime check that refines `A` to `B` for TypeScript.
+ * Use when 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.
  *
  * **Details**
  *
- * - Pure function; does not mutate input.
  * - Returns a type predicate (`a is B`).
  * - Use with `if`/`filter` to narrow types.
  *
@@ -105,7 +103,7 @@ export interface Refinement<in A, out B extends A> {
  *
  * **When to use**
  *
- * - You need to extract input types from predicate signatures.
+ * Use when you need to extract input types from predicate signatures.
  * - You want to write generic helpers over predicate types.
  *
  * **Details**
@@ -132,7 +130,7 @@ export declare namespace Predicate {
      *
      * **When to use**
      *
-     * - You want to infer the input type from a predicate type.
+     * Use when you want to infer the input type from a predicate type.
      * - You are defining generic utilities over predicates.
      *
      * **Details**
@@ -160,7 +158,7 @@ export declare namespace Predicate {
      *
      * **When to use**
      *
-     * - You need a constraint for "any predicate" in generic code.
+     * Use when you need a constraint for "any predicate" in generic code.
      *
      * **Details**
      *
@@ -185,7 +183,7 @@ export declare namespace Predicate {
  *
  * **When to use**
  *
- * - You need to extract input/output types from refinement signatures.
+ * Use when you need to extract input/output types from refinement signatures.
  * - You want to write generic helpers over refinements.
  *
  * **Details**
@@ -213,7 +211,7 @@ export declare namespace Refinement {
      *
      * **When to use**
      *
-     * - You want to infer the input type from a refinement type.
+     * Use when you want to infer the input type from a refinement type.
      *
      * **Details**
      *
@@ -240,7 +238,7 @@ export declare namespace Refinement {
      *
      * **When to use**
      *
-     * - You want to infer the narrowed type from a refinement type.
+     * Use when you want to infer the narrowed type from a refinement type.
      *
      * **Details**
      *
@@ -266,7 +264,7 @@ export declare namespace Refinement {
      *
      * **When to use**
      *
-     * - You need a constraint for "any refinement" in generic code.
+     * Use when you need a constraint for "any refinement" in generic code.
      *
      * **Details**
      *
@@ -292,12 +290,11 @@ export declare namespace Refinement {
  *
  * **When to use**
  *
- * - You have a predicate on `A` and want one on `B` via `B -> A`.
+ * Use when you have a predicate on `A` and want one on `B` via `B -> A`.
  * - You want to check derived values (lengths, projections, etc.).
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns a new predicate that applies `f` before `self`.
  * - No short-circuit beyond what `self` does.
  *
@@ -325,12 +322,11 @@ export declare const mapInput: {
      *
      * **When to use**
      *
-     * - You have a predicate on `A` and want one on `B` via `B -> A`.
+     * Use when you have a predicate on `A` and want one on `B` via `B -> A`.
      * - You want to check derived values (lengths, projections, etc.).
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns a new predicate that applies `f` before `self`.
      * - No short-circuit beyond what `self` does.
      *
@@ -358,12 +354,11 @@ export declare const mapInput: {
      *
      * **When to use**
      *
-     * - You have a predicate on `A` and want one on `B` via `B -> A`.
+     * Use when you have a predicate on `A` and want one on `B` via `B -> A`.
      * - You want to check derived values (lengths, projections, etc.).
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns a new predicate that applies `f` before `self`.
      * - No short-circuit beyond what `self` does.
      *
@@ -392,12 +387,11 @@ export declare const mapInput: {
  *
  * **When to use**
  *
- * - You need a runtime check for tuple length.
+ * Use when you need a runtime check for tuple length.
  * - You want to narrow `ReadonlyArray<T>` to `TupleOf<N, T>`.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Only checks length, not element types.
  * - Returns a refinement on the array type.
  *
@@ -422,12 +416,11 @@ export declare const isTupleOf: {
      *
      * **When to use**
      *
-     * - You need a runtime check for tuple length.
+     * Use when you need a runtime check for tuple length.
      * - You want to narrow `ReadonlyArray<T>` to `TupleOf<N, T>`.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Only checks length, not element types.
      * - Returns a refinement on the array type.
      *
@@ -452,12 +445,11 @@ export declare const isTupleOf: {
      *
      * **When to use**
      *
-     * - You need a runtime check for tuple length.
+     * Use when you need a runtime check for tuple length.
      * - You want to narrow `ReadonlyArray<T>` to `TupleOf<N, T>`.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Only checks length, not element types.
      * - Returns a refinement on the array type.
      *
@@ -483,12 +475,11 @@ export declare const isTupleOf: {
  *
  * **When to use**
  *
- * - You need a runtime check for tuple-like minimum length.
+ * Use when you need a runtime check for tuple-like minimum length.
  * - You want to narrow `ReadonlyArray<T>` to `TupleOfAtLeast<N, T>`.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Only checks length, not element types.
  * - Returns a refinement on the array type.
  *
@@ -513,12 +504,11 @@ export declare const isTupleOfAtLeast: {
      *
      * **When to use**
      *
-     * - You need a runtime check for tuple-like minimum length.
+     * Use when you need a runtime check for tuple-like minimum length.
      * - You want to narrow `ReadonlyArray<T>` to `TupleOfAtLeast<N, T>`.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Only checks length, not element types.
      * - Returns a refinement on the array type.
      *
@@ -543,12 +533,11 @@ export declare const isTupleOfAtLeast: {
      *
      * **When to use**
      *
-     * - You need a runtime check for tuple-like minimum length.
+     * Use when you need a runtime check for tuple-like minimum length.
      * - You want to narrow `ReadonlyArray<T>` to `TupleOfAtLeast<N, T>`.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Only checks length, not element types.
      * - Returns a refinement on the array type.
      *
@@ -574,12 +563,11 @@ export declare const isTupleOfAtLeast: {
  *
  * **When to use**
  *
- * - You want a predicate that mirrors JavaScript truthiness.
+ * Use when you want a predicate that mirrors JavaScript truthiness.
  * - You need to filter out falsy values like `0`, "", and `false`.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `!!input` under the hood.
  * - Treats `0`, "", `false`, `null`, and `undefined` as false.
  *
@@ -605,11 +593,10 @@ export declare function isTruthy(input: unknown): boolean;
  *
  * **When to use**
  *
- * - You need a runtime guard for `Set` values.
+ * Use when you need a runtime guard for `Set` values.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof Set`.
  *
  * **Example** (Guard a Set)
@@ -635,11 +622,10 @@ export declare function isSet(input: unknown): input is Set<unknown>;
  *
  * **When to use**
  *
- * - You need a runtime guard for `Map` values.
+ * Use when you need a runtime guard for `Map` values.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof Map`.
  *
  * **Example** (Guard a Map)
@@ -665,12 +651,11 @@ export declare function isMap(input: unknown): input is Map<unknown, unknown>;
  *
  * **When to use**
  *
- * - You need to guard an `unknown` value as a string.
+ * Use when you need to guard an `unknown` value as a string.
  * - You want to narrow in `if` statements.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "string"`.
  *
  * **Example** (Guard string)
@@ -697,11 +682,10 @@ export declare function isString(input: unknown): input is string;
  *
  * **When to use**
  *
- * - You need to guard an `unknown` value as a number.
+ * Use when you need to guard an `unknown` value as a number.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "number"`.
  * - Does not exclude `NaN` or `Infinity`.
  *
@@ -728,11 +712,10 @@ export declare function isNumber(input: unknown): input is number;
  *
  * **When to use**
  *
- * - You need to guard an `unknown` value as a boolean.
+ * Use when you need to guard an `unknown` value as a boolean.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "boolean"`.
  *
  * **Example** (Guard boolean)
@@ -758,11 +741,10 @@ export declare function isBoolean(input: unknown): input is boolean;
  *
  * **When to use**
  *
- * - You need to guard an `unknown` value as a bigint.
+ * Use when you need to guard an `unknown` value as a bigint.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "bigint"`.
  *
  * **Example** (Guard bigint)
@@ -787,11 +769,10 @@ export declare function isBigInt(input: unknown): input is bigint;
  *
  * **When to use**
  *
- * - You need to guard an `unknown` value as a symbol.
+ * Use when you need to guard an `unknown` value as a symbol.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "symbol"`.
  *
  * **Example** (Guard symbol)
@@ -816,11 +797,10 @@ export declare function isSymbol(input: unknown): input is symbol;
  *
  * **When to use**
  *
- * - You need to guard unknown keys before indexing.
+ * Use when you need to guard unknown keys before indexing.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses {@link isString}, {@link isNumber}, and {@link isSymbol}.
  *
  * **Example** (Guard property key)
@@ -848,11 +828,10 @@ export declare function isPropertyKey(u: unknown): u is PropertyKey;
  *
  * **When to use**
  *
- * - You need to guard an `unknown` value as callable.
+ * Use when you need to guard an `unknown` value as callable.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "function"`.
  *
  * **Example** (Guard function)
@@ -877,11 +856,10 @@ export declare function isFunction(input: unknown): input is Function;
  *
  * **When to use**
  *
- * - You need a guard for optional values.
+ * Use when you need a guard for optional values.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `input === undefined`.
  *
  * **Example** (Guard undefined)
@@ -905,11 +883,10 @@ export declare function isUndefined(input: unknown): input is undefined;
  *
  * **When to use**
  *
- * - You want to filter out `undefined` while preserving other falsy values.
+ * Use when you want to filter out `undefined` while preserving other falsy values.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns a refinement that excludes `undefined`.
  *
  * **Example** (Filter undefined)
@@ -934,11 +911,10 @@ export declare function isNotUndefined<A>(input: A): input is Exclude<A, undefin
  *
  * **When to use**
  *
- * - You need a guard for nullable values.
+ * Use when you need a guard for nullable values.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `input === null`.
  *
  * **Example** (Guard null)
@@ -962,11 +938,10 @@ export declare function isNull(input: unknown): input is null;
  *
  * **When to use**
  *
- * - You want to filter out `null` while preserving other falsy values.
+ * Use when you want to filter out `null` while preserving other falsy values.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns a refinement that excludes `null`.
  *
  * **Example** (Filter null)
@@ -991,11 +966,10 @@ export declare function isNotNull<A>(input: A): input is Exclude<A, null>;
  *
  * **When to use**
  *
- * - You want to guard nullish values explicitly.
+ * Use when you want to guard nullish values explicitly.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `input === null || input === undefined`.
  *
  * **Example** (Guard nullish)
@@ -1021,11 +995,10 @@ export declare function isNullish<A>(input: A): input is A & (null | undefined);
  *
  * **When to use**
  *
- * - You want to filter out nullish values but keep other falsy ones.
+ * Use when you want to filter out nullish values but keep other falsy ones.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `input != null`.
  *
  * **Example** (Filter non-nullish)
@@ -1047,15 +1020,14 @@ export declare function isNullish<A>(input: A): input is A & (null | undefined);
  */
 export declare function isNotNullish<A>(input: A): input is NonNullable<A>;
 /**
- * A guard that always returns `false`.
+ * Type guard that always returns `false`.
  *
  * **When to use**
  *
- * - You need a predicate that never accepts, e.g. in default branches.
+ * Use when you need a predicate that never accepts, e.g. in default branches.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Always returns `false`.
  *
  * **Example** (Never matches)
@@ -1072,15 +1044,14 @@ export declare function isNotNullish<A>(input: A): input is NonNullable<A>;
  */
 export declare function isNever(_: unknown): _ is never;
 /**
- * A guard that always returns `true`.
+ * Type guard that always returns `true`.
  *
  * **When to use**
  *
- * - You need a predicate that always accepts, e.g. as a placeholder.
+ * Use when you need a predicate that always accepts, e.g. as a placeholder.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Always returns `true`.
  *
  * **Example** (Always matches)
@@ -1101,11 +1072,10 @@ export declare function isUnknown(_: unknown): _ is unknown;
  *
  * **When to use**
  *
- * - You want to accept plain objects and arrays, but not `null`.
+ * Use when you want to accept plain objects and arrays, but not `null`.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "object" && input !== null`.
  * - Includes arrays.
  *
@@ -1128,6 +1098,10 @@ export declare function isObjectOrArray(input: unknown): input is {
 /**
  * Checks whether a value is a non-null object value that is not an array.
  *
+ * **When to use**
+ *
+ * Use to narrow unknown input to a non-null, non-array object.
+ *
  * **Details**
  *
  * This is a structural runtime check using `typeof input === "object"`, so it
@@ -1155,6 +1129,11 @@ 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.
  *
+ * **When to use**
+ *
+ * Use to narrow unknown input to a readonly view of a non-null, non-array
+ * object.
+ *
  * **Details**
  *
  * Readonly-ness is a TypeScript type-level view; it is not observable at
@@ -1183,11 +1162,10 @@ export declare function isReadonlyObject(input: unknown): input is {
  *
  * **When to use**
  *
- * - You want to accept arrays and functions as well as objects.
+ * Use when you want to accept arrays and functions as well as objects.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns `true` for arrays and functions, `false` for `null`.
  *
  * **Example** (Object keyword)
@@ -1210,12 +1188,11 @@ export declare function isObjectKeyword(input: unknown): input is object;
  *
  * **When to use**
  *
- * - You need to guard property access on `unknown` values.
+ * Use when you need to guard property access on `unknown` values.
  * - You want a simple structural guard for objects.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses the `in` operator and {@link isObjectKeyword}.
  * - Does not check property value types.
  *
@@ -1243,12 +1220,11 @@ export declare const hasProperty: {
      *
      * **When to use**
      *
-     * - You need to guard property access on `unknown` values.
+     * Use when you need to guard property access on `unknown` values.
      * - You want a simple structural guard for objects.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Uses the `in` operator and {@link isObjectKeyword}.
      * - Does not check property value types.
      *
@@ -1278,12 +1254,11 @@ export declare const hasProperty: {
      *
      * **When to use**
      *
-     * - You need to guard property access on `unknown` values.
+     * Use when you need to guard property access on `unknown` values.
      * - You want a simple structural guard for objects.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Uses the `in` operator and {@link isObjectKeyword}.
      * - Does not check property value types.
      *
@@ -1314,12 +1289,11 @@ export declare const hasProperty: {
  *
  * **When to use**
  *
- * - You model tagged unions with a `_tag` field.
+ * Use when you model tagged unions with a `_tag` field.
  * - You want a quick, structural guard for tagged values.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses {@link hasProperty} and strict equality on `_tag`.
  *
  * **Example** (Guard tagged)
@@ -1342,12 +1316,11 @@ export declare const isTagged: {
      *
      * **When to use**
      *
-     * - You model tagged unions with a `_tag` field.
+     * Use when you model tagged unions with a `_tag` field.
      * - You want a quick, structural guard for tagged values.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Uses {@link hasProperty} and strict equality on `_tag`.
      *
      * **Example** (Guard tagged)
@@ -1372,12 +1345,11 @@ export declare const isTagged: {
      *
      * **When to use**
      *
-     * - You model tagged unions with a `_tag` field.
+     * Use when you model tagged unions with a `_tag` field.
      * - You want a quick, structural guard for tagged values.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Uses {@link hasProperty} and strict equality on `_tag`.
      *
      * **Example** (Guard tagged)
@@ -1403,11 +1375,10 @@ export declare const isTagged: {
  *
  * **When to use**
  *
- * - You need to guard errors caught from unknown sources.
+ * Use when you need to guard errors caught from unknown sources.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof Error`.
  *
  * **Example** (Guard error)
@@ -1430,11 +1401,10 @@ export declare function isError(input: unknown): input is Error;
  *
  * **When to use**
  *
- * - You need to guard binary data at runtime.
+ * Use when you need to guard binary data at runtime.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof Uint8Array`.
  *
  * **Example** (Guard Uint8Array)
@@ -1458,11 +1428,10 @@ export declare function isUint8Array(input: unknown): input is Uint8Array;
  *
  * **When to use**
  *
- * - You need to guard dates at runtime.
+ * Use when you need to guard dates at runtime.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof Date`.
  *
  * **Example** (Guard Date)
@@ -1485,11 +1454,10 @@ export declare function isDate(input: unknown): input is Date;
  *
  * **When to use**
  *
- * - You need a guard before iterating an unknown value.
+ * Use when you need a guard before iterating an unknown value.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Accepts strings as iterable.
  * - Uses {@link hasProperty} for `Symbol.iterator`.
  *
@@ -1514,11 +1482,10 @@ export declare function isIterable(input: unknown): input is Iterable<unknown>;
  *
  * **When to use**
  *
- * - You need to detect promise instances across realms.
+ * Use when you need to detect promise instances across realms.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Structural check for `then` and `catch` functions.
  *
  * **Example** (Guard promise)
@@ -1541,11 +1508,10 @@ export declare function isPromise(input: unknown): input is Promise<unknown>;
  *
  * **When to use**
  *
- * - You only need `then` to interop with promise-like values.
+ * Use when you only need `then` to interop with promise-like values.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Structural check for a callable `then`.
  *
  * **Example** (Guard promise-like)
@@ -1568,11 +1534,10 @@ export declare function isPromiseLike(input: unknown): input is PromiseLike<unkn
  *
  * **When to use**
  *
- * - You need a runtime guard for regular expressions.
+ * Use when you need a runtime guard for regular expressions.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof RegExp`.
  *
  * **Example** (Guard RegExp)
@@ -1595,12 +1560,11 @@ export declare function isRegExp(input: unknown): input is RegExp;
  *
  * **When to use**
  *
- * - You want to chain two refinements for progressive narrowing.
+ * Use when you want to chain two refinements for progressive narrowing.
  * - You want a predicate that applies two checks in sequence.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - For refinements, the output type is narrowed by both.
  * - Short-circuits on the first `false`.
  *
@@ -1628,12 +1592,11 @@ export declare const compose: {
      *
      * **When to use**
      *
-     * - You want to chain two refinements for progressive narrowing.
+     * Use when you want to chain two refinements for progressive narrowing.
      * - You want a predicate that applies two checks in sequence.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - For refinements, the output type is narrowed by both.
      * - Short-circuits on the first `false`.
      *
@@ -1661,12 +1624,11 @@ export declare const compose: {
      *
      * **When to use**
      *
-     * - You want to chain two refinements for progressive narrowing.
+     * Use when you want to chain two refinements for progressive narrowing.
      * - You want a predicate that applies two checks in sequence.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - For refinements, the output type is narrowed by both.
      * - Short-circuits on the first `false`.
      *
@@ -1694,12 +1656,11 @@ export declare const compose: {
      *
      * **When to use**
      *
-     * - You want to chain two refinements for progressive narrowing.
+     * Use when you want to chain two refinements for progressive narrowing.
      * - You want a predicate that applies two checks in sequence.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - For refinements, the output type is narrowed by both.
      * - Short-circuits on the first `false`.
      *
@@ -1727,12 +1688,11 @@ export declare const compose: {
      *
      * **When to use**
      *
-     * - You want to chain two refinements for progressive narrowing.
+     * Use when you want to chain two refinements for progressive narrowing.
      * - You want a predicate that applies two checks in sequence.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - For refinements, the output type is narrowed by both.
      * - Short-circuits on the first `false`.
      *
@@ -1761,12 +1721,11 @@ export declare const compose: {
  *
  * **When to use**
  *
- * - You want to validate tuple positions independently.
+ * Use when you want to validate tuple positions independently.
  * - You want to lift element predicates into a tuple predicate.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns a refinement if any element predicate is a refinement.
  * - Stops at the first failing element.
  *
@@ -1797,12 +1756,11 @@ export declare function Tuple<const T extends ReadonlyArray<Predicate.Any>>(elem
  *
  * **When to use**
  *
- * - You want to validate a record shape at runtime.
+ * Use when you want to validate a record shape at runtime.
  * - You want to lift property predicates into an object predicate.
  *
  * **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.
  *
@@ -1836,11 +1794,10 @@ export declare function Struct<R extends Record<string, Predicate.Any>>(fields:
  *
  * **When to use**
  *
- * - You want the inverse of an existing predicate.
+ * Use when you want the inverse of an existing predicate.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns a new predicate that flips the boolean result.
  *
  * **Example** (Negate)
@@ -1865,12 +1822,11 @@ export declare function not<A>(self: Predicate<A>): Predicate<A>;
  *
  * **When to use**
  *
- * - You want to accept values that satisfy at least one condition.
+ * Use when you want to accept values that satisfy at least one condition.
  * - You want to combine refinements with union narrowing.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Short-circuits on the first `true`.
  * - For refinements, the output type is a union.
  *
@@ -1895,12 +1851,11 @@ export declare const or: {
      *
      * **When to use**
      *
-     * - You want to accept values that satisfy at least one condition.
+     * Use when you want to accept values that satisfy at least one condition.
      * - You want to combine refinements with union narrowing.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Short-circuits on the first `true`.
      * - For refinements, the output type is a union.
      *
@@ -1925,12 +1880,11 @@ export declare const or: {
      *
      * **When to use**
      *
-     * - You want to accept values that satisfy at least one condition.
+     * Use when you want to accept values that satisfy at least one condition.
      * - You want to combine refinements with union narrowing.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Short-circuits on the first `true`.
      * - For refinements, the output type is a union.
      *
@@ -1955,12 +1909,11 @@ export declare const or: {
      *
      * **When to use**
      *
-     * - You want to accept values that satisfy at least one condition.
+     * Use when you want to accept values that satisfy at least one condition.
      * - You want to combine refinements with union narrowing.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Short-circuits on the first `true`.
      * - For refinements, the output type is a union.
      *
@@ -1985,12 +1938,11 @@ export declare const or: {
      *
      * **When to use**
      *
-     * - You want to accept values that satisfy at least one condition.
+     * Use when you want to accept values that satisfy at least one condition.
      * - You want to combine refinements with union narrowing.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Short-circuits on the first `true`.
      * - For refinements, the output type is a union.
      *
@@ -2016,12 +1968,11 @@ export declare const or: {
  *
  * **When to use**
  *
- * - You want to accept values that satisfy multiple conditions.
+ * Use when you want to accept values that satisfy multiple conditions.
  * - You want to combine refinements with intersection narrowing.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Short-circuits on the first `false`.
  * - For refinements, the output type is an intersection.
  *
@@ -2054,12 +2005,11 @@ export declare const and: {
      *
      * **When to use**
      *
-     * - You want to accept values that satisfy multiple conditions.
+     * Use when you want to accept values that satisfy multiple conditions.
      * - You want to combine refinements with intersection narrowing.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Short-circuits on the first `false`.
      * - For refinements, the output type is an intersection.
      *
@@ -2092,12 +2042,11 @@ export declare const and: {
      *
      * **When to use**
      *
-     * - You want to accept values that satisfy multiple conditions.
+     * Use when you want to accept values that satisfy multiple conditions.
      * - You want to combine refinements with intersection narrowing.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Short-circuits on the first `false`.
      * - For refinements, the output type is an intersection.
      *
@@ -2130,12 +2079,11 @@ export declare const and: {
      *
      * **When to use**
      *
-     * - You want to accept values that satisfy multiple conditions.
+     * Use when you want to accept values that satisfy multiple conditions.
      * - You want to combine refinements with intersection narrowing.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Short-circuits on the first `false`.
      * - For refinements, the output type is an intersection.
      *
@@ -2168,12 +2116,11 @@ export declare const and: {
      *
      * **When to use**
      *
-     * - You want to accept values that satisfy multiple conditions.
+     * Use when you want to accept values that satisfy multiple conditions.
      * - You want to combine refinements with intersection narrowing.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Short-circuits on the first `false`.
      * - For refinements, the output type is an intersection.
      *
@@ -2207,11 +2154,10 @@ export declare const and: {
  *
  * **When to use**
  *
- * - You want an exclusive-or between two conditions.
+ * Use when you want an exclusive-or between two conditions.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns `true` when results differ.
  *
  * **Example** (Exclusive or)
@@ -2237,11 +2183,10 @@ export declare const xor: {
      *
      * **When to use**
      *
-     * - You want an exclusive-or between two conditions.
+     * Use when you want an exclusive-or between two conditions.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns `true` when results differ.
      *
      * **Example** (Exclusive or)
@@ -2267,11 +2212,10 @@ export declare const xor: {
      *
      * **When to use**
      *
-     * - You want an exclusive-or between two conditions.
+     * Use when you want an exclusive-or between two conditions.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns `true` when results differ.
      *
      * **Example** (Exclusive or)
@@ -2298,11 +2242,10 @@ export declare const xor: {
  *
  * **When to use**
  *
- * - You want to check equivalence of two predicates.
+ * Use when you want to check equivalence of two predicates.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns `true` when both results are equal.
  *
  * **Example** (Equivalence)
@@ -2326,11 +2269,10 @@ export declare const eqv: {
      *
      * **When to use**
      *
-     * - You want to check equivalence of two predicates.
+     * Use when you want to check equivalence of two predicates.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns `true` when both results are equal.
      *
      * **Example** (Equivalence)
@@ -2354,11 +2296,10 @@ export declare const eqv: {
      *
      * **When to use**
      *
-     * - You want to check equivalence of two predicates.
+     * Use when you want to check equivalence of two predicates.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns `true` when both results are equal.
      *
      * **Example** (Equivalence)
@@ -2383,12 +2324,11 @@ export declare const eqv: {
  *
  * **When to use**
  *
- * - You want a rule that only applies when a precondition holds.
+ * Use when you want a rule that only applies when a precondition holds.
  * - You model constraints like "if A then B".
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns `true` when the antecedent is `false`.
  *
  * **Example** (Implication)
@@ -2414,12 +2354,11 @@ export declare const implies: {
      *
      * **When to use**
      *
-     * - You want a rule that only applies when a precondition holds.
+     * Use when you want a rule that only applies when a precondition holds.
      * - You model constraints like "if A then B".
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns `true` when the antecedent is `false`.
      *
      * **Example** (Implication)
@@ -2445,12 +2384,11 @@ export declare const implies: {
      *
      * **When to use**
      *
-     * - You want a rule that only applies when a precondition holds.
+     * Use when you want a rule that only applies when a precondition holds.
      * - You model constraints like "if A then B".
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns `true` when the antecedent is `false`.
      *
      * **Example** (Implication)
@@ -2477,11 +2415,10 @@ export declare const implies: {
  *
  * **When to use**
  *
- * - You want the logical NOR of two conditions.
+ * Use when you want the logical NOR of two conditions.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns the negation of {@link or}.
  *
  * **Example** (NOR)
@@ -2505,11 +2442,10 @@ export declare const nor: {
      *
      * **When to use**
      *
-     * - You want the logical NOR of two conditions.
+     * Use when you want the logical NOR of two conditions.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns the negation of {@link or}.
      *
      * **Example** (NOR)
@@ -2533,11 +2469,10 @@ export declare const nor: {
      *
      * **When to use**
      *
-     * - You want the logical NOR of two conditions.
+     * Use when you want the logical NOR of two conditions.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns the negation of {@link or}.
      *
      * **Example** (NOR)
@@ -2562,11 +2497,10 @@ export declare const nor: {
  *
  * **When to use**
  *
- * - You want the logical NAND of two conditions.
+ * Use when you want the logical NAND of two conditions.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns the negation of {@link and}.
  *
  * **Example** (NAND)
@@ -2590,11 +2524,10 @@ export declare const nand: {
      *
      * **When to use**
      *
-     * - You want the logical NAND of two conditions.
+     * Use when you want the logical NAND of two conditions.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns the negation of {@link and}.
      *
      * **Example** (NAND)
@@ -2618,11 +2551,10 @@ export declare const nand: {
      *
      * **When to use**
      *
-     * - You want the logical NAND of two conditions.
+     * Use when you want the logical NAND of two conditions.
      *
      * **Details**
      *
-     * - Pure; does not mutate input.
      * - Returns the negation of {@link and}.
      *
      * **Example** (NAND)
@@ -2647,11 +2579,10 @@ export declare const nand: {
  *
  * **When to use**
  *
- * - You have a dynamic list of predicates to apply.
+ * Use when you have a dynamic list of predicates to apply.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Short-circuits on the first `false`.
  * - Iterates the collection each time the predicate is called.
  *
@@ -2676,11 +2607,10 @@ export declare function every<A>(collection: Iterable<Predicate<A>>): Predicate<
  *
  * **When to use**
  *
- * - You have a dynamic list of predicates and only need one to pass.
+ * Use when you have a dynamic list of predicates and only need one to pass.
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Short-circuits on the first `true`.
  * - Iterates the collection each time the predicate is called.
  *