Class Left<A>

A left-sided Either.

Type Parameters

out A

Hierarchy

Either.Syntax
- Left

Index

Constructors

constructor

new Left<out A>(val): Either.Left<A>
Type Parameters
- out A
Parameters
- val: A
Returns Either.Left<A>
Overrides Syntax.constructor
- Defined in either.ts:474

Properties

`Readonly` kind

kind: LEFT = Kind.LEFT

The property that discriminates Either.

`Readonly` val

val: A

The value of this Either.

Methods

[cmb]

[cmb]<E, T>(this, that): Either<E, T>
If this and that Either are Right, combine their values.
Type Parameters
- E
- T extends Semigroup<T>
Parameters
- this: Either<E, T>
- that: Either<E, T>
Returns Either<E, T>
Inherited from Syntax.[cmb]
- Defined in either.ts:360

[cmp]

[cmp]<A, B>(this, that): Ordering
Compare this and that Either to determine their ordering.
Type Parameters
- A extends Ord<A>
- B extends Ord
Parameters
- this: Either<A, B>
- that: Either<A, B>
Returns Ordering

Remarks
When ordered, Left always compares as less than Right. If the variants are the same, their values are compared to determine the ordering.
Inherited from Syntax.[cmp]
- Defined in either.ts:349

[eq]

[eq]<A, B>(this, that): boolean
Compare this and that Either to determine their equality.
Type Parameters
- A extends Eq<A>
- B extends Eq
Parameters
- this: Either<A, B>
- that: Either<A, B>
Returns boolean

Remarks
Two Either are equal if they are the same variant and their values are equal.
Inherited from Syntax.[eq]
- Defined in either.ts:330

[iterator]

[iterator](): Generator<Either<A, never>, never, unknown>
Returns Generator<Either<A, never>, never, unknown>
- Defined in either.ts:479

and

and<E, E1, T1>(this, that): Either<E | E1, T1>
If this Either is Right, ignore its value and return that Either.
Type Parameters
- E
- E1
- T1
Parameters
- this: Either<E, any>
- that: Either<E1, T1>
Returns Either<E | E1, T1>
Inherited from Syntax.and
- Defined in either.ts:437

andThen

andThen<E, T, E1, T1>(this, f): Either<E | E1, T1>
If this Either is Right, apply a function to its value to return another Either.
Type Parameters
- E
- T
- E1
- T1
Parameters
- this: Either<E, T>
- f: ((val) => Either<E1, T1>)
 - - (val): Either<E1, T1>
 - Parameters
 
 val: T
 
 Returns Either<E1, T1>
Returns Either<E | E1, T1>
Inherited from Syntax.andThen
- Defined in either.ts:415

andThenGo

andThenGo<E, T, E1, T1>(this, f): Either<E | E1, T1>
If this Either is Right, apply a generator function to its value to return another Either.
Type Parameters
- E
- T
- E1
- T1
Parameters
- this: Either<E, T>
- f: ((val) => Either.Go<E1, T1>)
 - - (val): Either.Go<E1, T1>
 - Parameters
 
 val: T
 
 Returns Either.Go<E1, T1>
Returns Either<E | E1, T1>
Inherited from Syntax.andThenGo
- Defined in either.ts:426

isLeft

isLeft<A>(this): this is Either.Left<A>
Test whether this Either is Left.
Type Parameters
- A
Parameters
- this: Either<A, any>
Returns this is Either.Left<A>
Inherited from Syntax.isLeft
- Defined in either.ts:368

isRight

isRight(this): this is Either.Right
Test whether this Either is Right.
Type Parameters
- B
Parameters
- this: Either<any, B>
Returns this is Either.Right
Inherited from Syntax.isRight
- Defined in either.ts:373

lmap

lmap<A, B, A1>(this, f): Either<A1, B>
If this Either is Left, apply a function to map its value.
Type Parameters
- A
- B
- A1
Parameters
- this: Either<A, B>
- f: ((val) => A1)
 - - (val): A1
 - Parameters
 
 val: A
 
 Returns A1
Returns Either<A1, B>
Inherited from Syntax.lmap
- Defined in either.ts:457

map

map<A, B, B1>(this, f): Either<A, B1>
If this Either is Right, apply a function to map its value.
Type Parameters
- A
- B
- B1
Parameters
- this: Either<A, B>
- f: ((val) => B1)
 - - (val): B1
 - Parameters
 
 val: B
 
 Returns B1
Returns Either<A, B1>
Inherited from Syntax.map
- Defined in either.ts:462

or

or<T, E1, T1>(this, that): Either<E1, T | T1>
If this Either is Left, ignore its value and return that Either.
Type Parameters
- T
- E1
- T1
Parameters
- this: Either<any, T>
- that: Either<E1, T1>
Returns Either<E1, T | T1>
Inherited from Syntax.or
- Defined in either.ts:404

orElse

orElse<E, T, E1, T1>(this, f): Either<E1, T | T1>
If this Either is Left, apply a function to its value to return another Either.
Type Parameters
- E
- T
- E1
- T1
Parameters
- this: Either<E, T>
- f: ((val) => Either<E1, T1>)
 - - (val): Either<E1, T1>
 - Parameters
 
 val: E
 
 Returns Either<E1, T1>
Returns Either<E1, T | T1>
Inherited from Syntax.orElse
- Defined in either.ts:393

unwrap

unwrap<A, B, T1, T2>(this, unwrapLeft, unwrapRight): T1 | T2
Apply one of two functions to extract the value out of this Either depending on the variant.
Type Parameters
- A
- B
- T1
- T2
Parameters
- this: Either<A, B>
- unwrapLeft: ((val) => T1)
 - - (val): T1
 - Parameters
 
 val: A
 
 Returns T1
- unwrapRight: ((val) => T2)
 - - (val): T2
 - Parameters
 
 val: B
 
 Returns T2
Returns T1 | T2
Inherited from Syntax.unwrap
- Defined in either.ts:381

zipWith

zipWith<E, T, E1, T1, T2>(this, that, f): Either<E | E1, T2>
If this and that Either are Right, apply a function to combine their values.
Type Parameters
- E
- T
- E1
- T1
- T2
Parameters
- this: Either<E, T>
- that: Either<E1, T1>
- f: ((lhs, rhs) => T2)
 - - (lhs, rhs): T2
 - Parameters
 
 lhs: T
 
 rhs: T1
 
 Returns T2
Returns Either<E | E1, T2>
Inherited from Syntax.zipWith
- Defined in either.ts:448

Class Left<A>

Type Parameters

out A

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

out A

Parameters

val: A

Returns Either.Left<A>

Properties

Readonly kind

Readonly val

Methods

[cmb]

Type Parameters

E

T extends Semigroup<T>

Parameters

this: Either<E, T>

that: Either<E, T>

Returns Either<E, T>

[cmp]

Type Parameters

A extends Ord<A>

B extends Ord<B>

Parameters

this: Either<A, B>

that: Either<A, B>

Returns Ordering

Remarks

[eq]

Type Parameters

A extends Eq<A>

B extends Eq<B>

Parameters

this: Either<A, B>

that: Either<A, B>

Returns boolean

Remarks

[iterator]

Returns Generator<Either<A, never>, never, unknown>

and

Type Parameters

E

E1

T1

Parameters

this: Either<E, any>

that: Either<E1, T1>

Returns Either<E | E1, T1>

andThen

Type Parameters

E

T

E1

T1

Parameters

this: Either<E, T>

f: ((val) => Either<E1, T1>)

Parameters

val: T

Returns Either<E1, T1>

Returns Either<E | E1, T1>

andThenGo

Type Parameters

E

T

E1

T1

Parameters

this: Either<E, T>

f: ((val) => Either.Go<E1, T1>)

Parameters

val: T

`Readonly` kind

`Readonly` val