diff options
| author | Akshay Nair <phenax5@gmail.com> | 2023-01-15 00:13:04 +0530 |
|---|---|---|
| committer | Akshay Nair <phenax5@gmail.com> | 2023-01-15 00:13:04 +0530 |
| commit | d5c3af89ab8076bcf4107859c1ba6b47a7815142 (patch) | |
| tree | 1da469a7007fe2cfced0647ae62c1cd003a3fa0d /docs/modules/test.md | |
| parent | e75a5a15912b8f297fe9c9747f574486d6c4e334 (diff) | |
| download | ts-types-lang-d5c3af89ab8076bcf4107859c1ba6b47a7815142.tar.gz ts-types-lang-d5c3af89ab8076bcf4107859c1ba6b47a7815142.zip | |
chore: some more documentation
Diffstat (limited to 'docs/modules/test.md')
| -rw-r--r-- | docs/modules/test.md | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/docs/modules/test.md b/docs/modules/test.md index dc0ec99..df117e3 100644 --- a/docs/modules/test.md +++ b/docs/modules/test.md @@ -21,6 +21,25 @@ Ƭ **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 | @@ -30,4 +49,4 @@ #### Defined in -[test.ts:28](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/test.ts#L28) +[test.ts:59](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/test.ts#L59) |