effect 4.0.0-beta.18 → 4.0.0-beta.19

package/src/Trie.ts

@@ -16,6 +16,7 @@
  * @since 2.0.0
  */
 import type { Equal } from "./Equal.ts"
+import type * as Filter from "./Filter.ts"
 import type { Inspectable } from "./Inspectable.ts"
 import * as TR from "./internal/trie.ts"
 import type { Option } from "./Option.ts"
@@ -1488,13 +1489,13 @@ export const filter: {
 } = TR.filter
 
 /**
- * Maps over the entries of the `Trie` using the specified partial function
- * and filters out `None` values.
+ * Maps over the entries of the `Trie` using the specified filter and keeps
+ * only successful results.
  *
  * @example
  * ```ts
  * import * as Equal from "effect/Equal"
- * import * as Option from "effect/Option"
+ * import * as Result from "effect/Result"
  * import * as Trie from "effect/Trie"
  * import * as assert from "node:assert"
  *
@@ -1515,7 +1516,7 @@ export const filter: {
  *
  * assert.equal(
  *   Equal.equals(
- *     Trie.filterMap(trie, (v) => v > 1 ? Option.some(v) : Option.none()),
+ *     Trie.filterMap(trie, (v) => v > 1 ? Result.succeed(v) : Result.failVoid),
  *     trieMapV
  *   ),
  *   true
@@ -1524,7 +1525,7 @@ export const filter: {
  *   Equal.equals(
  *     Trie.filterMap(
  *       trie,
- *       (v, k) => k.length > 3 ? Option.some(v) : Option.none()
+ *       (v, k) => k.length > 3 ? Result.succeed(v) : Result.failVoid
  *     ),
  *     trieMapK
  *   ),
@@ -1537,13 +1538,13 @@ export const filter: {
  */
 export const filterMap: {
   /**
-   * Maps over the entries of the `Trie` using the specified partial function
-   * and filters out `None` values.
+   * Maps over the entries of the `Trie` using the specified filter and keeps
+   * only successful results.
    *
    * @example
    * ```ts
    * import * as Equal from "effect/Equal"
-   * import * as Option from "effect/Option"
+   * import * as Result from "effect/Result"
    * import * as Trie from "effect/Trie"
    * import * as assert from "node:assert"
    *
@@ -1564,7 +1565,7 @@ export const filterMap: {
    *
    * assert.equal(
    *   Equal.equals(
-   *     Trie.filterMap(trie, (v) => v > 1 ? Option.some(v) : Option.none()),
+   *     Trie.filterMap(trie, (v) => v > 1 ? Result.succeed(v) : Result.failVoid),
    *     trieMapV
    *   ),
    *   true
@@ -1573,7 +1574,7 @@ export const filterMap: {
    *   Equal.equals(
    *     Trie.filterMap(
    *       trie,
-   *       (v, k) => k.length > 3 ? Option.some(v) : Option.none()
+   *       (v, k) => k.length > 3 ? Result.succeed(v) : Result.failVoid
    *     ),
    *     trieMapK
    *   ),
@@ -1584,15 +1585,15 @@ export const filterMap: {
    * @since 2.0.0
    * @category filtering
    */
-  <A, B>(f: (value: A, key: string) => Option<B>): (self: Trie<A>) => Trie<B>
+  <A, B, X>(f: Filter.Filter<A, B, X, [key: string]>): (self: Trie<A>) => Trie<B>
   /**
-   * Maps over the entries of the `Trie` using the specified partial function
-   * and filters out `None` values.
+   * Maps over the entries of the `Trie` using the specified filter and keeps
+   * only successful results.
    *
    * @example
    * ```ts
    * import * as Equal from "effect/Equal"
-   * import * as Option from "effect/Option"
+   * import * as Result from "effect/Result"
    * import * as Trie from "effect/Trie"
    * import * as assert from "node:assert"
    *
@@ -1613,7 +1614,7 @@ export const filterMap: {
    *
    * assert.equal(
    *   Equal.equals(
-   *     Trie.filterMap(trie, (v) => v > 1 ? Option.some(v) : Option.none()),
+   *     Trie.filterMap(trie, (v) => v > 1 ? Result.succeed(v) : Result.failVoid),
    *     trieMapV
    *   ),
    *   true
@@ -1622,7 +1623,7 @@ export const filterMap: {
    *   Equal.equals(
    *     Trie.filterMap(
    *       trie,
-   *       (v, k) => k.length > 3 ? Option.some(v) : Option.none()
+   *       (v, k) => k.length > 3 ? Result.succeed(v) : Result.failVoid
    *     ),
    *     trieMapK
    *   ),
@@ -1633,7 +1634,7 @@ export const filterMap: {
    * @since 2.0.0
    * @category filtering
    */
-  <A, B>(self: Trie<A>, f: (value: A, key: string) => Option<B>): Trie<B>
+  <A, B, X>(self: Trie<A>, f: Filter.Filter<A, B, X, [key: string]>): Trie<B>
 } = TR.filterMap
 
 /**

package/src/TxHashMap.ts

@@ -3,6 +3,7 @@
  */
 
 import * as Effect from "./Effect.ts"
+import type * as Filter from "./Filter.ts"
 import { format } from "./Formatter.ts"
 import { dual } from "./Function.ts"
 import * as HashMap from "./HashMap.ts"
@@ -2720,15 +2721,15 @@ export const reduce: {
 )
 
 /**
- * Combines filtering and mapping in a single operation. Applies a function that returns
- * an Option to each entry, keeping only the Some values and transforming them.
+ * Combines filtering and mapping in a single operation. Applies a filter to each
+ * entry, keeping only successful results and transforming them.
  *
  * **Return behavior**: This function returns a new TxHashMap reference containing
- * only the transformed entries that returned Some values. The original TxHashMap is not modified.
+ * only the transformed entries that succeeded. The original TxHashMap is not modified.
  *
  * @example
  * ```ts
- * import { Effect, Option, TxHashMap } from "effect"
+ * import { Effect, Option, Result, TxHashMap } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   // Create a mixed data map
@@ -2743,10 +2744,10 @@ export const reduce: {
  *   const activeAdminAges = yield* TxHashMap.filterMap(
  *     userData,
  *     (user, username) => {
- *       if (!user.active || user.role !== "admin") return Option.none()
+ *       if (!user.active || user.role !== "admin") return Result.failVoid
  *       const age = parseInt(user.age)
- *       if (isNaN(age)) return Option.none()
- *       return Option.some({
+ *       if (isNaN(age)) return Result.failVoid
+ *       return Result.succeed({
  *         username,
  *         age,
  *         seniority: age > 27 ? "senior" : "junior"
@@ -2764,7 +2765,7 @@ export const reduce: {
  *   const validAges = yield* userData.pipe(
  *     TxHashMap.filterMap((user) => {
  *       const age = parseInt(user.age)
- *       return isNaN(age) ? Option.none() : Option.some(age)
+ *       return isNaN(age) ? Result.failVoid : Result.succeed(age)
  *     })
  *   )
  *
@@ -2778,15 +2779,15 @@ export const reduce: {
  */
 export const filterMap: {
   /**
-   * Combines filtering and mapping in a single operation. Applies a function that returns
-   * an Option to each entry, keeping only the Some values and transforming them.
+   * Combines filtering and mapping in a single operation. Applies a filter to each
+   * entry, keeping only successful results and transforming them.
    *
    * **Return behavior**: This function returns a new TxHashMap reference containing
-   * only the transformed entries that returned Some values. The original TxHashMap is not modified.
+   * only the transformed entries that succeeded. The original TxHashMap is not modified.
    *
    * @example
    * ```ts
-   * import { Effect, Option, TxHashMap } from "effect"
+   * import { Effect, Option, Result, TxHashMap } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   // Create a mixed data map
@@ -2801,10 +2802,10 @@ export const filterMap: {
    *   const activeAdminAges = yield* TxHashMap.filterMap(
    *     userData,
    *     (user, username) => {
-   *       if (!user.active || user.role !== "admin") return Option.none()
+   *       if (!user.active || user.role !== "admin") return Result.failVoid
    *       const age = parseInt(user.age)
-   *       if (isNaN(age)) return Option.none()
-   *       return Option.some({
+   *       if (isNaN(age)) return Result.failVoid
+   *       return Result.succeed({
    *         username,
    *         age,
    *         seniority: age > 27 ? "senior" : "junior"
@@ -2822,7 +2823,7 @@ export const filterMap: {
    *   const validAges = yield* userData.pipe(
    *     TxHashMap.filterMap((user) => {
    *       const age = parseInt(user.age)
-   *       return isNaN(age) ? Option.none() : Option.some(age)
+   *       return isNaN(age) ? Result.failVoid : Result.succeed(age)
    *     })
    *   )
    *
@@ -2834,17 +2835,17 @@ export const filterMap: {
    * @since 2.0.0
    * @category combinators
    */
-  <A, V, K>(f: (value: V, key: K) => Option.Option<A>): (self: TxHashMap<K, V>) => Effect.Effect<TxHashMap<K, A>, never, Effect.Transaction>
+  <V, K, A, X>(f: Filter.Filter<V, A, X, [key: K]>): (self: TxHashMap<K, V>) => Effect.Effect<TxHashMap<K, A>, never, Effect.Transaction>
   /**
-   * Combines filtering and mapping in a single operation. Applies a function that returns
-   * an Option to each entry, keeping only the Some values and transforming them.
+   * Combines filtering and mapping in a single operation. Applies a filter to each
+   * entry, keeping only successful results and transforming them.
    *
    * **Return behavior**: This function returns a new TxHashMap reference containing
-   * only the transformed entries that returned Some values. The original TxHashMap is not modified.
+   * only the transformed entries that succeeded. The original TxHashMap is not modified.
    *
    * @example
    * ```ts
-   * import { Effect, Option, TxHashMap } from "effect"
+   * import { Effect, Option, Result, TxHashMap } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   // Create a mixed data map
@@ -2859,10 +2860,10 @@ export const filterMap: {
    *   const activeAdminAges = yield* TxHashMap.filterMap(
    *     userData,
    *     (user, username) => {
-   *       if (!user.active || user.role !== "admin") return Option.none()
+   *       if (!user.active || user.role !== "admin") return Result.failVoid
    *       const age = parseInt(user.age)
-   *       if (isNaN(age)) return Option.none()
-   *       return Option.some({
+   *       if (isNaN(age)) return Result.failVoid
+   *       return Result.succeed({
    *         username,
    *         age,
    *         seniority: age > 27 ? "senior" : "junior"
@@ -2880,7 +2881,7 @@ export const filterMap: {
    *   const validAges = yield* userData.pipe(
    *     TxHashMap.filterMap((user) => {
    *       const age = parseInt(user.age)
-   *       return isNaN(age) ? Option.none() : Option.some(age)
+   *       return isNaN(age) ? Result.failVoid : Result.succeed(age)
    *     })
    *   )
    *
@@ -2892,12 +2893,12 @@ export const filterMap: {
    * @since 2.0.0
    * @category combinators
    */
-  <K, V, A>(self: TxHashMap<K, V>, f: (value: V, key: K) => Option.Option<A>): Effect.Effect<TxHashMap<K, A>, never, Effect.Transaction>
+  <K, V, A, X>(self: TxHashMap<K, V>, f: Filter.Filter<V, A, X, [key: K]>): Effect.Effect<TxHashMap<K, A>, never, Effect.Transaction>
 } = dual(
   2,
-  <K, V, A>(
+  <K, V, A, X>(
     self: TxHashMap<K, V>,
-    f: (value: V, key: K) => Option.Option<A>
+    f: Filter.Filter<V, A, X, [key: K]>
   ): Effect.Effect<TxHashMap<K, A>, never, Effect.Transaction> =>
     Effect.gen(function*() {
       const currentMap = yield* TxRef.get(self.ref)