Class Pair<A, B>

constructor

• new Pair<out A, out B>(fst, snd): Pair<A, B>

• Type Parameters

  • out A

  • out B

  Parameters

  • fst: A

  • snd: B

  Returns Pair<A, B>

Readonly fst

Readonly snd

val

• get val(): [A, B]

• A 2-tuple of the first value and second value of this Pair.

  Returns [A, B]

[cmb]

• [cmb]<A, B>(this, that): Pair<A, B>

• Combine the first values and second values of this and that Pair pairwise.

  Type Parameters

  • A extends Semigroup<A>

  • B extends Semigroup<B>

  Parameters

  • this: Pair<A, B>

  • that: Pair<A, B>

  Returns Pair<A, B>

[cmp]

• [cmp]<A, B>(this, that): Ordering

• Compare this and that Pair to determine their ordering.

  Type Parameters

  • A extends Ord<A>

  • B extends Ord<B>

  Parameters

  • this: Pair<A, B>

  • that: Pair<A, B>

  Returns Ordering

  Remarks

  When ordered, Pair compares first values and second values lexicographically.

[eq]

• [eq]<A, B>(this, that): boolean

• Compare this and that Pair to determine their equality.

  Type Parameters

  • A extends Eq<A>

  • B extends Eq<B>

  Parameters

  • this: Pair<A, B>

  • that: Pair<A, B>

  Returns boolean

  Remarks

  Two Pair are equal if their first values are equal and their second values are equal.

lmap

• lmap<A1>(f): Pair<A1, B>

• Apply a function to map the first value of this Pair.

  Type Parameters

  • A1

  Parameters

  • f: ((val) => A1)

    • • (val): A1

      • Parameters

        • val: A

        Returns A1

  Returns Pair<A1, B>

map

• map<B1>(f): Pair<A, B1>

• Apply a function to map the second value of this Pair.

  Type Parameters

  • B1

  Parameters

  • f: ((val) => B1)

    • • (val): B1

      • Parameters

        • val: B

        Returns B1

  Returns Pair<A, B1>

unwrap

• unwrap<T>(f): T

• Apply a function to extract the first value and second value out of this Pair.

  Type Parameters

  • T

  Parameters

  • f: ((fst, snd) => T)

    • • (fst, snd): T

      • Parameters

        • fst: A

        • snd: B

        Returns T

  Returns T

Static fromTuple

• fromTuple<A, B>(tuple): Pair<A, B>

• Construct a Pair from a 2-tuple of values.

  Type Parameters

  • A

  • B

  Parameters

  • tuple: readonly [A, B]

  Returns Pair<A, B>