Class Either<L1, R1>

A data structure that represents Success/Failure & optional types

Type parameters

L1

Represents Left case that can be used to depict failures.
R1

Represents Right case that can be used to depict success.

Hierarchy

Either
- Left
- Right

Index

Accessors

asOption

Methods

Accessors

asOption

get asOption(): Option<R1>

- Defined in src/immutable/either.ts:20
Converts an Either to an Option

Returns Option<R1>

Methods

Abstract biChain

biChain<L2, R2>(LL: function, RR: function): Either<L2, R2>

- Defined in src/immutable/either.ts:76
Like Either.map it uses the left function to chain over object of Left type and the right function to chain over an object of Right type.

Type parameters
- L2
- R2
Parameters
- LL: function
  - - (l: L1): Either<L2, R2>
    - Parameters
      - l: L1
      Returns Either<L2, R2>
- RR: function
  - - (r: R1): Either<L2, R2>
    - Parameters
      - r: R1
      Returns Either<L2, R2>
Returns Either<L2, R2>

biMap

biMap<L2, R2>(LL: function, RR: function): Either<L2, R2>

- Defined in src/immutable/either.ts:85
It uses the left function to chain over object of Left type and the right function to chain over an object of Right type.

Type parameters
- L2
- R2
Parameters
- LL: function
  - - (l: L1): L2
    - Parameters
      - l: L1
      Returns L2
- RR: function
  - - (r: R1): R2
    - Parameters
      - r: R1
      Returns R2
Returns Either<L2, R2>

chain

chain<R2>(ab: function): Either<L1, R2>

- Defined in src/immutable/either.ts:92
Alias for Either.chainR

Type parameters
- R2
Parameters
- ab: function
  - - (r: R1): Either<L1, R2>
    - Parameters
      - r: R1
      Returns Either<L1, R2>
Returns Either<L1, R2>

chainL

chainL<L2>(ab: function): Either<L2, R1>

- Defined in src/immutable/either.ts:99
Sequentially converts a Left type to another Left type.

Type parameters
- L2
Parameters
- ab: function
  - - (l: L1): Either<L2, R1>
    - Parameters
      - l: L1
      Returns Either<L2, R1>
Returns Either<L2, R1>

chainR

chainR<R2>(ab: function): Either<L1, R2>

- Defined in src/immutable/either.ts:106
Sequentially converts a Right type to another Right type.

Type parameters
- R2
Parameters
- ab: function
  - - (r: R1): Either<L1, R2>
    - Parameters
      - r: R1
      Returns Either<L1, R2>
Returns Either<L1, R2>

Abstract fold

fold<S>(seed: S, LL: function, RR: function): S

- Defined in src/immutable/either.ts:113
Reduces an Either to a value of type S by providing a seed value

Type parameters
- S
Parameters
- seed: S
- LL: function
  - - (l: L1, s: S): S
    - Parameters
      - l: L1
      - s: S
      Returns S
- RR: function
  - - (r: R1, s: S): S
    - Parameters
      - r: R1
      - s: S
      Returns S
Returns S

Abstract getLeftOrElse

getLeftOrElse(left: L1): L1

- Defined in src/immutable/either.ts:122
Gets the left value if available or else returns the provided default value

Parameters
- left: L1
Returns L1

Abstract getRightOrElse

getRightOrElse(right: R1): R1

- Defined in src/immutable/either.ts:127
Gets the right value if available or else returns the provided default value

Parameters
- right: R1
Returns R1

map

map<R2>(ab: function): Either<L1, R2>

- Defined in src/immutable/either.ts:132
Alias for Either.mapR

Type parameters
- R2
Parameters
- ab: function
  - - (r: R1): R2
    - Parameters
      - r: R1
      Returns R2
Returns Either<L1, R2>

mapL

mapL<L2>(ab: function): Either<L2, R1>

- Defined in src/immutable/either.ts:139
Transforms the left value

Type parameters
- L2
Parameters
- ab: function
  - - (r: L1): L2
    - Parameters
      - r: L1
      Returns L2
Returns Either<L2, R1>

mapR

mapR<R2>(ab: function): Either<L1, R2>

- Defined in src/immutable/either.ts:146
Transforms the right value

Type parameters
- R2
Parameters
- ab: function
  - - (r: R1): R2
    - Parameters
      - r: R1
      Returns R2
Returns Either<L1, R2>

Abstract reduce

reduce<S>(LL: function, RR: function): S

- Defined in src/immutable/either.ts:154
Reduces an Either to a value of type S by providing a seed value

Type parameters
- S
Parameters
- LL: function
  - - (l: L1): S
    - Parameters
      - l: L1
      Returns S
- RR: function
  - - (r: R1): S
    - Parameters
      - r: R1
      Returns S
Returns S

Static fromOption

fromOption<R>(option: Option<R>): Either<NoSuchValueException, R>

- Defined in src/immutable/either.ts:26
Creates an Either from Option

Type parameters
- R
Parameters
- option: Option<R>
Returns Either<NoSuchValueException, R>

Static isLeft

isLeft<L1, R1>(either: Either<L1, R1>): boolean

- Defined in src/immutable/either.ts:35
Returns true if the either is of Left type.

Type parameters
- L1
- R1
Parameters
- either: Either<L1, R1>
Returns boolean

Static isRight

isRight<L1, R1>(either: Either<L1, R1>): boolean

- Defined in src/immutable/either.ts:42
Returns true if the either is of Right type.

Type parameters
- L1
- R1
Parameters
- either: Either<L1, R1>
Returns boolean

Static left

left<L>(left: L): Either<L, never>

- Defined in src/immutable/either.ts:49
Creates an object of Left type.

Type parameters
- L
Parameters
- left: L
Returns Either<L, never>

Static right

right<R>(right: R): Either<never, R>

- Defined in src/immutable/either.ts:56
Creates an object of Right type.

Type parameters
- R
Parameters
- right: R
Returns Either<never, R>

Static try

try<E1, A1>(cb: function): Either<E1, A1>

- Defined in src/immutable/either.ts:63
Creates a new Either type from a function that could fail with an error.

Type parameters
- E1
- A1
Parameters
- cb: function
  - - (): A1
    - Returns A1
Returns Either<E1, A1>

Generated using TypeDoc