Class Some<T>

Type Parameters

T

Implements

SomeBase<T>

Index

Constructors

Properties

Accessors

[toStringTag] value

Constructors

constructor

new Some<T>(value: T): Some<T>
Type Parameters
- T
Parameters
- value: T
Returns Some<T>

Properties

`Readonly`_tag

_tag: "Some" = 'Some'

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string

value

get value(): T
Returns T
Implementation of SomeBase.value

Methods

[iterator]

"[iterator]"(): IterableIterator<T>
Returns IterableIterator<T>
Implementation of SomeBase.[iterator]

and

and<U = T>(other: Option<U>): Option<U>
Returns None if the option is None, otherwise returns other.
Type Parameters
- U = T
Parameters
- other: Option<U>
Returns Option<U>
Implementation of SomeBase.and

andThen

andThen<U = T>(fn: (value: T) => Option<U>): Option<U>
Maps an Option<T> to Option<U> by applying a function to a contained value, if present. This is a no-op if the option is None.
Type Parameters
- U = T
Parameters
- fn: (value: T) => Option<U>
Returns Option<U>
Implementation of SomeBase.andThen

andThenAsync

andThenAsync<U = T>(fn: (value: T) => Promise<Option<U>>): Promise<Option<U>>
Maps an Option<T> to Promise<Option<U>> by applying a function to a contained value, if present. This is a no-op if the option is None.
Type Parameters
- U = T
Parameters
- fn: (value: T) => Promise<Option<U>>
Returns Promise<Option<U>>
Implementation of SomeBase.andThenAsync

equals

equals(other: Option<T>): boolean
Returns true if the current option is equivalent to other.
Parameters
- other: Option<T>
Returns boolean
Implementation of SomeBase.equals

expect

expect(message: string): T
Returns the option if it is a Some value, otherwise throws an error with the provided message.
Parameters
- message: string
Returns T
Implementation of SomeBase.expect

filter

filter(fn: (value: T) => boolean): Option<T>
Returns None if the option is None or the predicate fn returns false, otherwise returns the option.
Parameters
- fn: (value: T) => boolean
Returns Option<T>
Implementation of SomeBase.filter

inspect

inspect(fn: (value: T) => void): Option<T>
Calls fn if the option is a Some value. Useful for checking the contents of a Some while still being able to use it after in a chain.
Parameters
- fn: (value: T) => void
Returns Option<T>
Implementation of SomeBase.inspect

inspectNone

inspectNone(fn: () => void): Option<T>
Calls fn if the option is a None value. Useful for checking the contents of a None while still being able to use it after in a chain.
Parameters
- fn: () => void
Returns Option<T>
Implementation of SomeBase.inspectNone

isNone

isNone(): this is None
Returns true if the option is a None value.

Returns this is None
Implementation of SomeBase.isNone

isSome

isSome(): this is Some<T>
Returns true if the option is a Some value.

Returns this is Some<T>
Implementation of SomeBase.isSome

isSomeAnd

isSomeAnd(fn: (value: T) => boolean): this is Some<T>
Returns true if the option is a Some value and fn returns true for the contained value.
Parameters
- fn: (value: T) => boolean
Returns this is Some<T>
Implementation of SomeBase.isSomeAnd

iter

iter(): IterableIterator<T>
Returns an iterator over the possibly contained value.

Returns IterableIterator<T>
Implementation of SomeBase.iter

map

map<U = T>(fn: (value: T) => undefined | null | U): Option<U>
Maps an Option<T> to Option<U> by applying a function to a contained value, if present. This is a no-op if the option is None.
Type Parameters
- U = T
Parameters
- fn: (value: T) => undefined | null | U
Returns Option<U>
Implementation of SomeBase.map

mapAsync

mapAsync<U = T>(
fn: (value: T) => Promise<undefined | null | U>,
): Promise<Option<U>>
Maps an Option<T> to Promise<Option<U>> by applying a function to a contained value, if present. This is a no-op if the option is None.
Type Parameters
- U = T
Parameters
- fn: (value: T) => Promise<undefined | null | U>
Returns Promise<Option<U>>
Implementation of SomeBase.mapAsync

mapOr

mapOr<U = T>(fn: (value: T) => U, fallback: U): U
Maps an Option<T> to Option<U> by applying a function to a contained value, if present. Otherwise, returns U.
Type Parameters
- U = T
Parameters
- fn: (value: T) => U
- fallback: U
Returns U
Implementation of SomeBase.mapOr

mapOrAsync

mapOrAsync<U = T>(fn: (value: T) => Promise<U>, fallback: U): Promise<U>
Maps an Option<T> to Promise<U> by applying a function to a contained value, if present. Otherwise, returns U.
Type Parameters
- U = T
Parameters
- fn: (value: T) => Promise<U>
- fallback: U
Returns Promise<U>
Implementation of SomeBase.mapOrAsync

mapOrElse

mapOrElse<U = T>(fn: (value: T) => U, fallback: () => U): U
Maps an Option<T> to U by applying a function to a contained value, if present. Otherwise, calls the provided fallback function and returns the result.
Type Parameters
- U = T
Parameters
- fn: (value: T) => U
- fallback: () => U
Returns U
Implementation of SomeBase.mapOrElse

mapOrElseAsync

mapOrElseAsync<U = T>(
fn: (value: T) => Promise<U>,
fallback: () => Promise<U>,
): Promise<U>
Maps an Option<T> to Promise<U> by applying a function to a contained value, if present. Otherwise, calls the provided fallback function and returns the result.
Type Parameters
- U = T
Parameters
- fn: (value: T) => Promise<U>
- fallback: () => Promise<U>
Returns Promise<U>
Implementation of SomeBase.mapOrElseAsync

okOr

okOr<E>(error: E): Result<T, E>
Transforms the Option<T> into a Result<T, E>, mapping Some(v) to Ok(v) and None to Err(error).
Type Parameters
- E
Parameters
- error: E
Returns Result<T, E>
Implementation of SomeBase.okOr

okOrElse

okOrElse<E>(fn: () => E): Result<T, E>
Transforms the Option<T> into a Result<T, E>, mapping Some(v) to Ok(v) and None to Err(fn()).
Type Parameters
- E
Parameters
- fn: () => E
Returns Result<T, E>
Implementation of SomeBase.okOrElse

or

or<U = T>(other: Option<U>): Option<T | U>
Returns this option if it is Some, otherwise returns other.
Type Parameters
- U = T
Parameters
- other: Option<U>
Returns Option<T | U>
Implementation of SomeBase.or

orElse

orElse<U = T>(fn: () => Option<U>): Option<T | U>
Returns this option if it is Some, otherwise calls fn and returns the result.
Type Parameters
- U = T
Parameters
- fn: () => Option<U>
Returns Option<T | U>
Implementation of SomeBase.orElse

toString

toString(): string
Returns a string representation of the option for debugging purposes.

Returns string
Implementation of SomeBase.toString

unwrap

unwrap(): T
Unwraps the option, yielding the content of a Some.

USE THIS SPARINGLY! It is generally better to use unwrapOr or map to handle situations you may be temped to .unwrap() in.

Returns T
Throws
if the option is None.

Implementation of SomeBase.unwrap

unwrapOr

unwrapOr<V = T>(fallback: V): T | V
Unwraps the option, yielding the content of a Some, or returns fallback.
Type Parameters
- V = T
Parameters
- fallback: V
Returns T | V
Implementation of SomeBase.unwrapOr

unwrapOrElse

unwrapOrElse<V = T>(fn: () => V): T | V
Unwraps the option, yielding the content of a Some, or calls fn and returns the result.
Type Parameters
- V = T
Parameters
- fn: () => V
Returns T | V
Implementation of SomeBase.unwrapOrElse

xor

xor<U = T>(other: Option<U>): Option<T | U>
Returns Some if one or the other is Some, but not both. Otherwise, returns None.
Type Parameters
- U = T
Parameters
- other: Option<U>
Returns Option<T | U>
Implementation of SomeBase.xor

zip

zip<U>(other: Option<U>): Option<[T, U]>
Zips this with another option. If both are Some, returns a Some with a tuple of the two values. Otherwise, returns None.
Type Parameters
- U
Parameters
- other: Option<U>
Returns Option<[T, U]>
Implementation of SomeBase.zip

zipWith

zipWith<U, V>(other: Option<U>, fn: (a: T, b: U) => V): Option<V>
Zips this with another option, using the provided function to compute a new return value.If both are Some, returns a Some with the new value. Otherwise, returns None.
Type Parameters
- U
- V
Parameters
- other: Option<U>
- fn: (a: T, b: U) => V
Returns Option<V>
Implementation of SomeBase.zipWith