effect 3.16.13 → 3.16.14

package/dist/cjs/Predicate.js

@@ -6,23 +6,45 @@ Object.defineProperty(exports, "__esModule", {
 exports.xor = exports.tuple = exports.struct = exports.some = exports.productMany = exports.product = exports.or = exports.not = exports.nor = exports.nand = exports.mapInput = exports.isUnknown = exports.isUndefined = exports.isUint8Array = exports.isTupleOfAtLeast = exports.isTupleOf = exports.isTruthy = exports.isTagged = exports.isSymbol = exports.isString = exports.isSet = exports.isRegExp = exports.isRecordOrArray = exports.isRecord = exports.isReadonlyRecord = exports.isPropertyKey = exports.isPromiseLike = exports.isPromise = exports.isObject = exports.isNumber = exports.isNullable = exports.isNull = exports.isNotUndefined = exports.isNotNullable = exports.isNotNull = exports.isNever = exports.isMap = exports.isIterable = exports.isFunction = exports.isError = exports.isDate = exports.isBoolean = exports.isBigInt = exports.implies = exports.hasProperty = exports.every = exports.eqv = exports.compose = exports.and = exports.all = void 0;
 var _Function = require("./Function.js");
 /**
+ * This module provides a collection of functions for working with predicates and refinements.
+ *
+ * A `Predicate<A>` is a function that takes a value of type `A` and returns a boolean.
+ * It is used to check if a value satisfies a certain condition.
+ *
+ * A `Refinement<A, B>` is a special type of predicate that not only checks a condition
+ * but also provides a type guard, allowing TypeScript to narrow the type of the input
+ * value from `A` to a more specific type `B` within a conditional block.
+ *
+ * The module includes:
+ * - Basic predicates and refinements for common types (e.g., `isString`, `isNumber`).
+ * - Combinators to create new predicates from existing ones (e.g., `and`, `or`, `not`).
+ * - Advanced combinators for working with data structures (e.g., `tuple`, `struct`).
+ * - Type-level utilities for inspecting predicate and refinement types.
+ *
  * @since 2.0.0
  */
 
 /**
- * Given a `Predicate<A>` returns a `Predicate<B>`
+ * Transforms a `Predicate<A>` into a `Predicate<B>` by applying a function `(b: B) => A`
+ * to the input before passing it to the predicate. This is also known as "contramap" or
+ * "pre-composition".
  *
  * @example
  * ```ts
- * import * as assert from "node:assert"
  * import { Predicate, Number } from "effect"
+ * import * as assert from "node:assert"
+ *
+ * // A predicate on numbers
+ * const isPositive: Predicate.Predicate<number> = Number.greaterThan(0)
  *
- * const minLength3 = Predicate.mapInput(Number.greaterThan(2), (s: string) => s.length)
+ * // A function from `string` to `number`
+ * const stringLength = (s: string): number => s.length
  *
- * assert.deepStrictEqual(minLength3("a"), false)
- * assert.deepStrictEqual(minLength3("aa"), false)
- * assert.deepStrictEqual(minLength3("aaa"), true)
- * assert.deepStrictEqual(minLength3("aaaa"), true)
+ * // Create a new predicate on strings by mapping the input
+ * const hasPositiveLength = Predicate.mapInput(isPositive, stringLength)
+ *
+ * assert.strictEqual(hasPositiveLength("hello"), true)
+ * assert.strictEqual(hasPositiveLength(""), false)
  * ```
  *
  * @category combinators
@@ -30,23 +52,24 @@ var _Function = require("./Function.js");
  */
 const mapInput = exports.mapInput = /*#__PURE__*/(0, _Function.dual)(2, (self, f) => b => self(f(b)));
 /**
- * Determine if an `Array` is a tuple with exactly `N` elements, narrowing down the type to `TupleOf`.
- *
- * An `Array` is considered to be a `TupleOf` if its length is exactly `N`.
+ * A refinement that checks if a `ReadonlyArray<T>` is a tuple with exactly `N` elements.
+ * If the check is successful, the type is narrowed to `TupleOf<N, T>`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isTupleOf } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isTupleOf([1, 2, 3], 3), true);
- * assert.deepStrictEqual(isTupleOf([1, 2, 3], 2), false);
- * assert.deepStrictEqual(isTupleOf([1, 2, 3], 4), false);
+ * const isTupleOf3 = isTupleOf(3)
+ *
+ * assert.strictEqual(isTupleOf3([1, 2, 3]), true);
+ * assert.strictEqual(isTupleOf3([1, 2]), false);
  *
  * const arr: number[] = [1, 2, 3];
  * if (isTupleOf(arr, 3)) {
- *   console.log(arr);
- *   // ^? [number, number, number]
+ *   // The type of arr is now [number, number, number]
+ *   const [a, b, c] = arr;
+ *   assert.deepStrictEqual([a, b, c], [1, 2, 3])
  * }
  * ```
  *
@@ -55,23 +78,25 @@ const mapInput = exports.mapInput = /*#__PURE__*/(0, _Function.dual)(2, (self, f
  */
 const isTupleOf = exports.isTupleOf = /*#__PURE__*/(0, _Function.dual)(2, (self, n) => self.length === n);
 /**
- * Determine if an `Array` is a tuple with at least `N` elements, narrowing down the type to `TupleOfAtLeast`.
- *
- * An `Array` is considered to be a `TupleOfAtLeast` if its length is at least `N`.
+ * A refinement that checks if a `ReadonlyArray<T>` is a tuple with at least `N` elements.
+ * If the check is successful, the type is narrowed to `TupleOfAtLeast<N, T>`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isTupleOfAtLeast } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isTupleOfAtLeast([1, 2, 3], 3), true);
- * assert.deepStrictEqual(isTupleOfAtLeast([1, 2, 3], 2), true);
- * assert.deepStrictEqual(isTupleOfAtLeast([1, 2, 3], 4), false);
+ * const isTupleOfAtLeast3 = isTupleOfAtLeast(3)
+ *
+ * assert.strictEqual(isTupleOfAtLeast3([1, 2, 3]), true);
+ * assert.strictEqual(isTupleOfAtLeast3([1, 2, 3, 4]), true);
+ * assert.strictEqual(isTupleOfAtLeast3([1, 2]), false);
  *
  * const arr: number[] = [1, 2, 3, 4];
  * if (isTupleOfAtLeast(arr, 3)) {
- *   console.log(arr);
- *   // ^? [number, number, number, ...number[]]
+ *   // The type of arr is now [number, number, number, ...number[]]
+ *   const [a, b, c] = arr;
+ *   assert.deepStrictEqual([a, b, c], [1, 2, 3])
  * }
  * ```
  *
@@ -80,16 +105,22 @@ const isTupleOf = exports.isTupleOf = /*#__PURE__*/(0, _Function.dual)(2, (self,
  */
 const isTupleOfAtLeast = exports.isTupleOfAtLeast = /*#__PURE__*/(0, _Function.dual)(2, (self, n) => self.length >= n);
 /**
- * Tests if a value is `truthy`.
+ * A predicate that checks if a value is "truthy" in JavaScript.
+ * Fails for `false`, `0`, `-0`, `0n`, `""`, `null`, `undefined`, and `NaN`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isTruthy } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isTruthy(1), true)
- * assert.deepStrictEqual(isTruthy(0), false)
- * assert.deepStrictEqual(isTruthy(""), false)
+ * assert.strictEqual(isTruthy(1), true)
+ * assert.strictEqual(isTruthy("hello"), true)
+ * assert.strictEqual(isTruthy({}), true)
+ *
+ * assert.strictEqual(isTruthy(0), false)
+ * assert.strictEqual(isTruthy(""), false)
+ * assert.strictEqual(isTruthy(null), false)
+ * assert.strictEqual(isTruthy(undefined), false)
  * ```
  *
  * @category guards
@@ -97,18 +128,18 @@ const isTupleOfAtLeast = exports.isTupleOfAtLeast = /*#__PURE__*/(0, _Function.d
  */
 const isTruthy = input => !!input;
 /**
- * Tests if a value is a `Set`.
+ * A refinement that checks if a value is a `Set`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isSet } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isSet(new Set([1, 2])), true)
- * assert.deepStrictEqual(isSet(new Set()), true)
- * assert.deepStrictEqual(isSet({}), false)
- * assert.deepStrictEqual(isSet(null), false)
- * assert.deepStrictEqual(isSet(undefined), false)
+ * assert.strictEqual(isSet(new Set([1, 2])), true)
+ * assert.strictEqual(isSet(new Set()), true)
+ *
+ * assert.strictEqual(isSet({}), false)
+ * assert.strictEqual(isSet([1, 2]), false)
  * ```
  *
  * @category guards
@@ -117,17 +148,17 @@ const isTruthy = input => !!input;
 exports.isTruthy = isTruthy;
 const isSet = input => input instanceof Set;
 /**
- * Tests if a value is a `Map`.
+ * A refinement that checks if a value is a `Map`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isMap } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isMap(new Map()), true)
- * assert.deepStrictEqual(isMap({}), false)
- * assert.deepStrictEqual(isMap(null), false)
- * assert.deepStrictEqual(isMap(undefined), false)
+ * assert.strictEqual(isMap(new Map()), true)
+ *
+ * assert.strictEqual(isMap({}), false)
+ * assert.strictEqual(isMap(new Set()), false)
  * ```
  *
  * @category guards
@@ -136,16 +167,18 @@ const isSet = input => input instanceof Set;
 exports.isSet = isSet;
 const isMap = input => input instanceof Map;
 /**
- * Tests if a value is a `string`.
+ * A refinement that checks if a value is a `string`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isString } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isString("a"), true)
+ * assert.strictEqual(isString("hello"), true)
+ * assert.strictEqual(isString(""), true)
  *
- * assert.deepStrictEqual(isString(1), false)
+ * assert.strictEqual(isString(123), false)
+ * assert.strictEqual(isString(null), false)
  * ```
  *
  * @category guards
@@ -154,16 +187,20 @@ const isMap = input => input instanceof Map;
 exports.isMap = isMap;
 const isString = input => typeof input === "string";
 /**
- * Tests if a value is a `number`.
+ * A refinement that checks if a value is a `number`. Note that this
+ * check returns `false` for `NaN`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isNumber } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isNumber(2), true)
+ * assert.strictEqual(isNumber(123), true)
+ * assert.strictEqual(isNumber(0), true)
+ * assert.strictEqual(isNumber(-1.5), true)
  *
- * assert.deepStrictEqual(isNumber("2"), false)
+ * assert.strictEqual(isNumber("123"), false)
+ * assert.strictEqual(isNumber(NaN), false) // Special case: NaN is a number type but returns false
  * ```
  *
  * @category guards
@@ -172,16 +209,18 @@ const isString = input => typeof input === "string";
 exports.isString = isString;
 const isNumber = input => typeof input === "number";
 /**
- * Tests if a value is a `boolean`.
+ * A refinement that checks if a value is a `boolean`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isBoolean } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isBoolean(true), true)
+ * assert.strictEqual(isBoolean(true), true)
+ * assert.strictEqual(isBoolean(false), true)
  *
- * assert.deepStrictEqual(isBoolean("true"), false)
+ * assert.strictEqual(isBoolean("true"), false)
+ * assert.strictEqual(isBoolean(0), false)
  * ```
  *
  * @category guards
@@ -190,16 +229,17 @@ const isNumber = input => typeof input === "number";
 exports.isNumber = isNumber;
 const isBoolean = input => typeof input === "boolean";
 /**
- * Tests if a value is a `bigint`.
+ * A refinement that checks if a value is a `bigint`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isBigInt } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isBigInt(1n), true)
+ * assert.strictEqual(isBigInt(1n), true)
  *
- * assert.deepStrictEqual(isBigInt(1), false)
+ * assert.strictEqual(isBigInt(1), false)
+ * assert.strictEqual(isBigInt("1"), false)
  * ```
  *
  * @category guards
@@ -208,16 +248,16 @@ const isBoolean = input => typeof input === "boolean";
 exports.isBoolean = isBoolean;
 const isBigInt = input => typeof input === "bigint";
 /**
- * Tests if a value is a `symbol`.
+ * A refinement that checks if a value is a `symbol`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isSymbol } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isSymbol(Symbol.for("a")), true)
+ * assert.strictEqual(isSymbol(Symbol.for("a")), true)
  *
- * assert.deepStrictEqual(isSymbol("a"), false)
+ * assert.strictEqual(isSymbol("a"), false)
  * ```
  *
  * @category guards
@@ -226,20 +266,24 @@ const isBigInt = input => typeof input === "bigint";
 exports.isBigInt = isBigInt;
 const isSymbol = input => typeof input === "symbol";
 // TODO: make public
-/** @internal */
+/**
+ * A refinement that checks if a value is a valid `PropertyKey` (a `string`, `number`, or `symbol`).
+ * @internal
+ */
 exports.isSymbol = isSymbol;
 const isPropertyKey = u => isString(u) || isNumber(u) || isSymbol(u);
 /**
- * Tests if a value is a `function`.
+ * A refinement that checks if a value is a `Function`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isFunction } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isFunction(isFunction), true)
+ * assert.strictEqual(isFunction(() => {}), true)
+ * assert.strictEqual(isFunction(isFunction), true)
  *
- * assert.deepStrictEqual(isFunction("function"), false)
+ * assert.strictEqual(isFunction("function"), false)
  * ```
  *
  * @category guards
@@ -248,17 +292,17 @@ const isPropertyKey = u => isString(u) || isNumber(u) || isSymbol(u);
 exports.isPropertyKey = isPropertyKey;
 const isFunction = exports.isFunction = _Function.isFunction;
 /**
- * Tests if a value is `undefined`.
+ * A refinement that checks if a value is `undefined`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isUndefined } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isUndefined(undefined), true)
+ * assert.strictEqual(isUndefined(undefined), true)
  *
- * assert.deepStrictEqual(isUndefined(null), false)
- * assert.deepStrictEqual(isUndefined("undefined"), false)
+ * assert.strictEqual(isUndefined(null), false)
+ * assert.strictEqual(isUndefined("undefined"), false)
  * ```
  *
  * @category guards
@@ -266,17 +310,17 @@ const isFunction = exports.isFunction = _Function.isFunction;
  */
 const isUndefined = input => input === undefined;
 /**
- * Tests if a value is not `undefined`.
+ * A refinement that checks if a value is not `undefined`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isNotUndefined } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isNotUndefined(null), true)
- * assert.deepStrictEqual(isNotUndefined("undefined"), true)
+ * assert.strictEqual(isNotUndefined(null), true)
+ * assert.strictEqual(isNotUndefined("value"), true)
  *
- * assert.deepStrictEqual(isNotUndefined(undefined), false)
+ * assert.strictEqual(isNotUndefined(undefined), false)
  * ```
  *
  * @category guards
@@ -285,17 +329,17 @@ const isUndefined = input => input === undefined;
 exports.isUndefined = isUndefined;
 const isNotUndefined = input => input !== undefined;
 /**
- * Tests if a value is `null`.
+ * A refinement that checks if a value is `null`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isNull } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isNull(null), true)
+ * assert.strictEqual(isNull(null), true)
  *
- * assert.deepStrictEqual(isNull(undefined), false)
- * assert.deepStrictEqual(isNull("null"), false)
+ * assert.strictEqual(isNull(undefined), false)
+ * assert.strictEqual(isNull("null"), false)
  * ```
  *
  * @category guards
@@ -304,17 +348,17 @@ const isNotUndefined = input => input !== undefined;
 exports.isNotUndefined = isNotUndefined;
 const isNull = input => input === null;
 /**
- * Tests if a value is not `null`.
+ * A refinement that checks if a value is not `null`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isNotNull } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isNotNull(undefined), true)
- * assert.deepStrictEqual(isNotNull("null"), true)
+ * assert.strictEqual(isNotNull(undefined), true)
+ * assert.strictEqual(isNotNull("value"), true)
  *
- * assert.deepStrictEqual(isNotNull(null), false)
+ * assert.strictEqual(isNotNull(null), false)
  * ```
  *
  * @category guards
@@ -323,17 +367,16 @@ const isNull = input => input === null;
 exports.isNull = isNull;
 const isNotNull = input => input !== null;
 /**
- * A guard that always fails.
+ * A refinement that always returns `false`. The type is narrowed to `never`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isNever } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isNever(null), false)
- * assert.deepStrictEqual(isNever(undefined), false)
- * assert.deepStrictEqual(isNever({}), false)
- * assert.deepStrictEqual(isNever([]), false)
+ * assert.strictEqual(isNever(1), false)
+ * assert.strictEqual(isNever(null), false)
+ * assert.strictEqual(isNever({}), false)
  * ```
  *
  * @category guards
@@ -342,18 +385,16 @@ const isNotNull = input => input !== null;
 exports.isNotNull = isNotNull;
 const isNever = _ => false;
 /**
- * A guard that always succeeds.
+ * A refinement that always returns `true`. The type is narrowed to `unknown`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isUnknown } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isUnknown(null), true)
- * assert.deepStrictEqual(isUnknown(undefined), true)
- *
- * assert.deepStrictEqual(isUnknown({}), true)
- * assert.deepStrictEqual(isUnknown([]), true)
+ * assert.strictEqual(isUnknown(1), true)
+ * assert.strictEqual(isUnknown(null), true)
+ * assert.strictEqual(isUnknown({}), true)
  * ```
  *
  * @category guards
@@ -361,31 +402,53 @@ const isNever = _ => false;
  */
 exports.isNever = isNever;
 const isUnknown = _ => true;
-/** @internal */
+/**
+ * Checks if the input is an object or an array.
+ * @internal
+ */
 exports.isUnknown = isUnknown;
 const isRecordOrArray = input => typeof input === "object" && input !== null;
 /**
- * Tests if a value is an `object`.
+ * A refinement that checks if a value is an `object`. Note that in JavaScript,
+ * arrays and functions are also considered objects.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isObject } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isObject({}), true)
- * assert.deepStrictEqual(isObject([]), true)
+ * assert.strictEqual(isObject({}), true)
+ * assert.strictEqual(isObject([]), true)
+ * assert.strictEqual(isObject(() => {}), true)
  *
- * assert.deepStrictEqual(isObject(null), false)
- * assert.deepStrictEqual(isObject(undefined), false)
+ * assert.strictEqual(isObject(null), false)
+ * assert.strictEqual(isObject("hello"), false)
  * ```
  *
  * @category guards
  * @since 2.0.0
+ * @see isRecord to check for plain objects (excluding arrays and functions).
  */
 exports.isRecordOrArray = isRecordOrArray;
 const isObject = input => isRecordOrArray(input) || isFunction(input);
 /**
- * Checks whether a value is an `object` containing a specified property key.
+ * A refinement that checks if a value is an object-like value and has a specific property key.
+ *
+ * @example
+ * ```ts
+ * import * as assert from "node:assert"
+ * import { hasProperty } from "effect/Predicate"
+ *
+ * assert.strictEqual(hasProperty({ a: 1 }, "a"), true)
+ * assert.strictEqual(hasProperty({ a: 1 }, "b"), false)
+ *
+ * const value: unknown = { name: "Alice" };
+ * if (hasProperty(value, "name")) {
+ *   // The type of `value` is narrowed to `{ name: unknown }`
+ *   // and we can safely access `value.name`
+ *   console.log(value.name)
+ * }
+ * ```
  *
  * @category guards
  * @since 2.0.0
@@ -393,19 +456,29 @@ const isObject = input => isRecordOrArray(input) || isFunction(input);
 exports.isObject = isObject;
 const hasProperty = exports.hasProperty = /*#__PURE__*/(0, _Function.dual)(2, (self, property) => isObject(self) && property in self);
 /**
- * Tests if a value is an `object` with a property `_tag` that matches the given tag.
+ * A refinement that checks if a value is an object with a `_tag` property
+ * that matches the given tag. This is a powerful tool for working with
+ * discriminated union types.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isTagged } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isTagged(1, "a"), false)
- * assert.deepStrictEqual(isTagged(null, "a"), false)
- * assert.deepStrictEqual(isTagged({}, "a"), false)
- * assert.deepStrictEqual(isTagged({ a: "a" }, "a"), false)
- * assert.deepStrictEqual(isTagged({ _tag: "a" }, "a"), true)
- * assert.deepStrictEqual(isTagged("a")({ _tag: "a" }), true)
+ * type Shape = { _tag: "circle"; radius: number } | { _tag: "square"; side: number }
+ *
+ * const isCircle = isTagged("circle")
+ *
+ * const shape1: Shape = { _tag: "circle", radius: 10 }
+ * const shape2: Shape = { _tag: "square", side: 5 }
+ *
+ * assert.strictEqual(isCircle(shape1), true)
+ * assert.strictEqual(isCircle(shape2), false)
+ *
+ * if (isCircle(shape1)) {
+ *   // shape1 is now narrowed to { _tag: "circle"; radius: number }
+ *   assert.strictEqual(shape1.radius, 10)
+ * }
  * ```
  *
  * @category guards
@@ -413,56 +486,60 @@ const hasProperty = exports.hasProperty = /*#__PURE__*/(0, _Function.dual)(2, (s
  */
 const isTagged = exports.isTagged = /*#__PURE__*/(0, _Function.dual)(2, (self, tag) => hasProperty(self, "_tag") && self["_tag"] === tag);
 /**
- * A guard that succeeds when the input is `null` or `undefined`.
+ * A refinement that checks if a value is either `null` or `undefined`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isNullable } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isNullable(null), true)
- * assert.deepStrictEqual(isNullable(undefined), true)
+ * assert.strictEqual(isNullable(null), true)
+ * assert.strictEqual(isNullable(undefined), true)
  *
- * assert.deepStrictEqual(isNullable({}), false)
- * assert.deepStrictEqual(isNullable([]), false)
+ * assert.strictEqual(isNullable(0), false)
+ * assert.strictEqual(isNullable(""), false)
  * ```
  *
  * @category guards
  * @since 2.0.0
+ * @see isNotNullable
  */
 const isNullable = input => input === null || input === undefined;
 /**
- * A guard that succeeds when the input is not `null` or `undefined`.
+ * A refinement that checks if a value is neither `null` nor `undefined`.
+ * The type is narrowed to `NonNullable<A>`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isNotNullable } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isNotNullable({}), true)
- * assert.deepStrictEqual(isNotNullable([]), true)
+ * assert.strictEqual(isNotNullable(0), true)
+ * assert.strictEqual(isNotNullable("hello"), true)
  *
- * assert.deepStrictEqual(isNotNullable(null), false)
- * assert.deepStrictEqual(isNotNullable(undefined), false)
+ * assert.strictEqual(isNotNullable(null), false)
+ * assert.strictEqual(isNotNullable(undefined), false)
  * ```
  *
  * @category guards
  * @since 2.0.0
+ * @see isNullable
  */
 exports.isNullable = isNullable;
 const isNotNullable = input => input !== null && input !== undefined;
 /**
- * A guard that succeeds when the input is an `Error`.
+ * A refinement that checks if a value is an instance of `Error`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isError } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isError(new Error()), true)
+ * assert.strictEqual(isError(new Error("boom")), true)
+ * assert.strictEqual(isError(new TypeError("boom")), true)
  *
- * assert.deepStrictEqual(isError(null), false)
- * assert.deepStrictEqual(isError({}), false)
+ * assert.strictEqual(isError({ message: "boom" }), false)
+ * assert.strictEqual(isError("boom"), false)
  * ```
  *
  * @category guards
@@ -471,17 +548,17 @@ const isNotNullable = input => input !== null && input !== undefined;
 exports.isNotNullable = isNotNullable;
 const isError = input => input instanceof Error;
 /**
- * A guard that succeeds when the input is a `Uint8Array`.
+ * A refinement that checks if a value is a `Uint8Array`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isUint8Array } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isUint8Array(new Uint8Array()), true)
+ * assert.strictEqual(isUint8Array(new Uint8Array()), true)
  *
- * assert.deepStrictEqual(isUint8Array(null), false)
- * assert.deepStrictEqual(isUint8Array({}), false)
+ * assert.strictEqual(isUint8Array(new Uint16Array()), false)
+ * assert.strictEqual(isUint8Array([1, 2, 3]), false)
  * ```
  *
  * @category guards
@@ -490,17 +567,17 @@ const isError = input => input instanceof Error;
 exports.isError = isError;
 const isUint8Array = input => input instanceof Uint8Array;
 /**
- * A guard that succeeds when the input is a `Date`.
+ * A refinement that checks if a value is a `Date` object.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isDate } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isDate(new Date()), true)
+ * assert.strictEqual(isDate(new Date()), true)
  *
- * assert.deepStrictEqual(isDate(null), false)
- * assert.deepStrictEqual(isDate({}), false)
+ * assert.strictEqual(isDate(Date.now()), false) // `Date.now()` returns a number
+ * assert.strictEqual(isDate("2023-01-01"), false)
  * ```
  *
  * @category guards
@@ -509,18 +586,20 @@ const isUint8Array = input => input instanceof Uint8Array;
 exports.isUint8Array = isUint8Array;
 const isDate = input => input instanceof Date;
 /**
- * A guard that succeeds when the input is an `Iterable`.
+ * A refinement that checks if a value is an `Iterable`.
+ * Many built-in types are iterable, such as `Array`, `string`, `Map`, and `Set`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isIterable } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isIterable([]), true)
- * assert.deepStrictEqual(isIterable(new Set()), true)
+ * assert.strictEqual(isIterable([]), true)
+ * assert.strictEqual(isIterable("hello"), true)
+ * assert.strictEqual(isIterable(new Set()), true)
  *
- * assert.deepStrictEqual(isIterable(null), false)
- * assert.deepStrictEqual(isIterable({}), false)
+ * assert.strictEqual(isIterable({}), false)
+ * assert.strictEqual(isIterable(123), false)
  * ```
  *
  * @category guards
@@ -529,43 +608,45 @@ const isDate = input => input instanceof Date;
 exports.isDate = isDate;
 const isIterable = input => hasProperty(input, Symbol.iterator);
 /**
- * A guard that succeeds when the input is a record.
+ * A refinement that checks if a value is a record (i.e., a plain object).
+ * This check returns `false` for arrays, `null`, and functions.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isRecord } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isRecord({}), true)
- * assert.deepStrictEqual(isRecord({ a: 1 }), true)
+ * assert.strictEqual(isRecord({}), true)
+ * assert.strictEqual(isRecord({ a: 1 }), true)
  *
- * assert.deepStrictEqual(isRecord([]), false)
- * assert.deepStrictEqual(isRecord([1, 2, 3]), false)
- * assert.deepStrictEqual(isRecord(null), false)
- * assert.deepStrictEqual(isRecord(undefined), false)
- * assert.deepStrictEqual(isRecord(() => null), false)
+ * assert.strictEqual(isRecord([]), false)
+ * assert.strictEqual(isRecord(new Date()), false)
+ * assert.strictEqual(isRecord(null), false)
+ * assert.strictEqual(isRecord(() => null), false)
  * ```
  *
  * @category guards
  * @since 2.0.0
+ * @see isObject
  */
 exports.isIterable = isIterable;
 const isRecord = input => isRecordOrArray(input) && !Array.isArray(input);
 /**
- * A guard that succeeds when the input is a readonly record.
+ * A refinement that checks if a value is a readonly record (i.e., a plain object).
+ * This check returns `false` for arrays, `null`, and functions.
+ *
+ * This is an alias for `isRecord`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isReadonlyRecord } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isReadonlyRecord({}), true)
- * assert.deepStrictEqual(isReadonlyRecord({ a: 1 }), true)
+ * assert.strictEqual(isReadonlyRecord({}), true)
+ * assert.strictEqual(isReadonlyRecord({ a: 1 }), true)
  *
- * assert.deepStrictEqual(isReadonlyRecord([]), false)
- * assert.deepStrictEqual(isReadonlyRecord([1, 2, 3]), false)
- * assert.deepStrictEqual(isReadonlyRecord(null), false)
- * assert.deepStrictEqual(isReadonlyRecord(undefined), false)
+ * assert.strictEqual(isReadonlyRecord([]), false)
+ * assert.strictEqual(isReadonlyRecord(null), false)
  * ```
  *
  * @category guards
@@ -574,37 +655,59 @@ const isRecord = input => isRecordOrArray(input) && !Array.isArray(input);
 exports.isRecord = isRecord;
 const isReadonlyRecord = exports.isReadonlyRecord = isRecord;
 /**
- * A guard that succeeds when the input is a Promise.
+ * A refinement that checks if a value is a `Promise`. It performs a duck-typing check
+ * for `.then` and `.catch` methods.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { isPromise } from "effect/Predicate"
  *
- * assert.deepStrictEqual(isPromise({}), false)
- * assert.deepStrictEqual(isPromise(Promise.resolve("hello")), true)
+ * assert.strictEqual(isPromise(Promise.resolve(1)), true)
+ * assert.strictEqual(isPromise(new Promise(() => {})), true)
+ *
+ * assert.strictEqual(isPromise({ then() {} }), false) // Missing .catch
+ * assert.strictEqual(isPromise({}), false)
  * ```
  *
  * @category guards
  * @since 2.0.0
+ * @see isPromiseLike
  */
 const isPromise = input => hasProperty(input, "then") && "catch" in input && isFunction(input.then) && isFunction(input.catch);
 /**
+ * A refinement that checks if a value is `PromiseLike`. It performs a duck-typing
+ * check for a `.then` method.
+ *
+ * @example
+ * ```ts
+ * import * as assert from "node:assert"
+ * import { isPromiseLike } from "effect/Predicate"
+ *
+ * assert.strictEqual(isPromiseLike(Promise.resolve(1)), true)
+ * assert.strictEqual(isPromiseLike({ then: () => {} }), true)
+ *
+ * assert.strictEqual(isPromiseLike({}), false)
+ * ```
+ *
  * @category guards
  * @since 2.0.0
+ * @see isPromise
  */
 exports.isPromise = isPromise;
 const isPromiseLike = input => hasProperty(input, "then") && isFunction(input.then);
 /**
- * Tests if a value is a `RegExp`.
+ * A refinement that checks if a value is a `RegExp`.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { Predicate } from "effect"
  *
- * assert.deepStrictEqual(Predicate.isRegExp(/a/), true)
- * assert.deepStrictEqual(Predicate.isRegExp("a"), false)
+ * assert.strictEqual(Predicate.isRegExp(/a/), true)
+ * assert.strictEqual(Predicate.isRegExp(new RegExp("a")), true)
+ *
+ * assert.strictEqual(Predicate.isRegExp("/a/"), false)
  * ```
  *
  * @category guards
@@ -613,18 +716,54 @@ const isPromiseLike = input => hasProperty(input, "then") && isFunction(input.th
 exports.isPromiseLike = isPromiseLike;
 const isRegExp = input => input instanceof RegExp;
 /**
+ * Composes a `Refinement` with another `Refinement` or `Predicate`.
+ *
+ * This can be used to chain checks. The first refinement is applied, and if it
+ * passes, the second check is applied to the same value, potentially refining
+ * the type further.
+ *
+ * @example
+ * ```ts
+ * import { Predicate } from "effect"
+ * import * as assert from "node:assert"
+ *
+ * const isString = (u: unknown): u is string => typeof u === "string"
+ * const minLength = (n: number) => (s: string): boolean => s.length >= n
+ *
+ * // Create a refinement that checks for a string with a minimum length of 3
+ * const isLongString = Predicate.compose(isString, minLength(3))
+ *
+ * let value: unknown = "hello"
+ *
+ * assert.strictEqual(isLongString(value), true)
+ * if (isLongString(value)) {
+ *   // value is narrowed to string
+ *   assert.strictEqual(value.toUpperCase(), "HELLO")
+ * }
+ * assert.strictEqual(isLongString("hi"), false)
+ * ```
+ *
  * @since 2.0.0
  */
 exports.isRegExp = isRegExp;
 const compose = exports.compose = /*#__PURE__*/(0, _Function.dual)(2, (ab, bc) => a => ab(a) && bc(a));
 /**
+ * Combines two predicates to test a tuple of two values. The first predicate tests the
+ * first element of the tuple, and the second predicate tests the second element.
+ *
  * @category combining
  * @since 2.0.0
  */
 const product = (self, that) => ([a, b]) => self(a) && that(b);
 /**
+ * Takes an iterable of predicates and returns a new predicate that tests an array of values.
+ * The new predicate returns `true` if each predicate at a given index is satisfied by the
+ * value at the same index in the array. The check stops at the length of the shorter of
+ * the two iterables (predicates or values).
+ *
  * @category combining
  * @since 2.0.0
+ * @see tuple for a more powerful, variadic version.
  */
 exports.product = product;
 const all = collection => {
@@ -643,6 +782,9 @@ const all = collection => {
   };
 };
 /**
+ * Combines a predicate for a single value and an iterable of predicates for the rest of an array.
+ * Useful for checking the head and tail of an array separately.
+ *
  * @category combining
  * @since 2.0.0
  */
@@ -652,12 +794,33 @@ const productMany = (self, collection) => {
   return ([head, ...tail]) => self(head) === false ? false : rest(tail);
 };
 /**
- * Similar to `Promise.all` but operates on `Predicate`s.
+ * Combines an array of predicates into a single predicate that tests an array of values.
+ * This function is highly type-aware and will produce a `Refinement` if any of the provided
+ * predicates are `Refinement`s, allowing for powerful type-narrowing of tuples.
+ *
+ * - If all predicates are `Predicate<T>`, the result is `Predicate<[T, T, ...]>`.
+ * - If any predicate is a `Refinement<A, B>`, the result is a `Refinement` that narrows
+ *   the input tuple type to a more specific tuple type.
  *
- * ```ts skip-type-checking
- * [Refinement<A, B>, Refinement<C, D>, ...] -> Refinement<[A, C, ...], [B, D, ...]>
- * [Predicate<A>, Predicate<B>, ...] -> Predicate<[A, B, ...]>
- * [Refinement<A, B>, Predicate<C>, ...] -> Refinement<[A, C, ...], [B, C, ...]>
+ * @example
+ * ```ts
+ * import * as assert from "node:assert"
+ * import { Predicate } from "effect"
+ *
+ * const isString = (u: unknown): u is string => typeof u === "string"
+ * const isNumber = (u: unknown): u is number => typeof u === "number"
+ *
+ * // Create a refinement for a [string, number] tuple
+ * const isStringNumberTuple = Predicate.tuple(isString, isNumber)
+ *
+ * const value: [unknown, unknown] = ["hello", 123]
+ * if (isStringNumberTuple(value)) {
+ *   // value is narrowed to [string, number]
+ *   const [s, n] = value
+ *   assert.strictEqual(s.toUpperCase(), "HELLO")
+ *   assert.strictEqual(n.toFixed(2), "123.00")
+ * }
+ * assert.strictEqual(isStringNumberTuple(["hello", "123"]), false)
  * ```
  *
  * @since 2.0.0
@@ -665,10 +828,34 @@ const productMany = (self, collection) => {
 exports.productMany = productMany;
 const tuple = (...elements) => all(elements);
 /**
- * ```ts skip-type-checking
- * { ab: Refinement<A, B>; cd: Refinement<C, D>, ... } -> Refinement<{ ab: A; cd: C; ... }, { ab: B; cd: D; ... }>
- * { a: Predicate<A, B>; b: Predicate<B>, ... } -> Predicate<{ a: A; b: B; ... }>
- * { ab: Refinement<A, B>; c: Predicate<C>, ... } -> Refinement<{ ab: A; c: C; ... }, { ab: B; c: С; ... }>
+ * Combines a record of predicates into a single predicate that tests a record of values.
+ * This function is highly type-aware and will produce a `Refinement` if any of the provided
+ * predicates are `Refinement`s, allowing for powerful type-narrowing of structs.
+ *
+ * - If all predicates are `Predicate<T>`, the result is `Predicate<{ k: T, ... }>`.
+ * - If any predicate is a `Refinement<A, B>`, the result is a `Refinement` that narrows
+ *   the input record type to a more specific record type.
+ *
+ * @example
+ * ```ts
+ * import * as assert from "node:assert"
+ * import { Predicate } from "effect"
+ *
+ * const isString = (u: unknown): u is string => typeof u === "string"
+ * const isNumber = (u: unknown): u is number => typeof u === "number"
+ *
+ * const personPredicate = Predicate.struct({
+ *   name: isString,
+ *   age: isNumber
+ * })
+ *
+ * const value: { name: unknown; age: unknown } = { name: "Alice", age: 30 }
+ * if (personPredicate(value)) {
+ *   // value is narrowed to { name: string; age: number }
+ *   assert.strictEqual(value.name.toUpperCase(), "ALICE")
+ *   assert.strictEqual(value.age.toFixed(0), "30")
+ * }
+ * assert.strictEqual(personPredicate({ name: "Bob", age: "40" }), false)
  * ```
  *
  * @since 2.0.0
@@ -686,18 +873,21 @@ const struct = fields => {
   };
 };
 /**
- * Negates the result of a given predicate.
+ * Returns a new predicate that is the logical negation of the given predicate.
+ *
+ * **Note**: If the input is a `Refinement`, the resulting predicate will be a
+ * simple `Predicate`, as TypeScript cannot infer the negative type.
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { Predicate, Number } from "effect"
  *
- * const isPositive = Predicate.not(Number.lessThan(0))
+ * const isNonPositive = Predicate.not(Number.greaterThan(0))
  *
- * assert.deepStrictEqual(isPositive(-1), false)
- * assert.deepStrictEqual(isPositive(0), true)
- * assert.deepStrictEqual(isPositive(1), true)
+ * assert.strictEqual(isNonPositive(-1), true)
+ * assert.strictEqual(isNonPositive(0), true)
+ * assert.strictEqual(isNonPositive(1), false)
  * ```
  *
  * @category combinators
@@ -706,18 +896,31 @@ const struct = fields => {
 exports.struct = struct;
 const not = self => a => !self(a);
 /**
- * Combines two predicates into a new predicate that returns `true` if at least one of the predicates returns `true`.
+ * Combines two predicates with a logical "OR". The resulting predicate returns `true`
+ * if at least one of the predicates returns `true`.
+ *
+ * If both predicates are `Refinement`s, the resulting predicate is a `Refinement` to the
+ * union of their target types (`B | C`).
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
- * import { Predicate, Number } from "effect"
+ * import { Predicate } from "effect"
+ *
+ * const isString = (u: unknown): u is string => typeof u === "string"
+ * const isNumber = (u: unknown): u is number => typeof u === "number"
+ *
+ * const isStringOrNumber = Predicate.or(isString, isNumber)
  *
- * const nonZero = Predicate.or(Number.lessThan(0), Number.greaterThan(0))
+ * assert.strictEqual(isStringOrNumber("hello"), true)
+ * assert.strictEqual(isStringOrNumber(123), true)
+ * assert.strictEqual(isStringOrNumber(null), false)
  *
- * assert.deepStrictEqual(nonZero(-1), true)
- * assert.deepStrictEqual(nonZero(0), false)
- * assert.deepStrictEqual(nonZero(1), true)
+ * const value: unknown = "world"
+ * if (isStringOrNumber(value)) {
+ *   // value is narrowed to string | number
+ *   console.log(value)
+ * }
  * ```
  *
  * @category combinators
@@ -726,21 +929,34 @@ const not = self => a => !self(a);
 exports.not = not;
 const or = exports.or = /*#__PURE__*/(0, _Function.dual)(2, (self, that) => a => self(a) || that(a));
 /**
- * Combines two predicates into a new predicate that returns `true` if both of the predicates returns `true`.
+ * Combines two predicates with a logical "AND". The resulting predicate returns `true`
+ * only if both of the predicates return `true`.
+ *
+ * If both predicates are `Refinement`s, the resulting predicate is a `Refinement` to the
+ * intersection of their target types (`B & C`).
  *
  * @example
  * ```ts
  * import * as assert from "node:assert"
  * import { Predicate } from "effect"
  *
- * const minLength = (n: number) => (s: string) => s.length >= n
- * const maxLength = (n: number) => (s: string) => s.length <= n
+ * type Person = { name: string }
+ * type Employee = { id: number }
  *
- * const length = (n: number) => Predicate.and(minLength(n), maxLength(n))
+ * const hasName = (u: unknown): u is Person => Predicate.hasProperty(u, "name") && typeof (u as any).name === "string"
+ * const hasId = (u: unknown): u is Employee => Predicate.hasProperty(u, "id") && typeof (u as any).id === "number"
  *
- * assert.deepStrictEqual(length(2)("aa"), true)
- * assert.deepStrictEqual(length(2)("a"), false)
- * assert.deepStrictEqual(length(2)("aaa"), false)
+ * const isPersonAndEmployee = Predicate.and(hasName, hasId)
+ *
+ * const val: unknown = { name: "Alice", id: 123 }
+ * if (isPersonAndEmployee(val)) {
+ *   // val is narrowed to Person & Employee
+ *   assert.strictEqual(val.name, "Alice")
+ *   assert.strictEqual(val.id, 123)
+ * }
+ *
+ * assert.strictEqual(isPersonAndEmployee({ name: "Bob" }), false) // Missing id
+ * assert.strictEqual(isPersonAndEmployee({ id: 456 }), false) // Missing name
  * ```
  *
  * @category combinators
@@ -748,57 +964,107 @@ const or = exports.or = /*#__PURE__*/(0, _Function.dual)(2, (self, that) => a =>
  */
 const and = exports.and = /*#__PURE__*/(0, _Function.dual)(2, (self, that) => a => self(a) && that(a));
 /**
+ * Combines two predicates with a logical "XOR" (exclusive OR). The resulting predicate
+ * returns `true` if one of the predicates returns `true`, but not both.
+ *
+ * @example
+ * ```ts
+ * import * as assert from "node:assert"
+ * import { Predicate } from "effect"
+ *
+ * const isPositive = (n: number) => n > 0
+ * const isEven = (n: number) => n % 2 === 0
+ *
+ * const isPositiveXorEven = Predicate.xor(isPositive, isEven)
+ *
+ * assert.strictEqual(isPositiveXorEven(4), false)  // both true -> false
+ * assert.strictEqual(isPositiveXorEven(3), true)   // one true -> true
+ * assert.strictEqual(isPositiveXorEven(-2), true)  // one true -> true
+ * assert.strictEqual(isPositiveXorEven(-1), false) // both false -> false
+ * ```
+ *
  * @category combinators
  * @since 2.0.0
  */
 const xor = exports.xor = /*#__PURE__*/(0, _Function.dual)(2, (self, that) => a => self(a) !== that(a));
 /**
+ * Combines two predicates with a logical "EQV" (equivalence). The resulting predicate
+ * returns `true` if both predicates return the same boolean value (both `true` or both `false`).
+ *
+ * @example
+ * ```ts
+ * import * as assert from "node:assert"
+ * import { Predicate } from "effect"
+ *
+ * const isPositive = (n: number) => n > 0
+ * const isEven = (n: number) => n % 2 === 0
+ *
+ * const isPositiveEqvEven = Predicate.eqv(isPositive, isEven)
+ *
+ * assert.strictEqual(isPositiveEqvEven(4), true)   // both true -> true
+ * assert.strictEqual(isPositiveEqvEven(3), false)  // different -> false
+ * assert.strictEqual(isPositiveEqvEven(-2), false) // different -> false
+ * assert.strictEqual(isPositiveEqvEven(-1), true)  // both false -> true
+ * ```
+ *
  * @category combinators
  * @since 2.0.0
  */
 const eqv = exports.eqv = /*#__PURE__*/(0, _Function.dual)(2, (self, that) => a => self(a) === that(a));
 /**
- * Represents the logical implication combinator for predicates. In formal
- * logic, the implication operator `->` denotes that if the first proposition
- * (antecedent) is true, then the second proposition (consequent) must also be
- * true. In simpler terms, `p implies q` can be interpreted as "if p then q". If
- * the first predicate holds, then the second predicate must hold
- * for the given context.
+ * Creates a predicate that represents a logical "if-then" rule.
+ *
+ * Think of it as a conditional promise: **"If `antecedent` holds true, then I promise `consequent` will also be true."**
  *
- * In practical terms within TypeScript, `p implies q` is equivalent to `!p || (p && q)`.
+ * This function is invaluable for defining complex validation logic where one condition dictates another.
  *
- * Note that if the antecedent is `false`, the result is `true` by default
- * because the outcome of the consequent cannot be determined.
+ * ### How It Works
  *
- * This function is useful in situations where you need to enforce rules or
- * constraints that are contingent on certain conditions.
- * It proves especially helpful in defining property tests.
+ * The rule only fails (returns `false`) when the "if" part is `true`, but the "then" part is `false`.
+ * In all other cases, the promise is considered kept, and the result is `true`.
  *
- * The example below illustrates the transitive property of order using the
- * `implies` function. In simple terms, if `a <= b` and `b <= c`, then `a <= c`
- * must be true.
+ * This includes the concept of **"vacuous truth"**: if the "if" part is `false`, the rule doesn't apply,
+ * so the promise isn't broken, and the result is `true`. (e.g., "If it rains, I'll bring an umbrella."
+ * If it doesn't rain, you haven't broken your promise, no matter what).
+ *
+ * ### Key Details
+ *
+ * - **Logical Equivalence**: `implies(p, q)` is the same as `not(p).or(q)`, or simply `!p || q`
+ *   in plain JavaScript. This can be a helpful way to reason about its behavior.
+ *
+ * - **Type-Safety Warning**: This function always returns a `Predicate`, never a type-narrowing
+ *   `Refinement`. A `true` result doesn't guarantee the `consequent` passed (it could be `true`
+ *   simply because the `antecedent` was `false`), so it cannot be used to safely narrow a type.
  *
  * @example
  * ```ts
+ * // Rule: A user can only be an admin if they also belong to the "staff" group.
  * import * as assert from "node:assert"
  * import { Predicate } from "effect"
  *
- * type Triple = {
- *   readonly a: number
- *   readonly b: number
- *   readonly c: number
+ * type User = {
+ *   isStaff: boolean
+ *   isAdmin: boolean
  * }
  *
- * const transitivity = Predicate.implies(
- *   // antecedent
- *   (input: Triple) => input.a <= input.b && input.b <= input.c,
- *   // consequent
- *   (input: Triple) => input.a <= input.c
+ * const isValidUserPermission = Predicate.implies(
+ *   // antecedent: "if" the user is an admin...
+ *   (user: User) => user.isAdmin,
+ *   // consequent: "then" they must be staff.
+ *   (user: User) => user.isStaff
  * )
  *
- * assert.equal(transitivity({ a: 1, b: 2, c: 3 }), true)
- * // antecedent is `false`, so the result is `true`
- * assert.equal(transitivity({ a: 1, b: 0, c: 0 }), true)
+ * // A non-admin who is not staff. Rule doesn't apply (antecedent is false).
+ * assert.strictEqual(isValidUserPermission({ isStaff: false, isAdmin: false }), true)
+ *
+ * // A staff member who is not an admin. Rule doesn't apply (antecedent is false).
+ * assert.strictEqual(isValidUserPermission({ isStaff: true, isAdmin: false }), true)
+ *
+ * // An admin who is also staff. The rule was followed.
+ * assert.strictEqual(isValidUserPermission({ isStaff: true, isAdmin: true }), true)
+ *
+ * // An admin who is NOT staff. The rule was broken!
+ * assert.strictEqual(isValidUserPermission({ isStaff: false, isAdmin: true }), false)
  * ```
  *
  * @category combinators
@@ -806,18 +1072,47 @@ const eqv = exports.eqv = /*#__PURE__*/(0, _Function.dual)(2, (self, that) => a
  */
 const implies = exports.implies = /*#__PURE__*/(0, _Function.dual)(2, (antecedent, consequent) => a => antecedent(a) ? consequent(a) : true);
 /**
+ * Combines two predicates with a logical "NOR" (negated OR). The resulting predicate
+ * returns `true` only if both predicates return `false`.
+ * This is equivalent to `not(or(p, q))`.
+ *
  * @category combinators
  * @since 2.0.0
  */
 const nor = exports.nor = /*#__PURE__*/(0, _Function.dual)(2, (self, that) => a => !(self(a) || that(a)));
 /**
+ * Combines two predicates with a logical "NAND" (negated AND). The resulting predicate
+ * returns `true` if at least one of the predicates returns `false`.
+ * This is equivalent to `not(and(p, q))`.
+ *
  * @category combinators
  * @since 2.0.0
  */
 const nand = exports.nand = /*#__PURE__*/(0, _Function.dual)(2, (self, that) => a => !(self(a) && that(a)));
 /**
+ * Takes an iterable of predicates and returns a new predicate. The new predicate
+ * returns `true` if all predicates in the collection return `true` for a given value.
+ *
+ * This is like `Array.prototype.every` but for a collection of predicates.
+ *
+ * @example
+ * ```ts
+ * import * as assert from "node:assert"
+ * import { Predicate } from "effect"
+ *
+ * const isPositive = (n: number) => n > 0
+ * const isEven = (n: number) => n % 2 === 0
+ *
+ * const isPositiveAndEven = Predicate.every([isPositive, isEven])
+ *
+ * assert.strictEqual(isPositiveAndEven(4), true)
+ * assert.strictEqual(isPositiveAndEven(3), false)
+ * assert.strictEqual(isPositiveAndEven(-2), false)
+ * ```
+ *
  * @category elements
  * @since 2.0.0
+ * @see some
  */
 const every = collection => a => {
   for (const p of collection) {
@@ -828,8 +1123,29 @@ const every = collection => a => {
   return true;
 };
 /**
+ * Takes an iterable of predicates and returns a new predicate. The new predicate
+ * returns `true` if at least one predicate in the collection returns `true` for a given value.
+ *
+ * This is like `Array.prototype.some` but for a collection of predicates.
+ *
+ * @example
+ * ```ts
+ * import * as assert from "node:assert"
+ * import { Predicate } from "effect"
+ *
+ * const isNegative = (n: number) => n < 0
+ * const isOdd = (n: number) => n % 2 !== 0
+ *
+ * const isNegativeOrOdd = Predicate.some([isNegative, isOdd])
+ *
+ * assert.strictEqual(isNegativeOrOdd(-2), true) // isNegative is true
+ * assert.strictEqual(isNegativeOrOdd(3), true)  // isOdd is true
+ * assert.strictEqual(isNegativeOrOdd(4), false) // both are false
+ * ```
+ *
  * @category elements
  * @since 2.0.0
+ * @see every
  */
 exports.every = every;
 const some = collection => a => {