aboutsummaryrefslogtreecommitdiff
path: root/docs/modules/test.md
blob: df117e3c3fd10a5e33995552bc9158d3dd5b2fe9 (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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
[ts-types-lang](../README.md) / [Modules](../modules.md) / test

# Module: test

## Table of contents

### Interfaces

- [Assert](../interfaces/test.Assert.md)
- [AssertEqualsK](../interfaces/test.AssertEqualsK.md)
- [ShowAssertionError](../interfaces/test.ShowAssertionError.md)
- [Test](../interfaces/test.Test.md)

### Type Aliases

- [AssertEquals](test.md#assertequals)

## Type Aliases

### AssertEquals

Ƭ **AssertEquals**<`Left`, `Right`\>: [`Try`](../interfaces/exception.Try.md)<[`Assert`](../interfaces/test.Assert.md)<[`Equals`](util.md#equals)<`Left`, `Right`\>\>, <m\>() => [`Do`](../interfaces/effect.Do.md)<[[`ShowAssertionError`](../interfaces/test.ShowAssertionError.md)<`Left`, `Right`\>, [`Throw`](../interfaces/exception.Throw.md)<`m`\>]\>\>

Assert if left and right values are equal structurally

**`Type Param`**

Left value

**`Type Param`**

Right value

**`Example`**

```ts
type main = [
  AssertEquals<`Foo ${'bar'}`, 'Foo bar'>
  AssertEquals<[2, ...[3, 4]], [2, 3, 4]>
]
```

#### Type parameters

| Name |
| :------ |
| `Left` |
| `Right` |

#### Defined in

[test.ts:59](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/test.ts#L59)