Class Result<T, E>

Type Parameters

T extends defined
E extends defined

Hierarchy

Result

Index

Properties

Methods

contains containsErr expect expectErr isErr isOk unwrap unwrapErr unwrapOr unwrapOrElse

Properties

_err

_err: undefined | E

_value

_value: undefined | T

Methods

contains

contains(value: unknown): boolean
Parameters
- value: unknown
Returns boolean
- Defined in src/modules/Result.ts:26

containsErr

containsErr(value: unknown): boolean
Parameters
- value: unknown
Returns boolean
- Defined in src/modules/Result.ts:30

expect

expect(msg: string, level?: number): T
Parameters
- msg: string
- Optional level: number
Returns T
- Defined in src/modules/Result.ts:34

expectErr

expectErr(msg: string, level?: number): E
Parameters
- msg: string
- Optional level: number
Returns E
- Defined in src/modules/Result.ts:68

isErr

isErr(): boolean
Returns boolean
- Defined in src/modules/Result.ts:22

isOk

isOk(): boolean
Returns boolean
- Defined in src/modules/Result.ts:18

unwrap

unwrap(): T
Returns T
- Defined in src/modules/Result.ts:48

unwrapErr

unwrapErr(): E
Returns E
- Defined in src/modules/Result.ts:82

unwrapOr

unwrapOr(def: T): T
Parameters
- def: T
Returns T
- Defined in src/modules/Result.ts:52

unwrapOrElse

unwrapOrElse(func: (() => T)): T
Parameters
- func: (() => T)
  - - (): T
    - Returns T
Returns T
- Defined in src/modules/Result.ts:60

Generated using TypeDoc