Class Option<A>

Used to represent an optional value

Type parameters

A

Hierarchy

Option
- Some
- None

Index

Properties

Accessors

isSome

Methods

Properties

Abstract asEither

asEither: Either<NoSuchValueException, A>

Converts an Option to an Either

Abstract isNone

isNone: boolean

Returns true if the instance is None

Accessors

isSome

get isSome(): boolean

- Defined in src/immutable/option.ts:13
Returns true if the instance is Some

Returns boolean

Methods

Abstract chain

chain<B>(ab: function): Option<B>

- Defined in src/immutable/option.ts:65
Flattens the Option type

Type parameters
- B
Parameters
- ab: function
  - - (A: A): Option<B>
    - Parameters
      - A: A
      Returns Option<B>
Returns Option<B>

Abstract fold

fold<S>(S: S, FN: function): S

- Defined in src/immutable/option.ts:72
Takes a seed S value and applies the FN if this is Some Returns the seed S if this is None

Type parameters
- S
Parameters
- S: S
- FN: function
  - - (r: A, s: S): S
    - Parameters
      - r: A
      - s: S
      Returns S
Returns S

Abstract getOrElse

getOrElse(A: A): A

- Defined in src/immutable/option.ts:78
Gets the real value if this is of Some type. If its not a Some type it returns the provided value.

Parameters
- A: A
Returns A

map

map<B>(ab: function): Option<B>

- Defined in src/immutable/option.ts:83
Transforms the value inside the Option type.

Type parameters
- B
Parameters
- ab: function
  - - (A: A): B
    - Parameters
      - A: A
      Returns B
Returns Option<B>

Static fromEither

fromEither<L, R>(either: Either<L, R>): Option<R>

- Defined in src/immutable/option.ts:20
Creates an Option from an Either

Type parameters
- L
- R
Parameters
- either: Either<L, R>
Returns Option<R>

Static isNone

isNone<A>(A: Option<A>): boolean

- Defined in src/immutable/option.ts:27
Checks if the Option type is of None type

Type parameters
- A
Parameters
- A: Option<A>
Returns boolean

Static isSome

isSome<A>(A: Option<A>): boolean

- Defined in src/immutable/option.ts:34
Checks if the Option type is of Some type

Type parameters
- A
Parameters
- A: Option<A>
Returns boolean

Static none

none(): Option<never>

- Defined in src/immutable/option.ts:41
Creates a None object

Returns Option<never>

Static some

some<A>(A: A): Option<A>

- Defined in src/immutable/option.ts:48
Creates a Some object

Type parameters
- A
Parameters
- A: A
Returns Option<A>

Generated using TypeDoc