Function unwrap

unwrap<O extends Readonly<{ value: unknown }>>(optional: O): Unwrap<O>
Unwraps an Optional, returning the contained value or undefined if empty.

This function provides a safe way to extract values from Optionals without throwing exceptions. It has overloaded behavior based on the type:
- For Optional.Some<T>: Always returns T (guaranteed by type system)
- For general Optional<T>: Returns T | undefined
Type Parameters
- O extends Readonly<{ value: unknown }>
  The Optional.Base type to unwrap.
Parameters
- optional: O
  The Optional to unwrap.
Returns Unwrap<O>
The contained value if Optional.Some, otherwise undefined.
Example
```
const someString = Optional.some('text');
const noneString = Optional.none as Optional<string>;

assert(Optional.unwrap(someString) === 'text');
assert(Optional.unwrap(noneString) === undefined);
```
- Defined in src/functional/optional.mts:261
unwrap<O extends Optional.Base>(optional: O): Unwrap<O> | undefined
Unwraps an Optional, returning the contained value or undefined if empty.

This function provides a safe way to extract values from Optionals without throwing exceptions. It has overloaded behavior based on the type:
- For Optional.Some<T>: Always returns T (guaranteed by type system)
- For general Optional<T>: Returns T | undefined
Type Parameters
- O extends Optional.Base
  The Optional.Base type to unwrap.
Parameters
- optional: O
  The Optional to unwrap.
Returns Unwrap<O> | undefined
The contained value if Optional.Some, otherwise undefined.
Example
```
const someString = Optional.some('text');
const noneString = Optional.none as Optional<string>;

assert(Optional.unwrap(someString) === 'text');
assert(Optional.unwrap(noneString) === undefined);
```
- Defined in src/functional/optional.mts:263

Function unwrap

Type Parameters

Parameters

Returns Unwrap<O>

Example

Type Parameters

Parameters

Returns Unwrap<O> | undefined

Example

Settings