Function expect

Retrieve the value from an ok result

Will throw with custom message if result is an err result

Template: T

The value type of the Ok result.

Param: result

Result to unwrap the value from

Param: message

Custom message to throw with

expect(result: Result<never, unknown>, message: string): never
Retrieve the value from an Err result.

This override documents that an error is thrown when unwrapping an Err result.
Parameters
- result: Result<never, unknown>
  An Err result value
- message: string
Returns never
Never
- Defined in src/index.ts:219
expect<T>(result: Result<T, unknown>, message: string): T
Retrieve the value from an Ok result.

This override is required for type safety for Ok results.
Type Parameters
- T
  The value type of the Ok result.
Parameters
- result: Result<T, unknown>
  Result to unwrap the value from
- message: string
Returns T
The successful value of T result
- Defined in src/index.ts:231