<A, A2>(f: (ok: A) => A2): <E>(self: Result<A, E>) => Result<A2, E>
<A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>Transforms the success channel of a Result, leaving the failure channel unchanged.
When to use
Use to apply a transformation to the success value of a Result while
preserving any existing failure.
Details
- If the result is a
Success, appliesfto the value and returns a newSuccess - If the result is a
Failure, returns it as-is - Use flatMap if
freturns aResult(to avoid nested Results)
Example (Doubling the success value)
import { pipe, Result } from "effect"
const result = pipe(
Result.succeed(3),
Result.map((n) => n * 2)
)
console.log(result)
// Output: { _tag: "Success", success: 6, ... }export const const map: {
<A, A2>(f: (ok: A) => A2): <E>(
self: Result<A, E>
) => Result<A2, E>
<A, E, A2>(
self: Result<A, E>,
f: (ok: A) => A2
): Result<A2, E>
}
Transforms the success channel of a Result, leaving the failure channel unchanged.
When to use
Use to apply a transformation to the success value of a Result while
preserving any existing failure.
Details
- If the result is a
Success, applies f to the value and returns a new Success
- If the result is a
Failure, returns it as-is
- Use
flatMap
if
f returns a Result (to avoid nested Results)
Example (Doubling the success value)
import { pipe, Result } from "effect"
const result = pipe(
Result.succeed(3),
Result.map((n) => n * 2)
)
console.log(result)
// Output: { _tag: "Success", success: 6, ... }
map: {
<function (type parameter) A in <A, A2>(f: (ok: A) => A2): <E>(self: Result<A, E>) => Result<A2, E>A, function (type parameter) A2 in <A, A2>(f: (ok: A) => A2): <E>(self: Result<A, E>) => Result<A2, E>A2>(f: (ok: A) => A2f: (ok: Aok: function (type parameter) A in <A, A2>(f: (ok: A) => A2): <E>(self: Result<A, E>) => Result<A2, E>A) => function (type parameter) A2 in <A, A2>(f: (ok: A) => A2): <E>(self: Result<A, E>) => Result<A2, E>A2): <function (type parameter) E in <E>(self: Result<A, E>): Result<A2, E>E>(self: Result<A, E>self: type Result<A, E = never> = Success<A, E> | Failure<A, E>A value that is either Success<A, E> or Failure<A, E>.
When to use
Use when both success and failure should remain available as data and
Option would lose failure information.
Details
- Use
succeed
/
fail
to construct
- Use
match
to fold both branches
- Use
isSuccess
/
isFailure
to narrow the type
E defaults to never, so Result<number> means a result that cannot fail.
Example (Creating and matching a Result)
import { Result } from "effect"
const success = Result.succeed(42)
const failure = Result.fail("something went wrong")
const message = Result.match(success, {
onSuccess: (value) => `Success: ${value}`,
onFailure: (error) => `Error: ${error}`
})
console.log(message)
// Output: "Success: 42"
Namespace containing type-level utilities for extracting the inner types
of a Result.
Example (Extracting inner types)
import type { Result } from "effect"
type R = Result.Result<number, string>
// number
type A = Result.Result.Success<R>
// string
type E = Result.Result.Failure<R>
Result<function (type parameter) A in <A, A2>(f: (ok: A) => A2): <E>(self: Result<A, E>) => Result<A2, E>A, function (type parameter) E in <E>(self: Result<A, E>): Result<A2, E>E>) => type Result<A, E = never> = Success<A, E> | Failure<A, E>A value that is either Success<A, E> or Failure<A, E>.
When to use
Use when both success and failure should remain available as data and
Option would lose failure information.
Details
- Use
succeed
/
fail
to construct
- Use
match
to fold both branches
- Use
isSuccess
/
isFailure
to narrow the type
E defaults to never, so Result<number> means a result that cannot fail.
Example (Creating and matching a Result)
import { Result } from "effect"
const success = Result.succeed(42)
const failure = Result.fail("something went wrong")
const message = Result.match(success, {
onSuccess: (value) => `Success: ${value}`,
onFailure: (error) => `Error: ${error}`
})
console.log(message)
// Output: "Success: 42"
Namespace containing type-level utilities for extracting the inner types
of a Result.
Example (Extracting inner types)
import type { Result } from "effect"
type R = Result.Result<number, string>
// number
type A = Result.Result.Success<R>
// string
type E = Result.Result.Failure<R>
Result<function (type parameter) A2 in <A, A2>(f: (ok: A) => A2): <E>(self: Result<A, E>) => Result<A2, E>A2, function (type parameter) E in <E>(self: Result<A, E>): Result<A2, E>E>
<function (type parameter) A in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A, function (type parameter) E in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>E, function (type parameter) A2 in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A2>(self: Result<A, E>self: type Result<A, E = never> = Success<A, E> | Failure<A, E>A value that is either Success<A, E> or Failure<A, E>.
When to use
Use when both success and failure should remain available as data and
Option would lose failure information.
Details
- Use
succeed
/
fail
to construct
- Use
match
to fold both branches
- Use
isSuccess
/
isFailure
to narrow the type
E defaults to never, so Result<number> means a result that cannot fail.
Example (Creating and matching a Result)
import { Result } from "effect"
const success = Result.succeed(42)
const failure = Result.fail("something went wrong")
const message = Result.match(success, {
onSuccess: (value) => `Success: ${value}`,
onFailure: (error) => `Error: ${error}`
})
console.log(message)
// Output: "Success: 42"
Namespace containing type-level utilities for extracting the inner types
of a Result.
Example (Extracting inner types)
import type { Result } from "effect"
type R = Result.Result<number, string>
// number
type A = Result.Result.Success<R>
// string
type E = Result.Result.Failure<R>
Result<function (type parameter) A in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A, function (type parameter) E in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>E>, f: (ok: A) => A2f: (ok: Aok: function (type parameter) A in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A) => function (type parameter) A2 in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A2): type Result<A, E = never> = Success<A, E> | Failure<A, E>A value that is either Success<A, E> or Failure<A, E>.
When to use
Use when both success and failure should remain available as data and
Option would lose failure information.
Details
- Use
succeed
/
fail
to construct
- Use
match
to fold both branches
- Use
isSuccess
/
isFailure
to narrow the type
E defaults to never, so Result<number> means a result that cannot fail.
Example (Creating and matching a Result)
import { Result } from "effect"
const success = Result.succeed(42)
const failure = Result.fail("something went wrong")
const message = Result.match(success, {
onSuccess: (value) => `Success: ${value}`,
onFailure: (error) => `Error: ${error}`
})
console.log(message)
// Output: "Success: 42"
Namespace containing type-level utilities for extracting the inner types
of a Result.
Example (Extracting inner types)
import type { Result } from "effect"
type R = Result.Result<number, string>
// number
type A = Result.Result.Success<R>
// string
type E = Result.Result.Failure<R>
Result<function (type parameter) A2 in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A2, function (type parameter) E in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>E>
} = import dualdual(
2,
<function (type parameter) A in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A, function (type parameter) E in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>E, function (type parameter) A2 in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A2>(self: Result<A, E>self: type Result<A, E = never> = Success<A, E> | Failure<A, E>A value that is either Success<A, E> or Failure<A, E>.
When to use
Use when both success and failure should remain available as data and
Option would lose failure information.
Details
- Use
succeed
/
fail
to construct
- Use
match
to fold both branches
- Use
isSuccess
/
isFailure
to narrow the type
E defaults to never, so Result<number> means a result that cannot fail.
Example (Creating and matching a Result)
import { Result } from "effect"
const success = Result.succeed(42)
const failure = Result.fail("something went wrong")
const message = Result.match(success, {
onSuccess: (value) => `Success: ${value}`,
onFailure: (error) => `Error: ${error}`
})
console.log(message)
// Output: "Success: 42"
Namespace containing type-level utilities for extracting the inner types
of a Result.
Example (Extracting inner types)
import type { Result } from "effect"
type R = Result.Result<number, string>
// number
type A = Result.Result.Success<R>
// string
type E = Result.Result.Failure<R>
Result<function (type parameter) A in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A, function (type parameter) E in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>E>, f: (ok: A) => A2f: (ok: Aok: function (type parameter) A in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A) => function (type parameter) A2 in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A2): type Result<A, E = never> = Success<A, E> | Failure<A, E>A value that is either Success<A, E> or Failure<A, E>.
When to use
Use when both success and failure should remain available as data and
Option would lose failure information.
Details
- Use
succeed
/
fail
to construct
- Use
match
to fold both branches
- Use
isSuccess
/
isFailure
to narrow the type
E defaults to never, so Result<number> means a result that cannot fail.
Example (Creating and matching a Result)
import { Result } from "effect"
const success = Result.succeed(42)
const failure = Result.fail("something went wrong")
const message = Result.match(success, {
onSuccess: (value) => `Success: ${value}`,
onFailure: (error) => `Error: ${error}`
})
console.log(message)
// Output: "Success: 42"
Namespace containing type-level utilities for extracting the inner types
of a Result.
Example (Extracting inner types)
import type { Result } from "effect"
type R = Result.Result<number, string>
// number
type A = Result.Result.Success<R>
// string
type E = Result.Result.Failure<R>
Result<function (type parameter) A2 in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>A2, function (type parameter) E in <A, E, A2>(self: Result<A, E>, f: (ok: A) => A2): Result<A2, E>E> =>
const isSuccess: <A, E>(
self: Result<A, E>
) => self is Success<A, E>
Checks whether a Result is a Success.
When to use
Use to narrow a known Result to the Success variant.
Details
- Acts as a TypeScript type guard, narrowing to
Success<A, E>
- After narrowing, you can access
.success to read the value
Example (Narrowing to success)
import { Result } from "effect"
const result = Result.succeed(42)
if (Result.isSuccess(result)) {
console.log(result.success)
// Output: 42
}
isSuccess(self: Result<A, E>self) ? const succeed: <A>(right: A) => Result<A>Creates a Result holding a Success value.
Details
- Use when you have a value and want to lift it into the
Result type
- The error type
E defaults to never
Example (Wrapping a value)
import { Result } from "effect"
const result = Result.succeed(42)
console.log(Result.isSuccess(result))
// Output: true
succeed(f: (ok: A) => A2f(self: Result<A, E>(parameter) self: {
_tag: "Success";
_op: "Success";
success: A;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
Success<A, E>.success: Asuccess)) : const fail: <E>(
left: E
) => Result<never, E>
Creates a Result holding a Failure value.
When to use
Use to represent a failed Result with a typed failure value.
Details
- The success type
A defaults to never
Example (Creating a failure)
import { Result } from "effect"
const result = Result.fail("Something went wrong")
console.log(Result.isFailure(result))
// Output: true
fail(self: Result<A, E>(parameter) self: {
_tag: "Failure";
_op: "Failure";
failure: E;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
Failure<A, E>.failure: Efailure)
)