effect 4.0.0-beta.71 → 4.0.0-beta.73

package/src/Predicate.ts

@@ -79,7 +79,6 @@ import type { TupleOf, TupleOfAtLeast } from "./Types.ts"
  *
  * **Details**
  *
- * - Pure function; does not mutate input.
  * - Returns `true` or `false`; never throws by itself.
  * - Does not narrow types unless you use {@link Refinement}.
  *
@@ -144,7 +143,6 @@ export interface PredicateTypeLambda extends TypeLambda {
  *
  * **Details**
  *
- * - Pure function; does not mutate input.
  * - Returns a type predicate (`a is B`).
  * - Use with `if`/`filter` to narrow types.
  *
@@ -374,7 +372,6 @@ export declare namespace Refinement {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns a new predicate that applies `f` before `self`.
  * - No short-circuit beyond what `self` does.
  *
@@ -407,7 +404,6 @@ export const mapInput: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns a new predicate that applies `f` before `self`.
    * - No short-circuit beyond what `self` does.
    *
@@ -440,7 +436,6 @@ export const mapInput: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns a new predicate that applies `f` before `self`.
    * - No short-circuit beyond what `self` does.
    *
@@ -475,7 +470,6 @@ export const mapInput: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Only checks length, not element types.
  * - Returns a refinement on the array type.
  *
@@ -505,7 +499,6 @@ export const isTupleOf: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Only checks length, not element types.
    * - Returns a refinement on the array type.
    *
@@ -535,7 +528,6 @@ export const isTupleOf: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Only checks length, not element types.
    * - Returns a refinement on the array type.
    *
@@ -567,7 +559,6 @@ export const isTupleOf: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Only checks length, not element types.
  * - Returns a refinement on the array type.
  *
@@ -597,7 +588,6 @@ export const isTupleOfAtLeast: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Only checks length, not element types.
    * - Returns a refinement on the array type.
    *
@@ -627,7 +617,6 @@ export const isTupleOfAtLeast: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Only checks length, not element types.
    * - Returns a refinement on the array type.
    *
@@ -659,7 +648,6 @@ export const isTupleOfAtLeast: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `!!input` under the hood.
  * - Treats `0`, "", `false`, `null`, and `undefined` as false.
  *
@@ -692,7 +680,6 @@ export function isTruthy(input: unknown): boolean {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof Set`.
  *
  * **Example** (Guard a Set)
@@ -725,7 +712,6 @@ export function isSet(input: unknown): input is Set<unknown> {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof Map`.
  *
  * **Example** (Guard a Map)
@@ -759,7 +745,6 @@ export function isMap(input: unknown): input is Map<unknown, unknown> {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "string"`.
  *
  * **Example** (Guard string)
@@ -793,7 +778,6 @@ export function isString(input: unknown): input is string {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "number"`.
  * - Does not exclude `NaN` or `Infinity`.
  *
@@ -827,7 +811,6 @@ export function isNumber(input: unknown): input is number {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "boolean"`.
  *
  * **Example** (Guard boolean)
@@ -860,7 +843,6 @@ export function isBoolean(input: unknown): input is boolean {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "bigint"`.
  *
  * **Example** (Guard bigint)
@@ -892,7 +874,6 @@ export function isBigInt(input: unknown): input is bigint {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "symbol"`.
  *
  * **Example** (Guard symbol)
@@ -924,7 +905,6 @@ export function isSymbol(input: unknown): input is symbol {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses {@link isString}, {@link isNumber}, and {@link isSymbol}.
  *
  * **Example** (Guard property key)
@@ -959,7 +939,6 @@ export function isPropertyKey(u: unknown): u is PropertyKey {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "function"`.
  *
  * **Example** (Guard function)
@@ -991,7 +970,6 @@ export function isFunction(input: unknown): input is Function {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `input === undefined`.
  *
  * **Example** (Guard undefined)
@@ -1022,7 +1000,6 @@ export function isUndefined(input: unknown): input is undefined {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns a refinement that excludes `undefined`.
  *
  * **Example** (Filter undefined)
@@ -1054,7 +1031,6 @@ export function isNotUndefined<A>(input: A): input is Exclude<A, undefined> {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `input === null`.
  *
  * **Example** (Guard null)
@@ -1085,7 +1061,6 @@ export function isNull(input: unknown): input is null {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns a refinement that excludes `null`.
  *
  * **Example** (Filter null)
@@ -1117,7 +1092,6 @@ export function isNotNull<A>(input: A): input is Exclude<A, null> {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `input === null || input === undefined`.
  *
  * **Example** (Guard nullish)
@@ -1150,7 +1124,6 @@ export function isNullish<A>(input: A): input is A & (null | undefined) {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `input != null`.
  *
  * **Example** (Filter non-nullish)
@@ -1175,7 +1148,7 @@ export function isNotNullish<A>(input: A): input is NonNullable<A> {
 }
 
 /**
- * A guard that always returns `false`.
+ * Type guard that always returns `false`.
  *
  * **When to use**
  *
@@ -1183,7 +1156,6 @@ export function isNotNullish<A>(input: A): input is NonNullable<A> {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Always returns `false`.
  *
  * **Example** (Never matches)
@@ -1203,7 +1175,7 @@ export function isNever(_: unknown): _ is never {
 }
 
 /**
- * A guard that always returns `true`.
+ * Type guard that always returns `true`.
  *
  * **When to use**
  *
@@ -1211,7 +1183,6 @@ export function isNever(_: unknown): _ is never {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Always returns `true`.
  *
  * **Example** (Always matches)
@@ -1239,7 +1210,6 @@ export function isUnknown(_: unknown): _ is unknown {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `typeof input === "object" && input !== null`.
  * - Includes arrays.
  *
@@ -1333,7 +1303,6 @@ export function isReadonlyObject(input: unknown): input is { readonly [x: Proper
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns `true` for arrays and functions, `false` for `null`.
  *
  * **Example** (Object keyword)
@@ -1364,7 +1333,6 @@ export function isObjectKeyword(input: unknown): input is object {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses the `in` operator and {@link isObjectKeyword}.
  * - Does not check property value types.
  *
@@ -1397,7 +1365,6 @@ export const hasProperty: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Uses the `in` operator and {@link isObjectKeyword}.
    * - Does not check property value types.
    *
@@ -1430,7 +1397,6 @@ export const hasProperty: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Uses the `in` operator and {@link isObjectKeyword}.
    * - Does not check property value types.
    *
@@ -1469,7 +1435,6 @@ export const hasProperty: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses {@link hasProperty} and strict equality on `_tag`.
  *
  * **Example** (Guard tagged)
@@ -1497,7 +1462,6 @@ export const isTagged: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Uses {@link hasProperty} and strict equality on `_tag`.
    *
    * **Example** (Guard tagged)
@@ -1525,7 +1489,6 @@ export const isTagged: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Uses {@link hasProperty} and strict equality on `_tag`.
    *
    * **Example** (Guard tagged)
@@ -1557,7 +1520,6 @@ export const isTagged: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof Error`.
  *
  * **Example** (Guard error)
@@ -1587,7 +1549,6 @@ export function isError(input: unknown): input is Error {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof Uint8Array`.
  *
  * **Example** (Guard Uint8Array)
@@ -1618,7 +1579,6 @@ export function isUint8Array(input: unknown): input is Uint8Array {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof Date`.
  *
  * **Example** (Guard Date)
@@ -1648,7 +1608,6 @@ export function isDate(input: unknown): input is Date {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Accepts strings as iterable.
  * - Uses {@link hasProperty} for `Symbol.iterator`.
  *
@@ -1680,7 +1639,6 @@ export function isIterable(input: unknown): input is Iterable<unknown> {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Structural check for `then` and `catch` functions.
  *
  * **Example** (Guard promise)
@@ -1710,7 +1668,6 @@ export function isPromise(input: unknown): input is Promise<unknown> {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Structural check for a callable `then`.
  *
  * **Example** (Guard promise-like)
@@ -1740,7 +1697,6 @@ export function isPromiseLike(input: unknown): input is PromiseLike<unknown> {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Uses `instanceof RegExp`.
  *
  * **Example** (Guard RegExp)
@@ -1771,7 +1727,6 @@ export function isRegExp(input: unknown): input is RegExp {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - For refinements, the output type is narrowed by both.
  * - Short-circuits on the first `false`.
  *
@@ -1804,7 +1759,6 @@ export const compose: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - For refinements, the output type is narrowed by both.
    * - Short-circuits on the first `false`.
    *
@@ -1837,7 +1791,6 @@ export const compose: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - For refinements, the output type is narrowed by both.
    * - Short-circuits on the first `false`.
    *
@@ -1870,7 +1823,6 @@ export const compose: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - For refinements, the output type is narrowed by both.
    * - Short-circuits on the first `false`.
    *
@@ -1903,7 +1855,6 @@ export const compose: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - For refinements, the output type is narrowed by both.
    * - Short-circuits on the first `false`.
    *
@@ -1942,7 +1893,6 @@ export const compose: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns a refinement if any element predicate is a refinement.
  * - Stops at the first failing element.
  *
@@ -1989,7 +1939,6 @@ export function Tuple<const T extends ReadonlyArray<Predicate.Any>>(
  *
  * **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.
  *
@@ -2039,7 +1988,6 @@ export function Struct<R extends Record<string, Predicate.Any>>(
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns a new predicate that flips the boolean result.
  *
  * **Example** (Negate)
@@ -2072,7 +2020,6 @@ export function not<A>(self: Predicate<A>): Predicate<A> {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Short-circuits on the first `true`.
  * - For refinements, the output type is a union.
  *
@@ -2102,7 +2049,6 @@ export const or: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Short-circuits on the first `true`.
    * - For refinements, the output type is a union.
    *
@@ -2132,7 +2078,6 @@ export const or: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Short-circuits on the first `true`.
    * - For refinements, the output type is a union.
    *
@@ -2162,7 +2107,6 @@ export const or: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Short-circuits on the first `true`.
    * - For refinements, the output type is a union.
    *
@@ -2192,7 +2136,6 @@ export const or: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Short-circuits on the first `true`.
    * - For refinements, the output type is a union.
    *
@@ -2224,7 +2167,6 @@ export const or: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Short-circuits on the first `false`.
  * - For refinements, the output type is an intersection.
  *
@@ -2262,7 +2204,6 @@ export const and: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Short-circuits on the first `false`.
    * - For refinements, the output type is an intersection.
    *
@@ -2300,7 +2241,6 @@ export const and: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Short-circuits on the first `false`.
    * - For refinements, the output type is an intersection.
    *
@@ -2338,7 +2278,6 @@ export const and: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Short-circuits on the first `false`.
    * - For refinements, the output type is an intersection.
    *
@@ -2376,7 +2315,6 @@ export const and: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Short-circuits on the first `false`.
    * - For refinements, the output type is an intersection.
    *
@@ -2415,7 +2353,6 @@ export const and: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns `true` when results differ.
  *
  * **Example** (Exclusive or)
@@ -2445,7 +2382,6 @@ export const xor: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns `true` when results differ.
    *
    * **Example** (Exclusive or)
@@ -2475,7 +2411,6 @@ export const xor: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns `true` when results differ.
    *
    * **Example** (Exclusive or)
@@ -2507,7 +2442,6 @@ export const xor: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns `true` when both results are equal.
  *
  * **Example** (Equivalence)
@@ -2535,7 +2469,6 @@ export const eqv: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns `true` when both results are equal.
    *
    * **Example** (Equivalence)
@@ -2563,7 +2496,6 @@ export const eqv: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns `true` when both results are equal.
    *
    * **Example** (Equivalence)
@@ -2594,7 +2526,6 @@ export const eqv: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns `true` when the antecedent is `false`.
  *
  * **Example** (Implication)
@@ -2625,7 +2556,6 @@ export const implies: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns `true` when the antecedent is `false`.
    *
    * **Example** (Implication)
@@ -2656,7 +2586,6 @@ export const implies: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns `true` when the antecedent is `false`.
    *
    * **Example** (Implication)
@@ -2691,7 +2620,6 @@ export const implies: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns the negation of {@link or}.
  *
  * **Example** (NOR)
@@ -2719,7 +2647,6 @@ export const nor: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns the negation of {@link or}.
    *
    * **Example** (NOR)
@@ -2747,7 +2674,6 @@ export const nor: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns the negation of {@link or}.
    *
    * **Example** (NOR)
@@ -2780,7 +2706,6 @@ export const nor: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Returns the negation of {@link and}.
  *
  * **Example** (NAND)
@@ -2808,7 +2733,6 @@ export const nand: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns the negation of {@link and}.
    *
    * **Example** (NAND)
@@ -2836,7 +2760,6 @@ export const nand: {
    *
    * **Details**
    *
-   * - Pure; does not mutate input.
    * - Returns the negation of {@link and}.
    *
    * **Example** (NAND)
@@ -2869,7 +2792,6 @@ export const nand: {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Short-circuits on the first `false`.
  * - Iterates the collection each time the predicate is called.
  *
@@ -2908,7 +2830,6 @@ export function every<A>(collection: Iterable<Predicate<A>>): Predicate<A> {
  *
  * **Details**
  *
- * - Pure; does not mutate input.
  * - Short-circuits on the first `true`.
  * - Iterates the collection each time the predicate is called.
  *

package/src/PrimaryKey.ts

@@ -50,7 +50,7 @@
 import { hasProperty } from "./Predicate.ts"
 
 /**
- * The unique identifier used to identify objects that implement the `PrimaryKey` interface.
+ * Defines the unique identifier used to identify objects that implement the `PrimaryKey` interface.
  *
  * **When to use**
  *
@@ -71,8 +71,8 @@ export const symbol = "~effect/interfaces/PrimaryKey"
  *
  * **When to use**
  *
- * Use to define values that expose a stable string identifier through the
- * `PrimaryKey` protocol.
+ * Use to define values that expose a stable string identifier for equality,
+ * hashing, caching, or persistence.
  *
  * **Details**
  *