effect 4.0.0-beta.70 → 4.0.0-beta.71

package/dist/Predicate.d.ts

@@ -5,7 +5,7 @@ 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.
  *
@@ -39,7 +39,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,7 +68,7 @@ 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.
  *
@@ -105,7 +105,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 +132,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 +160,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 +185,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 +213,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 +240,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 +266,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,7 +292,7 @@ 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**
@@ -325,7 +325,7 @@ 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**
@@ -358,7 +358,7 @@ 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**
@@ -392,7 +392,7 @@ 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**
@@ -422,7 +422,7 @@ 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**
@@ -452,7 +452,7 @@ 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**
@@ -483,7 +483,7 @@ 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**
@@ -513,7 +513,7 @@ 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**
@@ -543,7 +543,7 @@ 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**
@@ -574,7 +574,7 @@ 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**
@@ -605,7 +605,7 @@ 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**
  *
@@ -635,7 +635,7 @@ 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**
  *
@@ -665,7 +665,7 @@ 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**
@@ -697,7 +697,7 @@ 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**
  *
@@ -728,7 +728,7 @@ 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**
  *
@@ -758,7 +758,7 @@ 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**
  *
@@ -787,7 +787,7 @@ 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**
  *
@@ -816,7 +816,7 @@ 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**
  *
@@ -848,7 +848,7 @@ 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**
  *
@@ -877,7 +877,7 @@ 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**
  *
@@ -905,7 +905,7 @@ 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**
  *
@@ -934,7 +934,7 @@ 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**
  *
@@ -962,7 +962,7 @@ 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**
  *
@@ -991,7 +991,7 @@ 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**
  *
@@ -1021,7 +1021,7 @@ 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**
  *
@@ -1051,7 +1051,7 @@ export declare function isNotNullish<A>(input: A): input is NonNullable<A>;
  *
  * **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**
  *
@@ -1076,7 +1076,7 @@ export declare function isNever(_: unknown): _ is never;
  *
  * **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**
  *
@@ -1101,7 +1101,7 @@ 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**
  *
@@ -1128,6 +1128,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 +1159,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,7 +1192,7 @@ 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**
  *
@@ -1210,7 +1219,7 @@ 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**
@@ -1243,7 +1252,7 @@ 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**
@@ -1278,7 +1287,7 @@ 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**
@@ -1314,7 +1323,7 @@ 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**
@@ -1342,7 +1351,7 @@ 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**
@@ -1372,7 +1381,7 @@ 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**
@@ -1403,7 +1412,7 @@ 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**
  *
@@ -1430,7 +1439,7 @@ 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**
  *
@@ -1458,7 +1467,7 @@ 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**
  *
@@ -1485,7 +1494,7 @@ 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**
  *
@@ -1514,7 +1523,7 @@ 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**
  *
@@ -1541,7 +1550,7 @@ 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**
  *
@@ -1568,7 +1577,7 @@ 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**
  *
@@ -1595,7 +1604,7 @@ 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**
@@ -1628,7 +1637,7 @@ 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**
@@ -1661,7 +1670,7 @@ 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**
@@ -1694,7 +1703,7 @@ 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**
@@ -1727,7 +1736,7 @@ 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**
@@ -1761,7 +1770,7 @@ 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**
@@ -1797,7 +1806,7 @@ 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**
@@ -1836,7 +1845,7 @@ 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**
  *
@@ -1865,7 +1874,7 @@ 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**
@@ -1895,7 +1904,7 @@ 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**
@@ -1925,7 +1934,7 @@ 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**
@@ -1955,7 +1964,7 @@ 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**
@@ -1985,7 +1994,7 @@ 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**
@@ -2016,7 +2025,7 @@ 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**
@@ -2054,7 +2063,7 @@ 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**
@@ -2092,7 +2101,7 @@ 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**
@@ -2130,7 +2139,7 @@ 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**
@@ -2168,7 +2177,7 @@ 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**
@@ -2207,7 +2216,7 @@ 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**
  *
@@ -2237,7 +2246,7 @@ 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**
      *
@@ -2267,7 +2276,7 @@ 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**
      *
@@ -2298,7 +2307,7 @@ 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**
  *
@@ -2326,7 +2335,7 @@ 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**
      *
@@ -2354,7 +2363,7 @@ 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**
      *
@@ -2383,7 +2392,7 @@ 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**
@@ -2414,7 +2423,7 @@ 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**
@@ -2445,7 +2454,7 @@ 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**
@@ -2477,7 +2486,7 @@ 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**
  *
@@ -2505,7 +2514,7 @@ 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**
      *
@@ -2533,7 +2542,7 @@ 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**
      *
@@ -2562,7 +2571,7 @@ 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**
  *
@@ -2590,7 +2599,7 @@ 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**
      *
@@ -2618,7 +2627,7 @@ 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**
      *
@@ -2647,7 +2656,7 @@ 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**
  *
@@ -2676,7 +2685,7 @@ 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**
  *