From d5c3af89ab8076bcf4107859c1ba6b47a7815142 Mon Sep 17 00:00:00 2001 From: Akshay Nair Date: Sun, 15 Jan 2023 00:13:04 +0530 Subject: chore: some more documentation --- docs/interfaces/effect.Label.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'docs/interfaces/effect.Label.md') diff --git a/docs/interfaces/effect.Label.md b/docs/interfaces/effect.Label.md index f4d9c2c..d007d64 100644 --- a/docs/interfaces/effect.Label.md +++ b/docs/interfaces/effect.Label.md @@ -4,19 +4,22 @@ [effect](../modules/effect.md).Label -Generic interface for declaring effects +Access a label defined with [BindTo](effect.BindTo.md) **`Example`** ```ts -interface MyEffect extends Effect {} +type main = Do<[ + BindTo<"contents", ReadFile<"./file.txt">>, + Bind, () => Print> +]> ``` ## Type parameters | Name | Type | Description | | :------ | :------ | :------ | -| `_Name` | extends `string` | The output generated by the effect (defaults to `unknown`) | +| `_Name` | extends `string` | The name of label | ## Hierarchy -- cgit v1.3.1