Class Either<L, R>

A class to represent something that can be one value or the other.

Type parameters

L
R

Hierarchy

Either

Implements

Monad<R>
Eq<Either<L, R>>

Index

Methods

Methods

apply

apply<B>(m: Either<L, function>): Either<L, B>

- Defined in Either.ts:65
Type parameters
- B
Parameters
- m: Either<L, function>
Returns Either<L, B>

equals

equals(m: Either<L, R>): boolean

- Defined in Either.ts:72
Parameters
- m: Either<L, R>
Returns boolean

fmap

fmap<B>(func: function): Either<L, B>

- Defined in Either.ts:56
Type parameters
- B
Parameters
- func: function
  - - (r: R): Either<L, B>
    - Parameters
      - r: R
      Returns Either<L, B>
Returns Either<L, B>

getOr

getOr(r: R): R

- Defined in Either.ts:76
Parameters
- r: R
Returns R

isLeft

isLeft(): boolean

- Defined in Either.ts:52
Returns boolean

isRight

isRight(): boolean

- Defined in Either.ts:54
Returns boolean

map

map<B>(func: function): Either<L, B>

- Defined in Either.ts:63
Lifts functions into the Either type.

Type parameters
- B
Parameters
- func: function
  - - (r: R): B
    - Parameters
      - r: R
      Returns B
Returns Either<L, B>

Static Left

Left<L, R>(l: L): Either<L, R>

- Defined in Either.ts:36
Type parameters
- L
- R
Parameters
- l: L
Returns Either<L, R>

Static Right

Right<L, R>(r: R): Either<L, R>

- Defined in Either.ts:38
Type parameters
- L
- R
Parameters
- r: R
Returns Either<L, R>

Static fromMaybe

fromMaybe<L, R>(l: L, m: Maybe<R>): Either<L, R>

- Defined in Either.ts:44
If the value is Just something, turn it into a Right. If the value is Nothing, use the provided default as a Left.

Type parameters
- L
- R
Parameters
- l: L
- m: Maybe<R>
Returns Either<L, R>

Static fromNullable

fromNullable<L, R>(l: L, r?: R): Either<L, R>

- Defined in Either.ts:48
Type parameters
- L
- R
Parameters
- l: L
- Optional r: R
Returns Either<L, R>

Generated using TypeDoc