Class Left<L1>

Data structure that represents a left value

Type parameters

L1

Hierarchy

Either<L1, never>
- Left

Index

Constructors

constructor

Properties

value

Accessors

asOption

Methods

Constructors

constructor

new Left(value: L1): Left

- Defined in src/immutable/either.ts:160
Parameters
- value: L1
Returns Left

Properties

value

value: L1

Accessors

asOption

get asOption(): Option<never>

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

Returns Option<never>

Methods

biChain

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

Overrides Either.biChain
- Defined in src/immutable/either.ts:168
Refer Either.biChain

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

biMap

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

Inherited from Either.biMap
- 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: never): R2
    - Parameters
      - r: never
      Returns R2
Returns Either<L2, R2>

chain

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

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

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

chainL

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

Inherited from Either.chainL
- 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, never>
    - Parameters
      - l: L1
      Returns Either<L2, never>
Returns Either<L2, never>

chainR

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

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

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

fold

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

Overrides Either.fold
- Defined in src/immutable/either.ts:178
Refer Either.fold

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

getLeftOrElse

getLeftOrElse(left: L1): L1

Overrides Either.getLeftOrElse
- Defined in src/immutable/either.ts:185
Refer Either.getLeftOrElse

Parameters
- left: L1
Returns L1

getRightOrElse

getRightOrElse(right: never): never

Overrides Either.getRightOrElse
- Defined in src/immutable/either.ts:192
Refer Either.getRightOrElse

Parameters
- right: never
Returns never

map

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

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

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

mapL

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

Inherited from Either.mapL
- 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, never>

mapR

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

Inherited from Either.mapR
- Defined in src/immutable/either.ts:146
Transforms the right value

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

reduce

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

Overrides Either.reduce
- Defined in src/immutable/either.ts:199
Refer Either.reduce

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

Static fromOption

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

Inherited from Either.fromOption
- 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

Inherited from Either.isLeft
- 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

Inherited from Either.isRight
- 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>

Inherited from Either.left
- 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>

Inherited from Either.right
- 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>

Inherited from Either.try
- 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