Skip to content

fix docs not using Filter module #721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 14, 2025
Merged

fix docs not using Filter module #721

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ec176e
fix: docs not using `Filter` module
unknown Nov 11, 2025
72cd6d4
Merge branch 'main' into fix-filter-docs
unknown Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions packages/effect/src/Effect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3756,8 +3756,9 @@ export const raceFirst: {
* @example
* ```ts
* import { Effect } from "effect"
* import { Filter } from "effect/data"
*
* const isEven = (n: number) => Effect.succeed(n % 2 === 0)
* const isEven = (n: number) => Effect.succeed(n % 2 === 0 ? n : Filter.fail(n))
*
* const program = Effect.filter([1, 2, 3, 4, 5], isEven)
*
Expand Down Expand Up @@ -3787,14 +3788,15 @@ export const filter: <A, B, X, E, R>(
* @example
* ```ts
* import { Effect } from "effect"
* import { Filter } from "effect/data"
*
* // An effect that produces a number
* const program = Effect.succeed(5)
*
* // Filter for even numbers, provide alternative for odd numbers
* const filtered = Effect.filterOrElse(
* program,
* (n): n is number => n % 2 === 0,
* (n) => n % 2 === 0 ? n : Filter.fail(n),
* (n) => Effect.succeed(`Number ${n} is odd`)
* )
*
Expand Down Expand Up @@ -3828,14 +3830,15 @@ export const filterOrElse: {
* @example
* ```ts
* import { Effect } from "effect"
* import { Filter } from "effect/data"
*
* // An effect that produces a number
* const program = Effect.succeed(5)
*
* // Filter for even numbers, fail for odd numbers
* const filtered = Effect.filterOrFail(
* program,
* (n): n is number => n % 2 === 0,
* (n) => n % 2 === 0 ? n : Filter.fail(n),
* (n) => `Expected even number, got ${n}`
* )
*
Expand Down
Loading