Interface Either<L, R>

Type Parameters

L
R

Hierarchy

Iterable<R>
Monad<R>
- Either

Index

Properties

Methods

[iterator] apply applyTo bimap flatMap flatMapLeft fold forEach forEachLeft left map mapLeft right swap

Properties

`Readonly` isLeft

isLeft: boolean

`Readonly` isRight

isRight: boolean

Methods

[iterator]

[iterator](): Iterator<R, any, undefined>
Returns Iterator<R, any, undefined>
Inherited from Iterable.__@iterator@1150
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:51

apply

apply<T>(func: Either<L, Func<[value: R], T>>): Either<L, T>
Type Parameters
- T
Parameters
- func: Either<L, Func<[value: R], T>>
Returns Either<L, T>
Overrides Monad.apply
- Defined in packages/monad/src/lib/Either.ts:30

applyTo

applyTo<T>(value: Either<L, T>): R extends Func<[T], unknown> ? Either<L, ReturnType<R>> : never
Type Parameters
- T
Parameters
- value: Either<L, T>
Returns R extends Func<[T], unknown> ? Either<L, ReturnType<R>> : never
Overrides Monad.applyTo
- Defined in packages/monad/src/lib/Either.ts:31

bimap

bimap<A, B>(projectLeft: Func<[value: L], A>, projectRight: Func<[value: R], B>): Either<A, B>
Type Parameters
- A
- B
Parameters
- projectLeft: Func<[value: L], A>
- projectRight: Func<[value: R], B>
Returns Either<A, B>
- Defined in packages/monad/src/lib/Either.ts:20

flatMap

flatMap<T>(project: Func<[value: R], Either<L, T>>): Either<L, T>
Type Parameters
- T
Parameters
- project: Func<[value: R], Either<L, T>>
Returns Either<L, T>
Overrides Monad.flatMap
- Defined in packages/monad/src/lib/Either.ts:17

flatMapLeft

flatMapLeft<T>(project: Func<[value: L], Either<T, R>>): Either<T, R>
Type Parameters
- T
Parameters
- project: Func<[value: L], Either<T, R>>
Returns Either<T, R>
- Defined in packages/monad/src/lib/Either.ts:18

fold

fold<T>(projectLeft: Func<[L], T>, projectRight: Func<[R], T>): T
Type Parameters
- T
Parameters
- projectLeft: Func<[L], T>
- projectRight: Func<[R], T>
Returns T
- Defined in packages/monad/src/lib/Either.ts:35

forEach

forEach(callback: Func<[value: R], unknown>): Either<L, R>
Parameters
- callback: Func<[value: R], unknown>
Returns Either<L, R>
- Defined in packages/monad/src/lib/Either.ts:27

forEachLeft

forEachLeft(callback: Func<[value: L], unknown>): Either<L, R>
Parameters
- callback: Func<[value: L], unknown>
Returns Either<L, R>
- Defined in packages/monad/src/lib/Either.ts:28

left

left(): undefined | L
Returns undefined | L
- Defined in packages/monad/src/lib/Either.ts:8
left(fallback: Func<[], L>): L
Parameters
- fallback: Func<[], L>
Returns L
- Defined in packages/monad/src/lib/Either.ts:9

map

map<T>(project: Func<[value: R], T>): Either<L, T>
Type Parameters
- T
Parameters
- project: Func<[value: R], T>
Returns Either<L, T>
Overrides Monad.map
- Defined in packages/monad/src/lib/Either.ts:14

mapLeft

mapLeft<T>(project: Func<[value: L], T>): Either<T, R>
Type Parameters
- T
Parameters
- project: Func<[value: L], T>
Returns Either<T, R>
- Defined in packages/monad/src/lib/Either.ts:15

right

right(): undefined | R
Returns undefined | R
- Defined in packages/monad/src/lib/Either.ts:11
right(fallback: Func<[], R>): R
Parameters
- fallback: Func<[], R>
Returns R
- Defined in packages/monad/src/lib/Either.ts:12

swap

swap(): Either<R, L>
Returns Either<R, L>
- Defined in packages/monad/src/lib/Either.ts:25

Generated using TypeDoc