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/interfaces/test.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/interfaces/test.Test.md')
| -rw-r--r-- | docs/interfaces/test.Test.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/interfaces/test.Test.md b/docs/interfaces/test.Test.md index b503cc0..583569a 100644 --- a/docs/interfaces/test.Test.md +++ b/docs/interfaces/test.Test.md @@ -1,23 +1,29 @@ [ts-types-lang](../README.md) / [Modules](../modules.md) / [test](../modules/test.md) / Test -# Interface: Test<_m, _effs\> +# Interface: Test<_M, _Effs\> [test](../modules/test.md).Test -Generic interface for declaring effects +Create a test block **`Example`** ```ts -interface MyEffect extends Effect<string[]> {} +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` | The output generated by the effect (defaults to `unknown`) | -| `_effs` | extends [`Effect`](effect.Effect.md)[] | - | +| `_M` | extends `string` | description of the test | +| `_Effs` | extends [`Effect`](effect.Effect.md)[] | List of effects to evaluate | ## Hierarchy |