Some

A type that represents the presence of a value.

This type is not intended to be used or instantiated directly. Instead, Some instances can be created with Optional.some and can then be manipulated with any method available on Optional.

Please see the Optional documentation for more information.

Note:

All Some methods are documented at the Optional level.

Type parameters

T

The type of the value contained in this Some instance.

Hierarchy

Optional<T>
- Some

Index

Methods

and

and(other: Optional): Optional

Overrides Optional.and
- Defined in Optional.ts:614
Type parameters
- U
Parameters
- other: Optional
Returns Optional

ap

ap(func: Optional<function>): Optional

Overrides Optional.ap
- Defined in Optional.ts:630
Type parameters
- U
Parameters
- func: Optional<function>
Returns Optional

filter

filter(condition: function): Optional<T>

Overrides Optional.filter
- Defined in Optional.ts:638
Parameters
- condition: function
 - - (val: T): boolean
 - Parameters
 - val: T
 Returns boolean
Returns Optional<T>

flatMap

flatMap(func: function): Optional

Overrides Optional.flatMap
- Defined in Optional.ts:618
Type parameters
- U
Parameters
- func: function
 - - (val: T): Optional
 - Parameters
 - val: T
 Returns Optional
Returns Optional

forEach

forEach(func: function): void

Overrides Optional.forEach
- Defined in Optional.ts:645
Parameters
- func: function
  - - (val: any): void
    - Parameters
      - val: any
      Returns void
Returns void

forceUnwrap

forceUnwrap(message?: undefined | string): T

Overrides Optional.forceUnwrap
- Defined in Optional.ts:594
Parameters
- Optional message: undefined | string
Returns T

isNone

isNone(): boolean

Overrides Optional.isNone
- Defined in Optional.ts:582
Returns boolean

isSome

isSome(): boolean

Overrides Optional.isSome
- Defined in Optional.ts:578
Returns boolean

map

map(func: function): Optional

Overrides Optional.map
- Defined in Optional.ts:610
Type parameters
- U
Parameters
- func: function
 - - (val: T): U
 - Parameters
 - val: T
 Returns U
Returns Optional

match

match<U, V>(options: OptMatch<T, U, V>): U | V

Overrides Optional.match
- Defined in Optional.ts:634
Type parameters
- U
- V
Parameters
- options: OptMatch<T, U, V>
Returns U | V

or

or(other: Optional<T>): Optional<T>

Overrides Optional.or
- Defined in Optional.ts:622
Parameters
- other: Optional<T>
Returns Optional<T>

orElse

orElse(func: function): Optional<T>

Overrides Optional.orElse
- Defined in Optional.ts:626
Parameters
- func: function
 - - (): Optional<T>
 - Returns Optional<T>
Returns Optional<T>

toArray

toArray(): Array<T>

Overrides Optional.toArray
- Defined in Optional.ts:649
Returns Array<T>

toString

toString(): string

Overrides Optional.toString
- Defined in Optional.ts:586
Returns string

unwrap

unwrap(message?: undefined | string): T

Overrides Optional.unwrap
- Defined in Optional.ts:590
Parameters
- Optional message: undefined | string
Returns T

unwrapOr

unwrapOr(other: T | function): T

Overrides Optional.unwrapOr
- Defined in Optional.ts:602
Parameters
- other: T | function
Returns T

unwrapOrElse

unwrapOrElse(func: function): T

Overrides Optional.unwrapOrElse
- Defined in Optional.ts:606
Parameters
- func: function
  - - (): T
    - Returns T
Returns T

Static fromNullable

fromNullable<A>(value?: A): Optional<A>

Inherited from Optional.fromNullable
- Defined in Optional.ts:104
Creates an Optional with the given value. If null or undefined is provided a None will be returned, otherwise a Some containing the given value will be returned.
```
const one = Optional.fromNullable(1); // one.unwrapOr(0) === 1
const none = Optional.fromNullable(null); // none.unwrapOr(0) === 0
const nope = Optional.fromNullable(); // nope.unwrapOr(0) === 0
```
Type parameters
- A
 
 The type of the value that the new Optional will contain.
Parameters
- Optional value: A
 
 The value to create an Optional with.
Returns Optional<A>

Either a Some or a None depending on the value provided.

Static none

none(): Optional<any>

Inherited from Optional.none
- Defined in Optional.ts:86
Creates a None.
```
const nope = Optional.none();
// nope.unwrapOr(0) === 0
```
Returns Optional<any>

A None instance.

Static of

of<A>(value: A): Optional<A>

Inherited from Optional.of
- Defined in Optional.ts:56
Creates an Some with the given value.
```
const one = Optional.of(1);
// one.unwrapOr(0) === 1
```
Type parameters
- A
 
 The type of the value that the new Some will contain.
Parameters
- value: A
 
 A value to create a Some with.
Returns Optional<A>

A Some instance containing value.

Static some

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

Inherited from Optional.some
- Defined in Optional.ts:72
Creates a Some with the given value.
```
const one = Optional.some(1);
// one.unwrapOr(0) === 1
```
Type parameters
- A
 
 The type of the value that the new Some will contain.
Parameters
- value: A
 
 A value to create a Some with.
Returns Optional<A>

A Some instance containing value.

Generated using TypeDoc

Some

Note:

Type parameters

T

Hierarchy

Index

Methods

Methods

and

Type parameters

U

Parameters

other: Optional<U>

Returns Optional<U>

ap

Type parameters

U

Parameters

func: Optional<function>

Returns Optional<U>

filter

Parameters

condition: function

Parameters

val: T

Returns boolean

Returns Optional<T>

flatMap

Type parameters

U

Parameters

func: function

Parameters

val: T

Returns Optional<U>

Returns Optional<U>

forEach

Parameters

func: function

Parameters

val: any

Returns void

Returns void

forceUnwrap

Parameters

Optional message: undefined | string

Returns T

isNone

Returns boolean

isSome

Returns boolean

map

Type parameters

U

Parameters

func: function

Parameters

val: T

Returns U

Returns Optional<U>

match

Type parameters

U

V

Parameters

options: OptMatch<T, U, V>

Returns U | V

or

Parameters

other: Optional<T>

Returns Optional<T>

orElse

Parameters

func: function

Returns Optional<T>

Returns Optional<T>

toArray

Returns Array<T>

toString

Returns string