Class Option<T>

Type Parameters

T = unknown

Hierarchy

Option

Index

Properties

Methods

contains expect isNone isSome map mapOr mapOrElse unwrap unwrapOr unwrapOrElse

Properties

_value

_value: undefined | T

Methods

contains

contains(value: defined): boolean
Parameters
- value: defined
Returns boolean
- Defined in src/modules/Option.ts:28

expect

expect(msg: string, level?: number): T
Parameters
- msg: string
- Optional level: number
Returns T
- Defined in src/modules/Option.ts:32

isNone

isNone(): boolean
Returns boolean
- Defined in src/modules/Option.ts:20

isSome

isSome(): boolean
Returns boolean
- Defined in src/modules/Option.ts:24

map

map<U>(func: ((value: T) => U)): Option<U>
Type Parameters
- U
Parameters
- func: ((value: T) => U)
  - - (value: T): U
    - Parameters
      
      value: T
      
      Returns U
Returns Option<U>
- Defined in src/modules/Option.ts:66

mapOr

mapOr<U>(def: U, func: ((value: T) => U)): U
Type Parameters
- U
Parameters
- def: U
- func: ((value: T) => U)
  - - (value: T): U
    - Parameters
      
      value: T
      
      Returns U
Returns U
- Defined in src/modules/Option.ts:70

mapOrElse

mapOrElse<U>(def: (() => U), func: ((value: T) => U)): U
Type Parameters
- U
Parameters
- def: (() => U)
  - - (): U
    - Returns U
- func: ((value: T) => U)
  - - (value: T): U
    - Parameters
      
      value: T
      
      Returns U
Returns U
- Defined in src/modules/Option.ts:82

unwrap

unwrap(): T
Returns T
- Defined in src/modules/Option.ts:46

unwrapOr

unwrapOr(def: T): T
Parameters
- def: T
Returns T
- Defined in src/modules/Option.ts:50

unwrapOrElse

unwrapOrElse(func: (() => T)): T
Parameters
- func: (() => T)
  - - (): T
    - Returns T
Returns T
- Defined in src/modules/Option.ts:58

Generated using TypeDoc