Class Result<T, E>

Type Parameters

T
E = Error

Implements

Iterable<T>

Index

Constructors

constructor

new Result<T, E = Error>(
    createSecret: unknown,
    value: unknown,
    error: unknown,
): Result<T, E>
Type Parameters
- T
- E = Error
Parameters
- createSecret: unknown
- value: unknown
- error: unknown
Returns Result<T, E>
- Defined in Result.ts:28

Methods

[iterator]

"[iterator]"(): ResultIterator<T>
Returns ResultIterator<T>
Implementation of Iterable.[iterator]
- Defined in Result.ts:193

and

and<U>(value: Result<U, E>): Result<U, E>
Type Parameters
- U
Parameters
- value: Result<U, E>
Returns Result<U, E>
- Defined in Result.ts:117

andThen

andThen<U>(fn: (value: T) => Result<U, E>): Result<U, E>
Type Parameters
- U
Parameters
- fn: (value: T) => Result<U, E>
Returns Result<U, E>
- Defined in Result.ts:123

expect

expect(): T
Returns T
- Defined in Result.ts:50

flatMap

flatMap<U>(fn: (value: T) => Result<U, E>): Result<U, E>
Type Parameters
- U
Parameters
- fn: (value: T) => Result<U, E>
Returns Result<U, E>
- Defined in Result.ts:92

flatMapOr

flatMapOr<U>(fn: (value: T) => Result<U, E>, def: Result<U, E>): Result<U, E>
Type Parameters
- U
Parameters
- fn: (value: T) => Result<U, E>
- def: Result<U, E>
Returns Result<U, E>
- Defined in Result.ts:98

flatMapOrElse

flatMapOrElse<U>(
fn: (value: T) => Result<U, E>,
defFn: () => Result<U, E>,
): Result<U, E>
Type Parameters
- U
Parameters
- fn: (value: T) => Result<U, E>
- defFn: () => Result<U, E>
Returns Result<U, E>
- Defined in Result.ts:107

ifErr

ifErr(fn: (error: E) => void, elseFn?: (value: T) => void): Result<T, E>
Parameters
- fn: (error: E) => void
- OptionalelseFn: (value: T) => void
Returns Result<T, E>
- Defined in Result.ts:177

ifOk

ifOk(fn: (value: T) => void, elseFn?: (error: E) => void): Result<T, E>
Parameters
- fn: (value: T) => void
- OptionalelseFn: (error: E) => void
Returns Result<T, E>
- Defined in Result.ts:169

isErr

isErr(): boolean
Returns boolean
- Defined in Result.ts:42

isOk

isOk(): boolean
Returns boolean
- Defined in Result.ts:46

map

map<U>(fn: (value: T) => U): Result<U, E>
Type Parameters
- U
Parameters
- fn: (value: T) => U
Returns Result<U, E>
- Defined in Result.ts:73

mapOr

mapOr<U>(fn: (value: T) => U, def: U): Result<U, E>
Type Parameters
- U
Parameters
- fn: (value: T) => U
- def: U
Returns Result<U, E>
- Defined in Result.ts:79

mapOrElse

mapOrElse<U>(fn: (value: T) => U, defFn: () => U): Result<U, E>
Type Parameters
- U
Parameters
- fn: (value: T) => U
- defFn: () => U
Returns Result<U, E>
- Defined in Result.ts:85

okOrInsert

okOrInsert(value: T): Result<T, E>
Parameters
- value: T
Returns Result<T, E>
- Defined in Result.ts:143

okOrInsertWith

okOrInsertWith(fn: () => T): Result<T, E>
Parameters
- fn: () => T
Returns Result<T, E>
- Defined in Result.ts:150

or

or(value: Result<T, E>): Result<T, E>
Parameters
- value: Result<T, E>
Returns Result<T, E>
- Defined in Result.ts:130

orElse

orElse(fn: () => Result<T, E>): Result<T, E>
Parameters
- fn: () => Result<T, E>
Returns Result<T, E>
- Defined in Result.ts:136

replace

replace(value: T): Result<T, E>
Parameters
- value: T
Returns Result<T, E>
- Defined in Result.ts:158

replaceErr

replaceErr(error: E): Result<T, E>
Parameters
- error: E
Returns Result<T, E>
- Defined in Result.ts:163

toJS

toJS(): T
Returns T
- Defined in Result.ts:189

toJSON

toJSON(): T
Returns T
- Defined in Result.ts:186

unwrap

unwrap(): T
Returns T
- Defined in Result.ts:57

unwrapOr

unwrapOr(def: T): T
Parameters
- def: T
Returns T
- Defined in Result.ts:60

unwrapOrElse

unwrapOrElse(defFn: () => T): T
Parameters
- defFn: () => T
Returns T
- Defined in Result.ts:66

`Static`err

err<T, E = Error>(error: E): Result<T, E>
Type Parameters
- T
- E = Error
Parameters
- error: E
Returns Result<T, E>
- Defined in Result.ts:13

`Static`ok

ok<T, E = Error>(value: T): Result<T, E>
Type Parameters
- T
- E = Error
Parameters
- value: T
Returns Result<T, E>
- Defined in Result.ts:10

`Static`try

try<T, E = Error>(
result: MaybePromiseLike<T>,
): Result<T, E> | Promise<Result<T, E>>
Type Parameters
- T
- E = Error
Parameters
- result: MaybePromiseLike<T>
Returns Result<T, E> | Promise<Result<T, E>>
- Defined in Result.ts:21

`Static`trycatch

trycatch<F extends () => unknown, E = Error>(fn: F): TryCatchReturnType<F, E>
Type Parameters
- F extends () => unknown
- E = Error
Parameters
- fn: F
Returns TryCatchReturnType<F, E>
- Defined in Result.ts:16