Class Some<T>

Represents a value that is present (Some<T>).

Type Parameters

T
The type of the contained value.

Hierarchy (view full)

Option<T>
- Some

Index

Constructors

Methods

filter flatMap fold getOrElse isNone isSome map orElse from

Constructors

constructor

new Some<T>(value): Some<T>
Creates an instance of Some<T> with a valid value.
Type Parameters
- T
Parameters
- value: T
  The contained value.
Returns Some<T>
Overrides Option.constructor
- Defined in functional/monads/Option.ts:96

Methods

filter

filter(predicate): Option<T>
Returns Some<T> if the predicate is met, otherwise returns None.
Parameters
- predicate: ((value: T) => boolean)
  A condition to check.
  - - (value): boolean
    - Parameters
      value: T
      Returns boolean
Returns Option<T>
- Some<T> if condition is met, otherwise None.
Overrides Option.filter
- Defined in functional/monads/Option.ts:180

flatMap

flatMap<U>(fn): Option<U>
Transforms the contained value using a function that returns an Option<U>.
Type Parameters
- U
  The return type wrapped in an Option<U>.
Parameters
- fn: ((value: T) => Option<U>)
  The transformation function.
  - - (value): Option<U>
    - Parameters
      value: T
      Returns Option<U>
Returns Option<U>
- The result of applying fn.
Overrides Option.flatMap
- Defined in functional/monads/Option.ts:136

fold

fold<U>(_ifNone, ifSome): U
Executes the ifSome function with the contained value.
Type Parameters
- U
  The return type.
Parameters
- _ifNone: (() => U)
  (Unused) Function to call if None.
  - - (): U
    - Returns U
- ifSome: ((value: T) => U)
  Function to call with the value if Some<T>.
  - - (value): U
    - Parameters
      value: T
      Returns U
Returns U
- The result of calling ifSome.
Overrides Option.fold
- Defined in functional/monads/Option.ts:170

getOrElse

getOrElse(_defaultValue): T
Retrieves the contained value, ignoring the provided default.
Parameters
- _defaultValue: T
  (Unused) A fallback value.
Returns T
- The contained value.
Overrides Option.getOrElse
- Defined in functional/monads/Option.ts:147

isNone

isNone(): boolean
Checks if this is None, meaning no value is present.

Returns boolean
- Always returns false for Some<T>.
Overrides Option.isNone
- Defined in functional/monads/Option.ts:114

isSome

isSome(): boolean
Checks if this is a Some<T>, meaning it contains a valid value.

Returns boolean
- Always returns true for Some<T>.
Overrides Option.isSome
- Defined in functional/monads/Option.ts:105

map

map<U>(fn): Option<U>
Transforms the contained value using the provided function.
Type Parameters
- U
  The return type after transformation.
Parameters
- fn: ((value: T) => U)
  The transformation function.
  - - (value): U
    - Parameters
      value: T
      Returns U
Returns Option<U>
- A Some<U> containing the transformed value.
Overrides Option.map
- Defined in functional/monads/Option.ts:125

orElse

orElse(_alternative): Option<T>
Returns the current Some<T>, ignoring the provided alternative.
Parameters
- _alternative: Option<T>
  (Unused) An alternative Option<T>.
Returns Option<T>
- The same Some<T>.
Overrides Option.orElse
- Defined in functional/monads/Option.ts:158

`Static`from

from<T>(value): Option<T>
Creates an instance of Some<T> if a value is present, otherwise returns None.
Type Parameters
- T
Parameters
- value: T
  The value to wrap.
Returns Option<T>
- Some<T> if valid, otherwise None.
Inherited from Option.from
- Defined in functional/monads/Option.ts:14