All files / src/law equivalence.ts

100% Statements 6/6
100% Branches 2/2
100% Functions 1/1
100% Lines 6/6

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69      1x                                                                                   1x 1x 231x   231x 231x                                    
/**
 * @module equivalence Helpers for dealing with equality.
 */
import {Array as AR, Equivalence as EQ} from 'effect'
import type {Kind, TypeLambda} from 'effect/HKT'
 
/**
 * The type of a function that given any equivalence of type `A`, returns an
 * equivalence for `F<A>`. For example:
 * @category lifting
 */
export interface LiftEquivalence<
  F extends TypeLambda,
  R = never,
  O = unknown,
  E = unknown,
> {
  <T>(equals: EQ.Equivalence<T>): EQ.Equivalence<Kind<F, R, O, E, T>>
}
 
/**
 * Given a {@link LiftEquivalence} function, and 1..n `Equivalence`s for
 * different types `A₁, A₂, ...Aₙ`, returns the given list except every
 * equivalence for type `Aᵢ` has been replaced by an equivalence for type
 * `Kind<F, R, O, E, Aᵢ>`. For example:
 * @example
 * import {liftEquivalences} from 'effect-ts-laws'
 * import {Number as NU, Option as OP, String as STR} from 'effect'
 * import {OptionTypeLambda} from 'effect/Option'
 *
 * export const [eqOptionNumber, eqOptionString] =
 *   liftEquivalences<OptionTypeLambda>(OP.getEquivalence)(
 *     NU.Equivalence,
 *     STR.Equivalence,
 *   )
 * // eqOptionNumber ≡ Equivalence<Option<number>>
 * // eqOptionString ≡ Equivalence<Option<string>>
 *
 * assert.ok(eqOptionNumber(OP.some(1), OP.some(1)))
 * assert.equal(eqOptionNumber(OP.some(1), OP.some(2)), false)
 *
 * assert.ok(eqOptionString(OP.some('a'), OP.some('a')))
 * assert.equal(eqOptionString(OP.some('a'), OP.some('b')), false)
 * @category lifting
 */
export const liftEquivalences =
  <F extends TypeLambda, R = never, O = unknown, E = unknown>(
    liftEquivalence: LiftEquivalence<F, R, O, E>,
  ) =>
  <const Eqs extends EQ.Equivalence<never>[]>(...eqs: Eqs) =>
    AR.map(eqs, liftEquivalence) as LiftedEquivalences<Eqs, F, R, O, E>
 
/**
 * Given the tuple of equalities for types `A₁, A₂, ...Aₙ`, returns the tuple of
 * equalities for types `F<A₁>, F<A₂>, ...F<Aₙ>`.
 * @category lifting
 */
export type LiftedEquivalences<
  Eqs extends EQ.Equivalence<never>[],
  F extends TypeLambda,
  R,
  O,
  E,
> = {
  [K in keyof Eqs]: EQ.Equivalence<
    Kind<F, R, O, E, Eqs[K] extends EQ.Equivalence<infer T> ? T : never>
  >
}