aboutsummaryrefslogtreecommitdiff
path: root/docs/interfaces/test.Test.md
blob: 583569a52c8a10752494cde5ce3aae5bf7d6385e (plain) (blame)
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
[ts-types-lang](../README.md) / [Modules](../modules.md) / [test](../modules/test.md) / Test

# Interface: Test<_M, _Effs\>

[test](../modules/test.md).Test

Create a test block

**`Example`**

```ts
type main = [
  Test<"should check if result is 21", [
    Bind<EvalSomeEffect<2, 3>, <a extends number>() => AssertEquals<a, 21>>,
    // equivalent to...
    Bind<EvalSomeEffect<2, 3>, AssertEqualsK<21>>,
  ]>
]
```

## Type parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `_M` | extends `string` | description of the test |
| `_Effs` | extends [`Effect`](effect.Effect.md)[] | List of effects to evaluate |

## Hierarchy

- [`Effect`](effect.Effect.md)

  ↳ **`Test`**