Class Err<T, ErrObj>

Represents a failed result containing an error. This class indicates that an operation failed with specific error information.

Type Parameters

T
The type of the success value (for type compatibility)
ErrObj
The type of the error object

Hierarchy

CResult<T, ErrObj>
- Err

Implements

IResult<T, ErrObj>

Index

Constructors

constructor

new Err<T, ErrObj>(val: RnError<ErrObj>): Err<T, ErrObj>
Creates a new Err result.
Type Parameters
- T
  The type of the success value (for type compatibility)
- ErrObj
  The type of the error object
Parameters
- val: RnError<ErrObj>
  The error information to store
Returns Err<T, ErrObj>
Overrides CResult<T, ErrObj>.constructor
- Defined in foundation/misc/Result.ts:237

Properties

_rnException

_rnException: RnException<ErrObj>

The RnException instance created from the error

`Protected` `Optional`val

val?: T | RnError<ErrObj>

The value to store (either success value or error)

Methods

andThen

andThen<U>(_f: (value: T) => Result<U, ErrObj>): Result<U, ErrObj>
Returns this Err result unchanged since the operation already failed. The chaining function is not called.
Type Parameters
- U
  The type of the new success value
Parameters
- _f: (value: T) => Result<U, ErrObj>
Returns Result<U, ErrObj>
This Err result cast to the new type
Implementation of IResult.andThen
- Defined in foundation/misc/Result.ts:249

false

false(): false
Always returns false for Err results.

Returns false
Always false

Deprecated
This method seems to be unused
- Defined in foundation/misc/Result.ts:287

getRnError

getRnError(): RnError<ErrObj>
Gets the contained error information.

Returns RnError<ErrObj>
The RnError object containing error details
- Defined in foundation/misc/Result.ts:311

isErr

isErr(): this is Err<T, ErrObj>
Type guard indicating this is an Err result.

Returns this is Err<T, ErrObj>
Always true for Err instances
Implementation of IResult.isErr
- Defined in foundation/misc/Result.ts:303

isOk

isOk(): this is Ok<T, ErrObj>
Type guard indicating this is not an Ok result.

Returns this is Ok<T, ErrObj>
Always false for Err instances
Implementation of IResult.isOk
- Defined in foundation/misc/Result.ts:295

match

match<R, ErrObj2>(
    obj: {
        Err: (value: RnError<ErrObj>) => RnError<ErrObj2>;
        Ok: (value: T) => R;
    },
): Result<R, ErrObj2>
Pattern matching implementation for Result types.
Type Parameters
- R
  The type of the return value from the Ok function
- ErrObj2
  The type of the new error object
Parameters
- obj: { Err: (value: RnError<ErrObj>) => RnError<ErrObj2>; Ok: (value: T) => R }
  Object containing pattern matching functions
  - Err: (value: RnError<ErrObj>) => RnError<ErrObj2>
    Function to execute if this result is Err
  - Ok: (value: T) => R
    Function to execute if this result is Ok
Returns Result<R, ErrObj2>
A new Result containing the result of the pattern matching

Throws
If the result is neither Ok nor Err
Implementation of IResult.match
Inherited from CResult.match
- Defined in foundation/misc/Result.ts:119

name

name(): string
Gets the name of this result class.

Returns string
The constructor name ('Ok' or 'Err')
Implementation of IResult.name
Inherited from CResult.name
- Defined in foundation/misc/Result.ts:137

orElse

orElse<U>(f: () => Result<U, ErrObj>): Result<U, ErrObj>
Provides an alternative result since this result failed. Calls the provided function to get an alternative result.
Type Parameters
- U
  The type of the alternative success value
Parameters
- f: () => Result<U, ErrObj>
  Function that provides an alternative result
Returns Result<U, ErrObj>
The result of the alternative function
Implementation of IResult.orElse
- Defined in foundation/misc/Result.ts:260

toString

toString(): string
Converts this error to a string representation.

Returns string
The stack trace from the contained exception
- Defined in foundation/misc/Result.ts:319

unwrapForce

unwrapForce(): never
Throws an exception since this result contains an error.

Returns never
Never returns (always throws)

Throws
Always throws the contained exception
Implementation of IResult.unwrapForce
- Defined in foundation/misc/Result.ts:278

unwrapWithCompensation

unwrapWithCompensation(catchFn: (err: RnError<ErrObj>) => T): T
Calls the compensation function to provide a fallback value.
Parameters
- catchFn: (err: RnError<ErrObj>) => T
  Function that provides a fallback value based on the error
Returns T
The compensated value from the catch function
Implementation of IResult.unwrapWithCompensation
- Defined in foundation/misc/Result.ts:269

Class Err<T, ErrObj>

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Err<T, ErrObj>

Properties

_rnException

Protected Optionalval

Methods

andThen

Type Parameters

Parameters

Returns Result<U, ErrObj>

false

Returns false

Deprecated

getRnError

Returns RnError<ErrObj>

isErr

Returns this is Err<T, ErrObj>

isOk

Returns this is Ok<T, ErrObj>

match

Type Parameters

Parameters

Err: (value: RnError<ErrObj>) => RnError<ErrObj2>

Ok: (value: T) => R

Returns Result<R, ErrObj2>

Throws

name

Returns string

orElse

Type Parameters

Parameters

Returns Result<U, ErrObj>

toString

Returns string

unwrapForce

Returns never

Throws

unwrapWithCompensation

Parameters

Returns T

Settings

On This Page

`Protected` `Optional`val