diff options
Diffstat (limited to 'docs/interfaces/effect.Do.md')
| -rw-r--r-- | docs/interfaces/effect.Do.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/interfaces/effect.Do.md b/docs/interfaces/effect.Do.md index 504f9c0..1039bc7 100644 --- a/docs/interfaces/effect.Do.md +++ b/docs/interfaces/effect.Do.md @@ -4,19 +4,22 @@ [effect](../modules/effect.md).Do -Generic interface for declaring effects +Evaluate a sequence of effects in series and get the result of the last effect (Equivalent to haskell's do syntax) **`Example`** ```ts -interface MyEffect extends Effect<string[]> {} +type main = Bind< + Do<[ Pure<1>, ReadFile<"./foobar.txt"> ]>, + <t extends string>() => Print<t> +> ``` ## Type parameters | Name | Type | Description | | :------ | :------ | :------ | -| `_Effs` | extends [`Effect`](effect.Effect.md)[] | The output generated by the effect (defaults to `unknown`) | +| `_Effs` | extends [`Effect`](effect.Effect.md)[] | List of effects | ## Hierarchy |