All files / src/vitest parameterized.ts

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
 
 
 
1x
1x
 
 
 
 
 
 
 
 
 
 
 
1x
1x
1x
 
 
 
 
 
1x
 
 
 
1x
 
 
 
1x
1x
1x
1x
1x
1x
 
import type {TypeLambda} from 'effect/HKT'
import type {ParameterOverrides} from '../law.js'
import type {GivenConcerns, Parameterized} from '../laws.js'
import {buildParameterizedTypeclassLaws} from '../laws.js'
import {testLawSets} from './testLaws.js'
 
/**
 * Test [parameterized type](https://github.com/Effect-TS/effect/blob/main/packages/typeclass/README.md#parameterized-types)
 * typeclass laws for the given instances of some datatype.
 *
 * @typeParam F - Type lambda of the datatype under test.
 * @typeParam A - Type lambda of first underlying type.
 * @typeParam B - Type lambda of second underlying type.
 * @typeParam C - Type lambda of third underlying type.
 * @category vitest
 */
export const testParameterizedTypeclassLaws =
  <F extends TypeLambda, A, B = A, C = A>() =>
  <Ins extends Partial<Parameterized<F>>, R = never, O = unknown, E = unknown>(
    /**
     * Instances to test. Key is typeclass name and value is the
     * instance under test. For example, `{ Monad: Option.Monad }` will run
     * the monad typeclass laws on `Option`.
     */
    instances: Ins,
    /**
     * Parameterized typeclass test options.
     */
    given: GivenConcerns<F, A, B, C, R, O, E>,
    /**
     * Optional runtime `fast-check` parameters.
     */
    parameters?: ParameterOverrides,
  ) => {
    testLawSets(parameters)(
      ...buildParameterizedTypeclassLaws<F, A, B, C>()(instances, given),
    )
  }