<A extends Array<unknown>, E, B>(f: (...a: A) => Result.Result<B, E>): (
...a: A
) => Array<B>Lifts a Result-returning function into one that returns an array: failures
produce [], successes produce [value].
When to use
Use when a fallible parser or lookup should participate in array pipelines as zero-or-one results and the failure value should be discarded.
Example (Lifting a Result function)
import { Array, Result } from "effect"
const parseNumber = (s: string): Result.Result<number, Error> =>
isNaN(Number(s))
? Result.fail(new Error("Not a number"))
: Result.succeed(Number(s))
const liftedParseNumber = Array.liftResult(parseNumber)
console.log(liftedParseNumber("42")) // [42]
console.log(liftedParseNumber("not a number")) // []export const const liftResult: <
A extends Array<unknown>,
E,
B
>(
f: (...a: A) => Result.Result<B, E>
) => (...a: A) => Array<B>
Lifts a Result-returning function into one that returns an array: failures
produce [], successes produce [value].
When to use
Use when a fallible parser or lookup should participate in array pipelines as
zero-or-one results and the failure value should be discarded.
Example (Lifting a Result function)
import { Array, Result } from "effect"
const parseNumber = (s: string): Result.Result<number, Error> =>
isNaN(Number(s))
? Result.fail(new Error("Not a number"))
: Result.succeed(Number(s))
const liftedParseNumber = Array.liftResult(parseNumber)
console.log(liftedParseNumber("42")) // [42]
console.log(liftedParseNumber("not a number")) // []
liftResult = <function (type parameter) A in <A extends Array<unknown>, E, B>(f: (...a: A) => Result.Result<B, E>): (...a: A) => Array<B>A extends interface Array<T>Array<unknown>, function (type parameter) E in <A extends Array<unknown>, E, B>(f: (...a: A) => Result.Result<B, E>): (...a: A) => Array<B>E, function (type parameter) B in <A extends Array<unknown>, E, B>(f: (...a: A) => Result.Result<B, E>): (...a: A) => Array<B>B>(
f: (...a: A) => Result.Result<B, E>f: (...a: A extends Array<unknown>a: function (type parameter) A in <A extends Array<unknown>, E, B>(f: (...a: A) => Result.Result<B, E>): (...a: A) => Array<B>A) => import ResultResult.type Result<A, E = never> = Result.Success<A, E> | Result.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) B in <A extends Array<unknown>, E, B>(f: (...a: A) => Result.Result<B, E>): (...a: A) => Array<B>B, function (type parameter) E in <A extends Array<unknown>, E, B>(f: (...a: A) => Result.Result<B, E>): (...a: A) => Array<B>E>
) =>
(...a: A extends Array<unknown>a: function (type parameter) A in <A extends Array<unknown>, E, B>(f: (...a: A) => Result.Result<B, E>): (...a: A) => Array<B>A): interface Array<T>Array<function (type parameter) B in <A extends Array<unknown>, E, B>(f: (...a: A) => Result.Result<B, E>): (...a: A) => Array<B>B> => {
const const e: Result.Result<B, E>e = f: (...a: A) => Result.Result<B, E>f(...a: A extends Array<unknown>a)
return import ResultResult.const isFailure: <A, E>(
self: Result<A, E>
) => self is Failure<A, E>
Checks whether a Result is a Failure.
When to use
Use to narrow a known Result to the Failure variant.
Details
- Acts as a TypeScript type guard, narrowing to
Failure<A, E>
- After narrowing, you can access
.failure to read the error value
Example (Narrowing to failure)
import { Result } from "effect"
const result = Result.fail("oops")
if (Result.isFailure(result)) {
console.log(result.failure)
// Output: "oops"
}
isFailure(const e: Result.Result<B, E>e) ? [] : [const e: Result.Success<B, E>const e: {
_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;
}
e.Success<B, E>.success: Bsuccess]
}