Class Option<T>

Type parameters

T

Hierarchy

Option

Index

Constructors

constructor

Methods

Constructors

constructor

new Option<T>(createSecret: unknown, value: T): Option<T>

- Defined in option/Option.ts:33
Type parameters
- T
Parameters
- createSecret: unknown
- value: T
Returns Option<T>

Methods

and

and<U>(value: Option<U>): Option<U>

- Defined in option/Option.ts:123
Type parameters
- U
Parameters
- value: Option<U>
Returns Option<U>

andThen

andThen<U>(fn: (value: T) => Option<U>): Option<U>

- Defined in option/Option.ts:130
Type parameters
- U
Parameters
- fn: (value: T) => Option<U>
  - - (value: T): Option<U>
    - Parameters
      - value: T
      Returns Option<U>
Returns Option<U>

clear

clear(): Option<T>

- Defined in option/Option.ts:210
Returns Option<T>

expect

expect(msg: string | (() => string)): T

- Defined in option/Option.ts:50
Parameters
- msg: string | (() => string)
Returns T

filter

filter<S>(fn: (value: T) => value is S): Option<S>
filter(fn: (value: T) => boolean): Option<T>

- Defined in option/Option.ts:166
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/Option.ts:167
Parameters
- fn: (value: T) => boolean
  - - (value: T): boolean
    - Parameters
      - value: T
      Returns boolean
Returns Option<T>

flatMap

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

- Defined in option/Option.ts:98
Type parameters
- U
Parameters
- fn: (value: T) => Option<U>
  - - (value: T): Option<U>
    - Parameters
      - value: T
      Returns Option<U>
Returns Option<U>

flatMapOr

flatMapOr<U>(fn: (value: T) => Option<U>, def: Option<U>): Option<U>

- Defined in option/Option.ts:105
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>

flatMapOrElse

flatMapOrElse<U>(fn: (value: T) => Option<U>, defFn: () => Option<U>): Option<U>

- Defined in option/Option.ts:112
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>

from

from(value?: null | T): Option<T>

- Defined in option/Option.ts:198
Parameters
- Optional value: null | T
Returns Option<T>

fromJSON

fromJSON(json: null | T): Option<T>

- Defined in option/Option.ts:240
Parameters
- json: null | T
Returns Option<T>

fromResult

fromResult<T, E>(result: Result<T, E>): Option<T>

- Defined in option/Option.ts:215
Type parameters
- T
- E
Parameters
- result: Result<T, E>
Returns Option<T>

getOrInsert

getOrInsert(value: T): Option<T>

- Defined in option/Option.ts:176
Parameters
- value: T
Returns Option<T>

getOrInsertWith

getOrInsertWith(fn: () => T): Option<T>

- Defined in option/Option.ts:182
Parameters
- fn: () => T
  - - (): T
    - Returns T
Returns Option<T>

ifNone

ifNone(fn: () => void, elseFn?: (value: T) => void): Option<T>

- Defined in option/Option.ts:231
Parameters
- fn: () => void
  - - (): void
    - Returns void
- Optional elseFn: (value: T) => void
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
Returns Option<T>

ifSome

ifSome(fn: (value: T) => void, elseFn?: () => void): Option<T>

- Defined in option/Option.ts:223
Parameters
- fn: (value: T) => void
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
- Optional elseFn: () => void
  - - (): void
    - Returns void
Returns Option<T>

isNone

isNone(): boolean

- Defined in option/Option.ts:42
Returns boolean

isSome

isSome(): boolean

- Defined in option/Option.ts:46
Returns boolean

map

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

- Defined in option/Option.ts:76
Type parameters
- U
Parameters
- fn: (value: T) => U
  - - (value: T): U
    - Parameters
      - value: T
      Returns U
Returns Option<U>

mapOr

mapOr<U>(fn: (value: T) => U, def: U): Option<U>

- Defined in option/Option.ts:83
Type parameters
- U
Parameters
- fn: (value: T) => U
  - - (value: T): U
    - Parameters
      - value: T
      Returns U
- def: U
Returns Option<U>

mapOrElse

mapOrElse<U>(fn: (value: T) => U, defFn: () => U): Option<U>

- Defined in option/Option.ts:90
Type parameters
- U
Parameters
- fn: (value: T) => U
  - - (value: T): U
    - Parameters
      - value: T
      Returns U
- defFn: () => U
  - - (): U
    - Returns U
Returns Option<U>

or

or(value: Option<T>): Option<T>

- Defined in option/Option.ts:138
Parameters
- value: Option<T>
Returns Option<T>

orElse

orElse(fn: () => Option<T>): Option<T>

- Defined in option/Option.ts:145
Parameters
- fn: () => Option<T>
  - - (): Option<T>
    - Returns Option<T>
Returns Option<T>

replace

replace(value: T): Option<T>

- Defined in option/Option.ts:206
Parameters
- value: T
Returns Option<T>

take

take(): Option<T>

- Defined in option/Option.ts:189
Returns Option<T>

toJS

toJS(): null | T

- Defined in option/Option.ts:246
Returns null | T

toJSON

toJSON(): null | T

- Defined in option/Option.ts:243
Returns null | T

unwrap

unwrap(): T

- Defined in option/Option.ts:58
Returns T

unwrapOr

unwrapOr(def: T): T

- Defined in option/Option.ts:61
Parameters
- def: T
Returns T

unwrapOrElse

unwrapOrElse(defFn: () => T): T

- Defined in option/Option.ts:68
Parameters
- defFn: () => T
  - - (): T
    - Returns T
Returns T

xor

xor(value: Option<T>): Option<T>

- Defined in option/Option.ts:153
Parameters
- value: Option<T>
Returns Option<T>

Static from

from<T>(value?: null | T): Option<T>

- Defined in option/Option.ts:16
Type parameters
- T
Parameters
- Optional value: null | T
Returns Option<T>

Static fromResult

fromResult<T, E>(result: Result<T, E>): Option<T>

- Defined in option/Option.ts:23
Type parameters
- T
- E = Error
Parameters
- result: Result<T, E>
Returns Option<T>

Static none

none<T>(): Option<T>

- Defined in option/Option.ts:12
Type parameters
- T
Returns Option<T>

Static some

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

- Defined in option/Option.ts:9
Type parameters
- T
Parameters
- value: T
Returns Option<T>

Generated using TypeDoc