<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
Resulttype - The error type
Edefaults tonever
Example (Wrapping a value)
import { Result } from "effect"
const result = Result.succeed(42)
console.log(Result.isSuccess(result))
// Output: trueSource effect/Result.ts:2841 lines
export const 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: <function (type parameter) A in <A>(right: A): Result<A>A>(right: Aright: function (type parameter) A in <A>(right: A): Result<A>A) => 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>(right: A): Result<A>A> = import resultresult.const succeed: <A>(
success: A
) => Result.Result<A>
Referenced by 41 symbols
Brand.nominalCache.entriesCache.keysChannel.unwrapReasonCron.parseEncoding.decodeBase64Encoding.decodeHexFilter.equalsFilter.equalsStrictFilter.fromPredicateFilter.fromPredicateOptionFilter.hasFilter.instanceOfFilter.toResultFilter.zipWithIterable.flatMapNullishOrOptic.successPull.filterDonePull.filterDoneLeftoverPull.filterDoneVoidResult.DoResult.allResult.andThenResult.filterOrFailResult.flipResult.fromNullishOrResult.genResult.liftPredicateResult.mapResult.mapBothResult.mapErrorResult.orElseResult.succeedNoneResult.succeedSomeSchedule.andThenResultSchedule.cronSchema.ResultStream.catchTagsStream.mergeResultStream.result+1 more