Class CompatResult<T, E>

constructor

• new CompatResult<T, E>(inner: Result<T, E>): CompatResult<T, E>

  Type Parameters

  • T
  • E

  Parameters

  • inner: Result<T, E>

  Returns CompatResult<T, E>

Readonlyinner

error

• get error(): E

  Returns E

value

• get value(): T

  Returns T

_unsafeUnwrap

• _unsafeUnwrap(): T

  Returns T

_unsafeUnwrapErr

• _unsafeUnwrapErr(): E

  Returns E

andThen

• andThen<U, F = E>(fn: (value: T) => CompatResult<U, F>): CompatResult<U, E | F>

  Type Parameters

  • U
  • F = E

  Parameters

  • fn: (value: T) => CompatResult<U, F>

  Returns CompatResult<U, E | F>

asyncAndThen

• asyncAndThen<U, F = E>(
      fn: (value: T) => CompatResultAsync<U, F> | ResultAsync<U, F>,
  ): CompatResultAsync<U, E | F>

  Type Parameters

  • U
  • F = E

  Parameters

  • fn: (value: T) => CompatResultAsync<U, F> | ResultAsync<U, F>

  Returns CompatResultAsync<U, E | F>

isErr

• isErr(): boolean

  Returns boolean

isOk

• isOk(): boolean

  Returns boolean

map

• map<U>(fn: (value: T) => U): CompatResult<U, E>

  Type Parameters

  • U

  Parameters

  • fn: (value: T) => U

  Returns CompatResult<U, E>

mapErr

• mapErr<F>(fn: (error: E) => F): CompatResult<T, F>

  Type Parameters

  • F

  Parameters

  • fn: (error: E) => F

  Returns CompatResult<T, F>

match

• match<U1, U2 = U1>(onOk: (value: T) => U1, onErr: (error: E) => U2): U1 | U2

  Type Parameters

  • U1
  • U2 = U1

  Parameters

  • onOk: (value: T) => U1
  • onErr: (error: E) => U2

  Returns U1 | U2

orElse

• orElse<F>(fn: (error: E) => CompatResult<T, F>): CompatResult<T, F>

  Type Parameters

  • F

  Parameters

  • fn: (error: E) => CompatResult<T, F>

  Returns CompatResult<T, F>

unwrapOr

• unwrapOr<U>(defaultValue: U): T | U

  Type Parameters

  • U

  Parameters

  • defaultValue: U

  Returns T | U

Staticcombine

• combine<const R extends readonly CompatResult<unknown, unknown>[]>(
      results: R,
  ): CompatResult<TupleOk<R>, TupleErr<R>>

  Type Parameters

  • const R extends readonly CompatResult<unknown, unknown>[]

  Parameters

  • results: R

  Returns CompatResult<TupleOk<R>, TupleErr<R>>

StaticfromThrowable

• fromThrowable<A extends readonly unknown[], U, F>(
      fn: (...args: A) => U,
      onThrow: (error: unknown) => F,
  ): (...args: A) => CompatResult<U, F>

  Type Parameters

  • A extends readonly unknown[]
  • U
  • F

  Parameters

  • fn: (...args: A) => U
  • onThrow: (error: unknown) => F

  Returns (...args: A) => CompatResult<U, F>