Class Option<T>

Type Parameters

T

Hierarchy

Option

Implements

Iterable<T>

Index

Constructors

Constructors

constructor

new Option<T>(createSecret: unknown, value: unknown): Option<T>
Type Parameters
- T
Parameters
- createSecret: unknown
- value: unknown
Returns Option<T>
- Defined in Option.ts:29

Methods

[iterator]

[iterator](): OptionIterator<T>
Returns OptionIterator<T>
Implementation of Iterable.__@iterator@87
- Defined in Option.ts:235

and

and<U>(value: Option<U>): Option<U>
Type Parameters
- U
Parameters
- value: Option<U>
Returns Option<U>
- Defined in Option.ts:119

andThen

andThen<U>(fn: ((value: T) => Option<U>)): Option<U>
Type Parameters
- U
Parameters
- fn: ((value: T) => Option<U>)
  - - (value: T): Option<U>
    - Parameters
      
      value: T
      
      Returns Option<U>
Returns Option<U>
- Defined in Option.ts:126

clear

clear(): Option<T>
Returns Option<T>
- Defined in Option.ts:185

expect

expect(msg: string | (() => string)): T
Parameters
- msg: string | (() => string)
Returns T
- Defined in Option.ts:46

filter

filter<S>(fn: ((value: T) => value is S)): Option<S>
Type Parameters
- S
Parameters
- fn: ((value: T) => value is S)
  - - (value: T): value is S
    - Parameters
      
      value: T
      
      Returns value is S
Returns Option<S>
- Defined in Option.ts:162
filter(fn: ((value: T) => boolean)): Option<T>
Parameters
- fn: ((value: T) => boolean)
  - - (value: T): boolean
    - Parameters
      
      value: T
      
      Returns boolean
Returns Option<T>
- Defined in Option.ts:163

flatMap

flatMap<U>(fn: ((value: T) => Option<U>)): Option<U>
Type Parameters
- U
Parameters
- fn: ((value: T) => Option<U>)
  - - (value: T): Option<U>
    - Parameters
      
      value: T
      
      Returns Option<U>
Returns Option<U>
- Defined in Option.ts:94

flatMapOr

flatMapOr<U>(fn: ((value: T) => Option<U>), def: Option<U>): Option<U>
Type Parameters
- U
Parameters
- fn: ((value: T) => Option<U>)
  - - (value: T): Option<U>
    - Parameters
      
      value: T
      
      Returns Option<U>
- def: Option<U>
Returns Option<U>
- Defined in Option.ts:101

flatMapOrElse

flatMapOrElse<U>(fn: ((value: T) => Option<U>), defFn: (() => Option<U>)): Option<U>
Type Parameters
- U
Parameters
- fn: ((value: T) => Option<U>)
  - - (value: T): Option<U>
    - Parameters
      
      value: T
      
      Returns Option<U>
- defFn: (() => Option<U>)
  - - (): Option<U>
    - Returns Option<U>
Returns Option<U>
- Defined in Option.ts:108

from

from(value?: null | T): Option<T>
Parameters
- Optional value: null | T
Returns Option<T>
- Defined in Option.ts:198

getOrInsert

getOrInsert(value: T): Option<T>
Parameters
- value: T
Returns Option<T>
- Defined in Option.ts:172

getOrInsertWith

getOrInsertWith(fn: (() => T)): Option<T>
Parameters
- fn: (() => T)
  - - (): T
    - Returns T
Returns Option<T>
- Defined in Option.ts:178

ifNone

ifNone(fn: (() => void), elseFn?: ((value: T) => void)): Option<T>
Parameters
- fn: (() => void)
  - - (): void
    - Returns void
- Optional elseFn: ((value: T) => void)
  - - (value: T): void
    - Parameters
      
      value: T
      
      Returns void
Returns Option<T>
- Defined in Option.ts:219

ifSome

ifSome(fn: ((value: T) => void), elseFn?: (() => void)): Option<T>
Parameters
- fn: ((value: T) => void)
  - - (value: T): void
    - Parameters
      
      value: T
      
      Returns void
- Optional elseFn: (() => void)
  - - (): void
    - Returns void
Returns Option<T>
- Defined in Option.ts:211

isNone

isNone(): boolean
Returns boolean
- Defined in Option.ts:38

isSome

isSome(): boolean
Returns boolean
- Defined in Option.ts:42

map

map<U>(fn: ((value: T) => U)): Option<U>
Type Parameters
- U
Parameters
- fn: ((value: T) => U)
  - - (value: T): U
    - Parameters
      
      value: T
      
      Returns U
Returns Option<U>
- Defined in Option.ts:72

mapOr

mapOr<U>(fn: ((value: T) => U), def: U): Option<U>
Type Parameters
- U
Parameters
- fn: ((value: T) => U)
  - - (value: T): U
    - Parameters
      
      value: T
      
      Returns U
- def: U
Returns Option<U>
- Defined in Option.ts:79

mapOrElse

mapOrElse<U>(fn: ((value: T) => U), defFn: (() => U)): Option<U>
Type Parameters
- U
Parameters
- fn: ((value: T) => U)
  - - (value: T): U
    - Parameters
      
      value: T
      
      Returns U
- defFn: (() => U)
  - - (): U
    - Returns U
Returns Option<U>
- Defined in Option.ts:86

or

or(value: Option<T>): Option<T>
Parameters
- value: Option<T>
Returns Option<T>
- Defined in Option.ts:134

orElse

orElse(fn: (() => Option<T>)): Option<T>
Parameters
- fn: (() => Option<T>)
  - - (): Option<T>
    - Returns Option<T>
Returns Option<T>
- Defined in Option.ts:141

replace

replace(value: T): Option<T>
Parameters
- value: T
Returns Option<T>
- Defined in Option.ts:206

take

take(): Option<T>
Returns Option<T>
- Defined in Option.ts:189

toJS

toJS(): null | T
Returns null | T
- Defined in Option.ts:231

toJSON

toJSON(): null | T
Returns null | T
- Defined in Option.ts:228

unwrap

unwrap(): T
Returns T
- Defined in Option.ts:54

unwrapOr

unwrapOr(def: T): T
Parameters
- def: T
Returns T
- Defined in Option.ts:57

unwrapOrElse

unwrapOrElse(defFn: (() => T)): T
Parameters
- defFn: (() => T)
  - - (): T
    - Returns T
Returns T
- Defined in Option.ts:64

xor

xor(value: Option<T>): Option<T>
Parameters
- value: Option<T>
Returns Option<T>
- Defined in Option.ts:149

`Static` from

from<T>(value?: null | T): Option<T>
Type Parameters
- T
Parameters
- Optional value: null | T
Returns Option<T>
- Defined in Option.ts:15

`Static` fromJSON

fromJSON<T>(json: null | T): Option<T>
Type Parameters
- T
Parameters
- json: null | T
Returns Option<T>
- Defined in Option.ts:23

`Static` none

none<T>(): Option<T>
Type Parameters
- T
Returns Option<T>
- Defined in Option.ts:11

`Static` some

some<T>(value: T): Option<T>
Type Parameters
- T
Parameters
- value: T
Returns Option<T>
- Defined in Option.ts:8

Generated using TypeDoc