aboutsummaryrefslogtreecommitdiff
path: root/docs/interfaces/test.Test.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/interfaces/test.Test.md')
-rw-r--r--docs/interfaces/test.Test.md36
1 files changed, 12 insertions, 24 deletions
diff --git a/docs/interfaces/test.Test.md b/docs/interfaces/test.Test.md
index 66e6c93..b503cc0 100644
--- a/docs/interfaces/test.Test.md
+++ b/docs/interfaces/test.Test.md
@@ -4,35 +4,23 @@
[test](../modules/test.md).Test
+Generic interface for declaring effects
+
+**`Example`**
+
+```ts
+interface MyEffect extends Effect<string[]> {}
+```
+
## Type parameters
-| Name | Type |
-| :------ | :------ |
-| `_m` | extends `string` |
-| `_effs` | extends [`Effect`](effect.Effect.md)[] |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `_m` | extends `string` | The output generated by the effect (defaults to `unknown`) |
+| `_effs` | extends [`Effect`](effect.Effect.md)[] | - |
## Hierarchy
- [`Effect`](effect.Effect.md)
↳ **`Test`**
-
-## Table of contents
-
-### Properties
-
-- [output](test.Test.md#output)
-
-## Properties
-
-### output
-
-• **output**: `unknown`
-
-#### Inherited from
-
-[Effect](effect.Effect.md).[output](effect.Effect.md#output)
-
-#### Defined in
-
-[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2)