aboutsummaryrefslogtreecommitdiff
path: root/docs/interfaces/effect.Do.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/interfaces/effect.Do.md')
-rw-r--r--docs/interfaces/effect.Do.md34
1 files changed, 11 insertions, 23 deletions
diff --git a/docs/interfaces/effect.Do.md b/docs/interfaces/effect.Do.md
index 1e8860f..504f9c0 100644
--- a/docs/interfaces/effect.Do.md
+++ b/docs/interfaces/effect.Do.md
@@ -4,34 +4,22 @@
[effect](../modules/effect.md).Do
+Generic interface for declaring effects
+
+**`Example`**
+
+```ts
+interface MyEffect extends Effect<string[]> {}
+```
+
## Type parameters
-| Name | Type |
-| :------ | :------ |
-| `_Effs` | extends [`Effect`](effect.Effect.md)[] |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `_Effs` | extends [`Effect`](effect.Effect.md)[] | The output generated by the effect (defaults to `unknown`) |
## Hierarchy
- [`Effect`](effect.Effect.md)
↳ **`Do`**
-
-## Table of contents
-
-### Properties
-
-- [output](effect.Do.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)