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