Class Result<T, E>

Type parameters

T
E = Error

Hierarchy

Result

Index

Constructors

constructor

Methods

Constructors

constructor

new Result<T, E>(createSecret: unknown, ok: T, err: E): Result<T, E>

- Defined in result/Result.ts:29
Type parameters
- T
- E = Error
Parameters
- createSecret: unknown
- ok: T
- err: E
Returns Result<T, E>

Methods

and

and<U>(ok: Result<U, E>): Result<U, E>

- Defined in result/Result.ts:196
Type parameters
- U
Parameters
- ok: Result<U, E>
Returns Result<U, E>

andThen

andThen<U>(fn: (value: T) => Result<U, E>): Result<U, E>

- Defined in result/Result.ts:203
Type parameters
- U
Parameters
- fn: (value: T) => Result<U, E>
  - - (value: T): Result<U, E>
    - Parameters
      - value: T
      Returns Result<U, E>
Returns Result<U, E>

expect

expect(): T

- Defined in result/Result.ts:47
Returns T

expectErr

expectErr(msg: string | (() => string)): E

- Defined in result/Result.ts:120
Parameters
- msg: string | (() => string)
Returns E

flatMap

flatMap<U>(fn: (ok: T) => Result<U, E>): Result<U, E>

- Defined in result/Result.ts:95
Type parameters
- U
Parameters
- fn: (ok: T) => Result<U, E>
  - - (ok: T): Result<U, E>
    - Parameters
      - ok: T
      Returns Result<U, E>
Returns Result<U, E>

flatMapErr

flatMapErr<U>(fn: (err: E) => Result<T, U>): Result<T, U>

- Defined in result/Result.ts:168
Type parameters
- U
Parameters
- fn: (err: E) => Result<T, U>
  - - (err: E): Result<T, U>
    - Parameters
      - err: E
      Returns Result<T, U>
Returns Result<T, U>

flatMapErrOr

flatMapErrOr<U>(fn: (err: E) => Result<T, U>, def: Result<T, U>): Result<T, U>

- Defined in result/Result.ts:175
Type parameters
- U
Parameters
- fn: (err: E) => Result<T, U>
  - - (err: E): Result<T, U>
    - Parameters
      - err: E
      Returns Result<T, U>
- def: Result<T, U>
Returns Result<T, U>

flatMapErrOrElse

flatMapErrOrElse<U>(fn: (err: E) => Result<T, U>, defFn: (value: T) => Result<T, U>): Result<T, U>

- Defined in result/Result.ts:185
Type parameters
- U
Parameters
- fn: (err: E) => Result<T, U>
  - - (err: E): Result<T, U>
    - Parameters
      - err: E
      Returns Result<T, U>
- defFn: (value: T) => Result<T, U>
  - - (value: T): Result<T, U>
    - Parameters
      - value: T
      Returns Result<T, U>
Returns Result<T, U>

flatMapOr

flatMapOr<U>(fn: (ok: T) => Result<U, E>, def: Result<U, E>): Result<U, E>

- Defined in result/Result.ts:102
Type parameters
- U
Parameters
- fn: (ok: T) => Result<U, E>
  - - (ok: T): Result<U, E>
    - Parameters
      - ok: T
      Returns Result<U, E>
- def: Result<U, E>
Returns Result<U, E>

flatMapOrElse

flatMapOrElse<U>(fn: (ok: T) => Result<U, E>, defFn: (error: E) => Result<U, E>): Result<U, E>

- Defined in result/Result.ts:109
Type parameters
- U
Parameters
- fn: (ok: T) => Result<U, E>
  - - (ok: T): Result<U, E>
    - Parameters
      - ok: T
      Returns Result<U, E>
- defFn: (error: E) => Result<U, E>
  - - (error: E): Result<U, E>
    - Parameters
      - error: E
      Returns Result<U, E>
Returns Result<U, E>

fromJSON

fromJSON(json: any): Result<T, E>

- Defined in result/Result.ts:243
Parameters
- json: any
Returns Result<T, E>

ifErr

ifErr(fn: (err: E) => void, okFn?: (ok: T) => void): Result<T, E>

- Defined in result/Result.ts:234
Parameters
- fn: (err: E) => void
  - - (err: E): void
    - Parameters
      - err: E
      Returns void
- Optional okFn: (ok: T) => void
  - - (ok: T): void
    - Parameters
      - ok: T
      Returns void
Returns Result<T, E>

ifOk

ifOk(fn: (ok: T) => void, errFn?: (err: E) => void): Result<T, E>

- Defined in result/Result.ts:226
Parameters
- fn: (ok: T) => void
  - - (ok: T): void
    - Parameters
      - ok: T
      Returns void
- Optional errFn: (err: E) => void
  - - (err: E): void
    - Parameters
      - err: E
      Returns void
Returns Result<T, E>

isErr

isErr(): boolean

- Defined in result/Result.ts:39
Returns boolean

isOk

isOk(): boolean

- Defined in result/Result.ts:43
Returns boolean

map

map<U>(fn: (ok: T) => U): Result<U, E>

- Defined in result/Result.ts:73
Type parameters
- U
Parameters
- fn: (ok: T) => U
  - - (ok: T): U
    - Parameters
      - ok: T
      Returns U
Returns Result<U, E>

mapErr

mapErr<U>(fn: (err: E) => U): Result<T, U>

- Defined in result/Result.ts:146
Type parameters
- U
Parameters
- fn: (err: E) => U
  - - (err: E): U
    - Parameters
      - err: E
      Returns U
Returns Result<T, U>

mapErrOr

mapErrOr<U>(fn: (err: E) => U, def: U): Result<T, U>

- Defined in result/Result.ts:153
Type parameters
- U
Parameters
- fn: (err: E) => U
  - - (err: E): U
    - Parameters
      - err: E
      Returns U
- def: U
Returns Result<T, U>

mapErrOrElse

mapErrOrElse<U>(fn: (err: E) => U, defFn: (value: T) => U): Result<T, U>

- Defined in result/Result.ts:160
Type parameters
- U
Parameters
- fn: (err: E) => U
  - - (err: E): U
    - Parameters
      - err: E
      Returns U
- defFn: (value: T) => U
  - - (value: T): U
    - Parameters
      - value: T
      Returns U
Returns Result<T, U>

mapOr

mapOr<U>(fn: (ok: T) => U, def: U): Result<U, E>

- Defined in result/Result.ts:80
Type parameters
- U
Parameters
- fn: (ok: T) => U
  - - (ok: T): U
    - Parameters
      - ok: T
      Returns U
- def: U
Returns Result<U, E>

mapOrElse

mapOrElse<U>(fn: (ok: T) => U, defFn: (error: E) => U): Result<U, E>

- Defined in result/Result.ts:87
Type parameters
- U
Parameters
- fn: (ok: T) => U
  - - (ok: T): U
    - Parameters
      - ok: T
      Returns U
- defFn: (error: E) => U
  - - (error: E): U
    - Parameters
      - error: E
      Returns U
Returns Result<U, E>

or

or(ok: Result<T, E>): Result<T, E>

- Defined in result/Result.ts:211
Parameters
- ok: Result<T, E>
Returns Result<T, E>

orElse

orElse(fn: (error: E) => Result<T, E>): Result<T, E>

- Defined in result/Result.ts:218
Parameters
- fn: (error: E) => Result<T, E>
  - - (error: E): Result<T, E>
    - Parameters
      - error: E
      Returns Result<T, E>
Returns Result<T, E>

toJS

toJS(): IResultOk<T> | IResultErr<E>

- Defined in result/Result.ts:264
Returns IResultOk<T> | IResultErr<E>

toJSON

toJSON(): IResultOk<T> | IResultErr<E>

- Defined in result/Result.ts:253
Returns IResultOk<T> | IResultErr<E>

unwrap

unwrap(): T

- Defined in result/Result.ts:55
Returns T

unwrapErr

unwrapErr(): E

- Defined in result/Result.ts:128
Returns E

unwrapErrOr

unwrapErrOr(def: E): E

- Defined in result/Result.ts:131
Parameters
- def: E
Returns E

unwrapErrOrElse

unwrapErrOrElse(defFn: (value: T) => E): E

- Defined in result/Result.ts:138
Parameters
- defFn: (value: T) => E
  - - (value: T): E
    - Parameters
      - value: T
      Returns E
Returns E

unwrapOr

unwrapOr(def: T): T

- Defined in result/Result.ts:58
Parameters
- def: T
Returns T

unwrapOrElse

unwrapOrElse(defFn: (error: E) => T): T

- Defined in result/Result.ts:65
Parameters
- defFn: (error: E) => T
  - - (error: E): T
    - Parameters
      - error: E
      Returns T
Returns T

Static err

err<T, E>(error: E): Result<T, E>

- Defined in result/Result.ts:12
Type parameters
- T
- E = Error
Parameters
- error: E
Returns Result<T, E>

Static fromOption

fromOption<T>(option: Option<T>, msg?: string): Result<T, Error>

- Defined in result/Result.ts:15
Type parameters
- T
Parameters
- option: Option<T>
- msg: string = "Tried to create Result from none Option"
Returns Result<T, Error>

Static ok

ok<T, E>(value: T): Result<T, E>

- Defined in result/Result.ts:9
Type parameters
- T
- E = Error
Parameters
- value: T
Returns Result<T, E>

Generated using TypeDoc