Function unwrap

unwrap<R extends ResultMaybeAsync<any, any>>(
result: R,
): true extends HasPromise<R> ? Promise<InferSuccess<R>> : InferSuccess<R>
Extracts the success value from a Result, ResultAsync.

If the result is a Failure, it throws the contained error. For ResultAsync, it returns a Promise that resolves to the success value or rejects with the error.
Type Parameters
- R extends ResultMaybeAsync<any, any>
  The type of the result to unwrap.
Parameters
- result: R
  The Result, ResultAsync.
Returns true extends HasPromise<R> ? Promise<InferSuccess<R>> : InferSuccess<R>
The success value, or a Promise of the success value for async results.
Throws
The error value if the result is a Failure.
Example: Success Case
```
import { Result } from '@praha/byethrow';

const result: Result.Result<number, string> = Result.succeed(100);
const value = Result.unwrap(result); // 100
```
Example: Failure Case
```
import { Result } from '@praha/byethrow';

const result: Result.Result<number, string> = Result.fail('Oops');
const value = Result.unwrap(result); // throws 'Oops'
```
Example: Async Success Case
```
import { Result } from '@praha/byethrow';

const result: Result.ResultAsync<number, string> = Result.succeed(Promise.resolve(100));
const value = await Result.unwrap(result); // 100
```
Example: Async Failure Case
```
import { Result } from '@praha/byethrow';

const result: Result.ResultAsync<number, string> = Result.fail(Promise.resolve('Oops'));
const value = await Result.unwrap(result); // throws 'Oops'
```
- Defined in functions/unwrap.ts:55

Function unwrap

Type Parameters

Parameters

Returns true extends HasPromise<R> ? Promise<InferSuccess<R>> : InferSuccess<R>

Throws

Example: Success Case

Example: Failure Case

Example: Async Success Case

Example: Async Failure Case

Settings