effect 4.0.0-beta.2 → 4.0.0-beta.20

package/dist/Array.d.ts

@@ -1,5 +1,5 @@
 import * as Equivalence from "./Equivalence.ts";
-import * as Filter from "./Filter.ts";
+import type * as Filter from "./Filter.ts";
 import type { LazyArg } from "./Function.ts";
 import type { TypeLambda } from "./HKT.ts";
 import * as Option from "./Option.ts";
@@ -1850,7 +1850,7 @@ export declare const takeWhile: {
      * @category getters
      * @since 2.0.0
      */
-    <A, B, X>(f: Filter.Filter<NoInfer<A>, B, X>): (self: Iterable<A>) => Array<B>;
+    <A, B extends A>(self: Iterable<A>, refinement: (a: A, i: number) => a is B): Array<B>;
     /**
      * Takes elements from the start while the predicate holds, stopping at the
      * first element that fails.
@@ -1873,53 +1873,38 @@ export declare const takeWhile: {
      * @category getters
      * @since 2.0.0
      */
-    <A, B extends A>(self: Iterable<A>, refinement: (a: A, i: number) => a is B): Array<B>;
+    <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A>;
+};
+/**
+ * Takes elements from the start while a `Filter` succeeds, collecting transformed values.
+ *
+ * - The filter receives `(element, index)`.
+ * - Stops at the first filter failure.
+ *
+ * @category getters
+ * @since 4.0.0
+ */
+export declare const takeWhileFilter: {
     /**
-     * Takes elements from the start while the predicate holds, stopping at the
-     * first element that fails.
-     *
-     * - Supports refinements for type narrowing.
-     * - The predicate receives `(element, index)`.
-     *
-     * **Example** (Taking while condition holds)
+     * Takes elements from the start while a `Filter` succeeds, collecting transformed values.
      *
-     * ```ts
-     * import { Array } from "effect"
-     *
-     * console.log(Array.takeWhile([1, 3, 2, 4, 1, 2], (x) => x < 4)) // [1, 3, 2]
-     * ```
-     *
-     * @see {@link take} — take a fixed count
-     * @see {@link dropWhile} — drop while predicate holds
-     * @see {@link span} — split into matching prefix + rest
+     * - The filter receives `(element, index)`.
+     * - Stops at the first filter failure.
      *
      * @category getters
-     * @since 2.0.0
+     * @since 4.0.0
      */
-    <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A>;
+    <A, B, X>(f: Filter.Filter<NoInfer<A>, B, X, [i: number]>): (self: Iterable<A>) => Array<B>;
     /**
-     * Takes elements from the start while the predicate holds, stopping at the
-     * first element that fails.
-     *
-     * - Supports refinements for type narrowing.
-     * - The predicate receives `(element, index)`.
-     *
-     * **Example** (Taking while condition holds)
+     * Takes elements from the start while a `Filter` succeeds, collecting transformed values.
      *
-     * ```ts
-     * import { Array } from "effect"
-     *
-     * console.log(Array.takeWhile([1, 3, 2, 4, 1, 2], (x) => x < 4)) // [1, 3, 2]
-     * ```
-     *
-     * @see {@link take} — take a fixed count
-     * @see {@link dropWhile} — drop while predicate holds
-     * @see {@link span} — split into matching prefix + rest
+     * - The filter receives `(element, index)`.
+     * - Stops at the first filter failure.
      *
      * @category getters
-     * @since 2.0.0
+     * @since 4.0.0
      */
-    <A, B, X>(self: Iterable<A>, f: Filter.Filter<A, B, X>): Array<B>;
+    <A, B, X>(self: Iterable<A>, f: Filter.Filter<A, B, X, [i: number]>): Array<B>;
 };
 /**
  * Splits an iterable into two arrays: the longest prefix where the predicate
@@ -2229,47 +2214,38 @@ export declare const dropWhile: {
      * @category getters
      * @since 2.0.0
      */
-    <A, B, X>(f: Filter.Filter<NoInfer<A>, B, X>): (self: Iterable<A>) => Array<A>;
+    <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A>;
+};
+/**
+ * Drops elements from the start while a `Filter` succeeds.
+ *
+ * - The filter receives `(element, index)`.
+ * - Returns the remaining original elements after the first filter failure.
+ *
+ * @category getters
+ * @since 4.0.0
+ */
+export declare const dropWhileFilter: {
     /**
-     * Drops elements from the start while the predicate holds, returning the rest.
-     *
-     * - The predicate receives `(element, index)`.
+     * Drops elements from the start while a `Filter` succeeds.
      *
-     * **Example** (Dropping while condition holds)
-     *
-     * ```ts
-     * import { Array } from "effect"
-     *
-     * console.log(Array.dropWhile([1, 2, 3, 4, 5], (x) => x < 4)) // [4, 5]
-     * ```
-     *
-     * @see {@link takeWhile} — keep the matching prefix instead
-     * @see {@link drop} — drop a fixed count
+     * - The filter receives `(element, index)`.
+     * - Returns the remaining original elements after the first filter failure.
      *
      * @category getters
-     * @since 2.0.0
+     * @since 4.0.0
      */
-    <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A>;
+    <A, B, X>(f: Filter.Filter<NoInfer<A>, B, X, [i: number]>): (self: Iterable<A>) => Array<A>;
     /**
-     * Drops elements from the start while the predicate holds, returning the rest.
+     * Drops elements from the start while a `Filter` succeeds.
      *
-     * - The predicate receives `(element, index)`.
-     *
-     * **Example** (Dropping while condition holds)
-     *
-     * ```ts
-     * import { Array } from "effect"
-     *
-     * console.log(Array.dropWhile([1, 2, 3, 4, 5], (x) => x < 4)) // [4, 5]
-     * ```
-     *
-     * @see {@link takeWhile} — keep the matching prefix instead
-     * @see {@link drop} — drop a fixed count
+     * - The filter receives `(element, index)`.
+     * - Returns the remaining original elements after the first filter failure.
      *
      * @category getters
-     * @since 2.0.0
+     * @since 4.0.0
      */
-    <A, B, X>(self: Iterable<A>, f: Filter.Filter<A, B, X>): Array<A>;
+    <A, B, X>(self: Iterable<A>, f: Filter.Filter<A, B, X, [i: number]>): Array<A>;
 };
 /**
  * Returns the index of the first element matching the predicate, or `undefined`
@@ -5520,82 +5496,6 @@ export declare const flatMap: {
  * @since 2.0.0
  */
 export declare const flatten: <const S extends ReadonlyArray<ReadonlyArray<any>>>(self: S) => ReadonlyArray.Flatten<S>;
-/**
- * Maps each element to a `Result`, then separates failures and successes into
- * two arrays.
- *
- * - Returns `[failures, successes]`.
- *
- * **Example** (Partitioning by Result)
- *
- * ```ts
- * import { Array, Result } from "effect"
- *
- * const result = Array.partitionMap(
- *   [1, 2, 3, 4, 5],
- *   (x) => x % 2 === 0 ? Result.succeed(x) : Result.fail(x)
- * )
- * console.log(result) // [[1, 3, 5], [2, 4]]
- * ```
- *
- * @see {@link partition} — partition by predicate
- * @see {@link separate} — partition an array of Results
- *
- * @category filtering
- * @since 2.0.0
- */
-export declare const partitionMap: {
-    /**
-     * Maps each element to a `Result`, then separates failures and successes into
-     * two arrays.
-     *
-     * - Returns `[failures, successes]`.
-     *
-     * **Example** (Partitioning by Result)
-     *
-     * ```ts
-     * import { Array, Result } from "effect"
-     *
-     * const result = Array.partitionMap(
-     *   [1, 2, 3, 4, 5],
-     *   (x) => x % 2 === 0 ? Result.succeed(x) : Result.fail(x)
-     * )
-     * console.log(result) // [[1, 3, 5], [2, 4]]
-     * ```
-     *
-     * @see {@link partition} — partition by predicate
-     * @see {@link separate} — partition an array of Results
-     *
-     * @category filtering
-     * @since 2.0.0
-     */
-    <A, B, C>(f: (a: A, i: number) => Result.Result<C, B>): (self: Iterable<A>) => [fails: Array<B>, successes: Array<C>];
-    /**
-     * Maps each element to a `Result`, then separates failures and successes into
-     * two arrays.
-     *
-     * - Returns `[failures, successes]`.
-     *
-     * **Example** (Partitioning by Result)
-     *
-     * ```ts
-     * import { Array, Result } from "effect"
-     *
-     * const result = Array.partitionMap(
-     *   [1, 2, 3, 4, 5],
-     *   (x) => x % 2 === 0 ? Result.succeed(x) : Result.fail(x)
-     * )
-     * console.log(result) // [[1, 3, 5], [2, 4]]
-     * ```
-     *
-     * @see {@link partition} — partition by predicate
-     * @see {@link separate} — partition an array of Results
-     *
-     * @category filtering
-     * @since 2.0.0
-     */
-    <A, B, C>(self: Iterable<A>, f: (a: A, i: number) => Result.Result<C, B>): [fails: Array<B>, successes: Array<C>];
-};
 /**
  * Extracts all `Some` values from an iterable of `Option`s, discarding `None`s.
  *
@@ -5655,65 +5555,89 @@ export declare const getFailures: <T extends Iterable<Result.Result<any, any>>>(
  */
 export declare const getSuccesses: <T extends Iterable<Result.Result<any, any>>>(self: T) => Array<Result.Result.Success<ReadonlyArray.Infer<T>>>;
 /**
- * Keeps only elements satisfying a predicate (or refinement).
+ * Keeps transformed values for elements where a `Filter` succeeds.
  *
- * - The predicate receives `(element, index)`.
- * - Supports refinements for type narrowing.
+ * - The filter receives `(element, index)`.
+ * - Failures are discarded.
  *
- * **Example** (Filtering even numbers)
+ * **Example** (Filter and transform)
  *
  * ```ts
- * import { Array } from "effect"
+ * import { Array, Result } from "effect"
  *
- * console.log(Array.filter([1, 2, 3, 4], (x) => x % 2 === 0)) // [2, 4]
+ * console.log(Array.filterMap([1, 2, 3, 4], (n) => n % 2 === 0 ? Result.succeed(n * 10) : Result.failVoid))
+ * // [20, 40]
  * ```
  *
- * @see {@link partition} — split into matching and non-matching
+ * @see {@link filter} — keep original elements matching a predicate
  *
  * @category filtering
- * @since 2.0.0
+ * @since 4.0.0
  */
-export declare const filter: {
+export declare const filterMap: {
     /**
-     * Keeps only elements satisfying a predicate (or refinement).
+     * Keeps transformed values for elements where a `Filter` succeeds.
      *
-     * - The predicate receives `(element, index)`.
-     * - Supports refinements for type narrowing.
+     * - The filter receives `(element, index)`.
+     * - Failures are discarded.
      *
-     * **Example** (Filtering even numbers)
+     * **Example** (Filter and transform)
      *
      * ```ts
-     * import { Array } from "effect"
+     * import { Array, Result } from "effect"
      *
-     * console.log(Array.filter([1, 2, 3, 4], (x) => x % 2 === 0)) // [2, 4]
+     * console.log(Array.filterMap([1, 2, 3, 4], (n) => n % 2 === 0 ? Result.succeed(n * 10) : Result.failVoid))
+     * // [20, 40]
      * ```
      *
-     * @see {@link partition} — split into matching and non-matching
+     * @see {@link filter} — keep original elements matching a predicate
      *
      * @category filtering
-     * @since 2.0.0
+     * @since 4.0.0
      */
-    <A, B extends A>(refinement: (a: NoInfer<A>, i: number) => a is B): (self: Iterable<A>) => Array<B>;
+    <A, B, X>(f: Filter.Filter<NoInfer<A>, B, X, [i: number]>): (self: Iterable<A>) => Array<B>;
     /**
-     * Keeps only elements satisfying a predicate (or refinement).
+     * Keeps transformed values for elements where a `Filter` succeeds.
      *
-     * - The predicate receives `(element, index)`.
-     * - Supports refinements for type narrowing.
+     * - The filter receives `(element, index)`.
+     * - Failures are discarded.
      *
-     * **Example** (Filtering even numbers)
+     * **Example** (Filter and transform)
      *
      * ```ts
-     * import { Array } from "effect"
+     * import { Array, Result } from "effect"
      *
-     * console.log(Array.filter([1, 2, 3, 4], (x) => x % 2 === 0)) // [2, 4]
+     * console.log(Array.filterMap([1, 2, 3, 4], (n) => n % 2 === 0 ? Result.succeed(n * 10) : Result.failVoid))
+     * // [20, 40]
      * ```
      *
-     * @see {@link partition} — split into matching and non-matching
+     * @see {@link filter} — keep original elements matching a predicate
      *
      * @category filtering
-     * @since 2.0.0
+     * @since 4.0.0
      */
-    <A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => Array<A>;
+    <A, B, X>(self: Iterable<A>, f: Filter.Filter<A, B, X, [i: number]>): Array<B>;
+};
+/**
+ * Keeps only elements satisfying a predicate (or refinement).
+ *
+ * - The predicate receives `(element, index)`.
+ * - Supports refinements for type narrowing.
+ *
+ * **Example** (Filtering even numbers)
+ *
+ * ```ts
+ * import { Array } from "effect"
+ *
+ * console.log(Array.filter([1, 2, 3, 4], (x) => x % 2 === 0)) // [2, 4]
+ * ```
+ *
+ * @see {@link partition} — split into matching and non-matching
+ *
+ * @category filtering
+ * @since 2.0.0
+ */
+export declare const filter: {
     /**
      * Keeps only elements satisfying a predicate (or refinement).
      *
@@ -5733,7 +5657,7 @@ export declare const filter: {
      * @category filtering
      * @since 2.0.0
      */
-    <A, B, X>(f: Filter.Filter<NoInfer<A>, B, X>): (self: Iterable<A>) => Array<B>;
+    <A, B extends A>(refinement: (a: NoInfer<A>, i: number) => a is B): (self: Iterable<A>) => Array<B>;
     /**
      * Keeps only elements satisfying a predicate (or refinement).
      *
@@ -5753,7 +5677,7 @@ export declare const filter: {
      * @category filtering
      * @since 2.0.0
      */
-    <A, B extends A>(self: Iterable<A>, refinement: (a: A, i: number) => a is B): Array<B>;
+    <A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => Array<A>;
     /**
      * Keeps only elements satisfying a predicate (or refinement).
      *
@@ -5773,7 +5697,7 @@ export declare const filter: {
      * @category filtering
      * @since 2.0.0
      */
-    <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A>;
+    <A, B extends A>(self: Iterable<A>, refinement: (a: A, i: number) => a is B): Array<B>;
     /**
      * Keeps only elements satisfying a predicate (or refinement).
      *
@@ -5793,176 +5717,80 @@ export declare const filter: {
      * @category filtering
      * @since 2.0.0
      */
-    <A, B, X>(self: Iterable<A>, f: Filter.Filter<A, B, X>): Array<B>;
+    <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A>;
 };
 /**
- * Splits an iterable into two arrays: elements that fail the predicate and
- * elements that satisfy it.
+ * Splits an iterable using a `Filter` into failures and successes.
  *
  * - Returns `[excluded, satisfying]`.
- * - Supports refinements for type narrowing.
+ * - The filter receives `(element, index)`.
  *
- * **Example** (Partitioning by predicate)
+ * **Example** (Partitioning with a filter)
  *
  * ```ts
- * import { Array } from "effect"
+ * import { Array, Result } from "effect"
  *
- * console.log(Array.partition([1, 2, 3, 4], (n) => n % 2 === 0)) // [[1, 3], [2, 4]]
+ * console.log(Array.partition([1, -2, 3], (n, i) =>
+ *   n > 0 ? Result.succeed(n + i) : Result.fail(`negative:${n}`)
+ * ))
+ * // [["negative:-2"], [1, 5]]
  * ```
  *
  * @see {@link filter} — keep only matching elements
  * @see {@link partitionMap} — partition using a Result-returning function
  *
- * Also accepts a `Filter` to split elements with custom pass/fail payloads.
- *
  * @category filtering
  * @since 2.0.0
  */
 export declare const partition: {
     /**
-     * Splits an iterable into two arrays: elements that fail the predicate and
-     * elements that satisfy it.
+     * Splits an iterable using a `Filter` into failures and successes.
      *
      * - Returns `[excluded, satisfying]`.
-     * - Supports refinements for type narrowing.
+     * - The filter receives `(element, index)`.
      *
-     * **Example** (Partitioning by predicate)
+     * **Example** (Partitioning with a filter)
      *
      * ```ts
-     * import { Array } from "effect"
-     *
-     * console.log(Array.partition([1, 2, 3, 4], (n) => n % 2 === 0)) // [[1, 3], [2, 4]]
-     * ```
-     *
-     * @see {@link filter} — keep only matching elements
-     * @see {@link partitionMap} — partition using a Result-returning function
-     *
-     * Also accepts a `Filter` to split elements with custom pass/fail payloads.
-     *
-     * @category filtering
-     * @since 2.0.0
-     */
-    <A, B extends A>(refinement: (a: NoInfer<A>, i: number) => a is B): (self: Iterable<A>) => [excluded: Array<Exclude<A, B>>, satisfying: Array<B>];
-    /**
-     * Splits an iterable into two arrays: elements that fail the predicate and
-     * elements that satisfy it.
-     *
-     * - Returns `[excluded, satisfying]`.
-     * - Supports refinements for type narrowing.
-     *
-     * **Example** (Partitioning by predicate)
-     *
-     * ```ts
-     * import { Array } from "effect"
-     *
-     * console.log(Array.partition([1, 2, 3, 4], (n) => n % 2 === 0)) // [[1, 3], [2, 4]]
-     * ```
-     *
-     * @see {@link filter} — keep only matching elements
-     * @see {@link partitionMap} — partition using a Result-returning function
-     *
-     * Also accepts a `Filter` to split elements with custom pass/fail payloads.
-     *
-     * @category filtering
-     * @since 2.0.0
-     */
-    <A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => [excluded: Array<A>, satisfying: Array<A>];
-    /**
-     * Splits an iterable into two arrays: elements that fail the predicate and
-     * elements that satisfy it.
-     *
-     * - Returns `[excluded, satisfying]`.
-     * - Supports refinements for type narrowing.
-     *
-     * **Example** (Partitioning by predicate)
-     *
-     * ```ts
-     * import { Array } from "effect"
-     *
-     * console.log(Array.partition([1, 2, 3, 4], (n) => n % 2 === 0)) // [[1, 3], [2, 4]]
-     * ```
-     *
-     * @see {@link filter} — keep only matching elements
-     * @see {@link partitionMap} — partition using a Result-returning function
-     *
-     * Also accepts a `Filter` to split elements with custom pass/fail payloads.
-     *
-     * @category filtering
-     * @since 2.0.0
-     */
-    <A, Pass, Fail>(f: Filter.Filter<A, Pass, Fail>): (self: Iterable<A>) => [excluded: Array<Fail>, satisfying: Array<Pass>];
-    /**
-     * Splits an iterable into two arrays: elements that fail the predicate and
-     * elements that satisfy it.
-     *
-     * - Returns `[excluded, satisfying]`.
-     * - Supports refinements for type narrowing.
-     *
-     * **Example** (Partitioning by predicate)
-     *
-     * ```ts
-     * import { Array } from "effect"
-     *
-     * console.log(Array.partition([1, 2, 3, 4], (n) => n % 2 === 0)) // [[1, 3], [2, 4]]
-     * ```
-     *
-     * @see {@link filter} — keep only matching elements
-     * @see {@link partitionMap} — partition using a Result-returning function
-     *
-     * Also accepts a `Filter` to split elements with custom pass/fail payloads.
-     *
-     * @category filtering
-     * @since 2.0.0
-     */
-    <A, B extends A>(self: Iterable<A>, refinement: (a: A, i: number) => a is B): [excluded: Array<Exclude<A, B>>, satisfying: Array<B>];
-    /**
-     * Splits an iterable into two arrays: elements that fail the predicate and
-     * elements that satisfy it.
-     *
-     * - Returns `[excluded, satisfying]`.
-     * - Supports refinements for type narrowing.
-     *
-     * **Example** (Partitioning by predicate)
-     *
-     * ```ts
-     * import { Array } from "effect"
+     * import { Array, Result } from "effect"
      *
-     * console.log(Array.partition([1, 2, 3, 4], (n) => n % 2 === 0)) // [[1, 3], [2, 4]]
+     * console.log(Array.partition([1, -2, 3], (n, i) =>
+     *   n > 0 ? Result.succeed(n + i) : Result.fail(`negative:${n}`)
+     * ))
+     * // [["negative:-2"], [1, 5]]
      * ```
      *
      * @see {@link filter} — keep only matching elements
      * @see {@link partitionMap} — partition using a Result-returning function
      *
-     * Also accepts a `Filter` to split elements with custom pass/fail payloads.
-     *
      * @category filtering
      * @since 2.0.0
      */
-    <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): [excluded: Array<A>, satisfying: Array<A>];
+    <A, Pass, Fail>(f: Filter.Filter<NoInfer<A>, Pass, Fail, [i: number]>): (self: Iterable<A>) => [excluded: Array<Fail>, satisfying: Array<Pass>];
     /**
-     * Splits an iterable into two arrays: elements that fail the predicate and
-     * elements that satisfy it.
+     * Splits an iterable using a `Filter` into failures and successes.
      *
      * - Returns `[excluded, satisfying]`.
-     * - Supports refinements for type narrowing.
+     * - The filter receives `(element, index)`.
      *
-     * **Example** (Partitioning by predicate)
+     * **Example** (Partitioning with a filter)
      *
      * ```ts
-     * import { Array } from "effect"
+     * import { Array, Result } from "effect"
      *
-     * console.log(Array.partition([1, 2, 3, 4], (n) => n % 2 === 0)) // [[1, 3], [2, 4]]
+     * console.log(Array.partition([1, -2, 3], (n, i) =>
+     *   n > 0 ? Result.succeed(n + i) : Result.fail(`negative:${n}`)
+     * ))
+     * // [["negative:-2"], [1, 5]]
      * ```
      *
      * @see {@link filter} — keep only matching elements
      * @see {@link partitionMap} — partition using a Result-returning function
      *
-     * Also accepts a `Filter` to split elements with custom pass/fail payloads.
-     *
      * @category filtering
      * @since 2.0.0
      */
-    <A, Pass, Fail>(self: Iterable<A>, f: Filter.Filter<A, Pass, Fail>): [excluded: Array<Fail>, satisfying: Array<Pass>];
+    <A, Pass, Fail>(self: Iterable<A>, f: Filter.Filter<A, Pass, Fail, [i: number]>): [excluded: Array<Fail>, satisfying: Array<Pass>];
 };
 /**
  * Separates an iterable of `Result`s into two arrays: failures and successes.