Class Result<T>

This module contains the 'Result' class, which represents wrapper for a value that can be either a success or an error.

The 'Result' class provides methods to unwrap the value, expect a value or isOk or isErr to check if the result is successful.

Type Parameters

T

Hierarchy

Result

Index

Constructors

Properties

Methods

expect isErr isOk unwrap

Constructors

constructor

new Result<T>(value, error?): Result<T>
Initializes a Result object.
Type Parameters
- T
Parameters
- value: T
  
  expected value for passing case
- error: null | string = null
  
  error message for non-passing case
Returns Result<T>
- Defined in result.ts:18

Properties

error

error: null | string = null

error message for non-passing case

Methods

expect

expect(msg): NonNullable<T>
Returns the value if the Result is successful. Throws an assertion error if not.
Parameters
- msg: string
  
  The message to be displayed if the Result has failed.
Returns NonNullable<T>
The value if the Result is successful.

Throws
If there is an error in the result, it throws an assertion error with the given message.
- Defined in result.ts:49

isErr

isErr(): bool
Determines if the Result represents a failed outcome.

Returns bool
true if the Result is not okay, false otherwise.
- Defined in result.ts:35

isOk

isOk(): bool
Determines if the Result represents a successful outcome.

Returns bool
true if the Result is okay, false otherwise.
- Defined in result.ts:25

unwrap

unwrap(): NonNullable<T>
Get the value of the Result.

Returns NonNullable<T>
The value of the Result if successful.

Remarks
This method panics if the Result is an error.

Throws
If there is an error in the result, it throws an assertion error with the given message.
- Defined in result.ts:67

Generated using TypeDoc