Class Optional<T>

Type parameters

T

Hierarchy

Optional

Index

Constructors

constructor

Properties

value

Accessors

hasValue

Methods

Constructors

Private constructor

new Optional(value: T | None): Optional

- Defined in lib/optional.ts:3
Parameters
- value: T | None
Returns Optional

Properties

Private Readonly value

value: T | None

Accessors

hasValue

get hasValue(): boolean

- Defined in lib/optional.ts:111
A property to determine if the wrapped value has a value.

Returns boolean

Methods

apply

apply(fn: (value: T) => void): Optional<T>

- Defined in lib/optional.ts:73
Apply a function if the wrapped value is not none.

Parameters
- fn: (value: T) => void
  
  Callback function.
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
Returns Optional<T>

Same Optional instance.

filter

filter(predicate: (value: T) => boolean): Optional<T>

- Defined in lib/optional.ts:86
Filter on an Optional.

Parameters
- predicate: (value: T) => boolean
  
  Predicate function which determines if returned value should return this or none.
  - - (value: T): boolean
    - Parameters
      - value: T
      Returns boolean
Returns Optional<T>

Same instance or none.

flatMap

flatMap<U>(fn: (value: T) => Optional<U>): Optional<U>

- Defined in lib/optional.ts:61
Flatten a nested Optional.

Type parameters
- U
Parameters
- fn: (value: T) => Optional<U>
  
  Flattening function that returns a new Optional.
  - - (value: T): Optional<U>
    - Parameters
      - value: T
      Returns Optional<U>
Returns Optional<U>

New Optional<U> value.

get

get(): T | None

- Defined in lib/optional.ts:40
Get the wrapped optional value.

Returns T | None

Wrapped value.

getOrElse

getOrElse(fn: () => NonNullable<T>): T

- Defined in lib/optional.ts:100
Run a callback function if wrapped value is none to give back a non none value.

typeparam

A non nullable type.

Parameters
- fn: () => NonNullable<T>
  
  Callback function.
  - - (): NonNullable<T>
    - Returns NonNullable<T>
Returns T

Same instance.

Private isNone

isNone(): boolean

- Defined in lib/optional.ts:115
Returns boolean

map

map<U>(fn: (value: T) => U): Optional<U>

- Defined in lib/optional.ts:49
Transform wrapped value.

Type parameters
- U
Parameters
- fn: (value: T) => U
  
  Transforming function.
  - - (value: T): U
    - Parameters
      - value: T
      Returns U
Returns Optional<U>

Optional with new wrapped value type.

Static none

none<T>(): Optional<T>

- Defined in lib/optional.ts:10
Create an Optional instance with a wrapped none value.

Type parameters
- T
Returns Optional<T>

Optional with none wrapped value.

Static of

of<T>(value: T | None): Optional<T>

- Defined in lib/optional.ts:29
Create an Optional instance from provided value. This method will determine if the provided value is some or none.

Type parameters
- T
Parameters
- value: T | None
Returns Optional<T>

Optional with either some or none wrapped value.

Static some

some<T>(value: T): Optional<T>

- Defined in lib/optional.ts:19
Create an Optional instance with a provided value.

Type parameters
- T
Parameters
- value: T
Returns Optional<T>

Optional with some wrapped value.

Generated using TypeDoc