Class SyntaxAbstract

constructor

• new Syntax(): Either.Syntax

• Returns Either.Syntax

Readonly Abstract kind

[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>

[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<B>

  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.

[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<B>

  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.

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>

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>

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>

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>

isRight

• isRight<B>(this): this is Either.Right<B>

• Test whether this Either is Right.

  Type Parameters

  • B

  Parameters

  • this: Either<any, B>

  Returns this is Either.Right<B>

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>

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>

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>

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>

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

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>