Class Err<T, ErrObj>

a class indicating that the result is Error (Failed).

Type Parameters

T
ErrObj

Hierarchy

Result<T, ErrObj>
- Err

Implements

IResult<T, ErrObj>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Err<T, ErrObj>(val: RnError<ErrObj>): Err<T, ErrObj>

Overrides Result<T, ErrObj>.constructor
- Defined in foundation/misc/Result.ts:107
Type Parameters
- T
- ErrObj
Parameters
- val: RnError<ErrObj>
Returns Err<T, ErrObj>

Properties

Private __rnException

__rnException: RnException<ErrObj>

Protected Optional val

val?: T | RnError<ErrObj>

Methods

false

false(): false

- Defined in foundation/misc/Result.ts:127
Returns false

getRnError

getRnError(): RnError<ErrObj>

- Defined in foundation/misc/Result.ts:139
Returns RnError<ErrObj>

isErr

isErr(): this is Err<T, ErrObj>

Implementation of IResult.isErr
- Defined in foundation/misc/Result.ts:135
Returns this is Err<T, ErrObj>

isOk

isOk(): false

Implementation of IResult.isOk
- Defined in foundation/misc/Result.ts:131
Returns false

match

match(obj: { Err: any; Finally?: any; Ok: any }): void

Implementation of IResult.match
Inherited from Result.match
- Defined in foundation/misc/Result.ts:33
Parameters
- obj: { Err: any; Finally?: any; Ok: any }
  - Err:function
    - Err(value: RnError<ErrObj>): void
    - Defined in foundation/misc/Result.ts:35
      Parameters
      - value: RnError<ErrObj>
      Returns void
  - Finally?:function
    - Finally(): void
    - Defined in foundation/misc/Result.ts:36
      Returns void
  - Ok:function
    - Ok(value: T): void
    - Defined in foundation/misc/Result.ts:34
      Parameters
      - value: T
      Returns void
Returns void

name

name(): string

Implementation of IResult.name
Inherited from Result.name
- Defined in foundation/misc/Result.ts:47
Returns string

toString

toString(): string

- Defined in foundation/misc/Result.ts:143
Returns string

unwrap

unwrap(catchFn: ((err: RnError<ErrObj>) => void)): void

Implementation of IResult.unwrap
- Defined in foundation/misc/Result.ts:119
Parameters
- catchFn: ((err: RnError<ErrObj>) => void)
  - - (err: RnError<ErrObj>): void
    - Parameters
      - err: RnError<ErrObj>
      Returns void
Returns void

unwrapForce

unwrapForce(): never

Implementation of IResult.unwrapForce
- Defined in foundation/misc/Result.ts:123
Returns never

Generated using TypeDoc