Right
Defined in: src/util/Either.ts:81
The Right branch — by convention the primary value.
Type Parameters
Section titled “Type Parameters”R
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Right<
R>(value):Right<R>
Defined in: src/util/Either.ts:83
Parameters
Section titled “Parameters”R
Returns
Section titled “Returns”Right<R>
Properties
Section titled “Properties”
readonly_tag:"Right"
Defined in: src/util/Either.ts:82
readonlyvalue:R
Defined in: src/util/Either.ts:83
Methods
Section titled “Methods”bimap()
Section titled “bimap()”bimap<
U,V>(_onLeft,onRight):Either<U,V>
Defined in: src/util/Either.ts:98
Map BOTH sides.
Type Parameters
Section titled “Type Parameters”U
V
Parameters
Section titled “Parameters”_onLeft
Section titled “_onLeft”(l) => U
onRight
Section titled “onRight”(r) => V
Returns
Section titled “Returns”Either<U, V>
flatMap()
Section titled “flatMap()”flatMap<
L2,R2>(f):Either<L2,R2>
Defined in: src/util/Either.ts:92
Right-biased flatMap.
Type Parameters
Section titled “Type Parameters”L2
R2
Parameters
Section titled “Parameters”(r) => Either<L2, R2>
Returns
Section titled “Returns”Either<L2, R2>
fold()
Section titled “fold()”fold<
T>(_onLeft,onRight):T
Defined in: src/util/Either.ts:103
Collapse to a single value.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”_onLeft
Section titled “_onLeft”(l) => T
onRight
Section titled “onRight”(r) => T
Returns
Section titled “Returns”T
forEach()
Section titled “forEach()”forEach(
f):void
Defined in: src/util/Either.ts:115
Side-effect on the Right value.
Parameters
Section titled “Parameters”(r) => void
Returns
Section titled “Returns”void
getOrElse()
Section titled “getOrElse()”getOrElse<
U>(_fallback):R
Defined in: src/util/Either.ts:109
Right → the value; fallback ignored.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”_fallback
Section titled “_fallback”U | ((l) => U)
Returns
Section titled “Returns”R
isLeft()
Section titled “isLeft()”isLeft():
this is Left<never>
Defined in: src/util/Either.ts:85
Returns
Section titled “Returns”this is Left<never>
isRight()
Section titled “isRight()”isRight():
this is Right<R>
Defined in: src/util/Either.ts:86
Returns
Section titled “Returns”this is Right<R>
map<
U>(f):Either<never,U>
Defined in: src/util/Either.ts:89
Right-biased map — transform the inner value.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”(r) => U
Returns
Section titled “Returns”Either<never, U>
mapLeft()
Section titled “mapLeft()”mapLeft<
U>(_f):Either<U,R>
Defined in: src/util/Either.ts:95
Right passes through mapLeft untouched.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”(l) => U
Returns
Section titled “Returns”Either<U, R>
orElse()
Section titled “orElse()”orElse<
R2>(_alt):Either<never,R>
Defined in: src/util/Either.ts:112
Right → self; alternative ignored.
Type Parameters
Section titled “Type Parameters”R2
Parameters
Section titled “Parameters”Either<never, R2> | (() => Either<never, R2>)
Returns
Section titled “Returns”Either<never, R>
swap()
Section titled “swap()”swap():
Either<R,never>
Defined in: src/util/Either.ts:106
Swap the sides.
Returns
Section titled “Returns”Either<R, never>
toNullable()
Section titled “toNullable()”toNullable():
R
Defined in: src/util/Either.ts:118
Optional conversion — Right → the value.
Returns
Section titled “Returns”R