diff options
| author | Akshay Nair <phenax5@gmail.com> | 2023-01-15 00:13:04 +0530 |
|---|---|---|
| committer | Akshay Nair <phenax5@gmail.com> | 2023-01-15 00:13:04 +0530 |
| commit | d5c3af89ab8076bcf4107859c1ba6b47a7815142 (patch) | |
| tree | 1da469a7007fe2cfced0647ae62c1cd003a3fa0d /docs/interfaces/effect.BindTo.md | |
| parent | e75a5a15912b8f297fe9c9747f574486d6c4e334 (diff) | |
| download | ts-types-lang-d5c3af89ab8076bcf4107859c1ba6b47a7815142.tar.gz ts-types-lang-d5c3af89ab8076bcf4107859c1ba6b47a7815142.zip | |
chore: some more documentation
Diffstat (limited to 'docs/interfaces/effect.BindTo.md')
| -rw-r--r-- | docs/interfaces/effect.BindTo.md | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/interfaces/effect.BindTo.md b/docs/interfaces/effect.BindTo.md index c333393..0775364 100644 --- a/docs/interfaces/effect.BindTo.md +++ b/docs/interfaces/effect.BindTo.md @@ -4,20 +4,26 @@ [effect](../modules/effect.md).BindTo -Generic interface for declaring effects +Bind result of evaluating an effect to a label (Equivalent to haskell's <- syntax) + +Note: labels are scoped to outermost Do, Bind, Try, etc scopes **`Example`** ```ts -interface MyEffect extends Effect<string[]> {} +type main = Do<[ + // contents <- readFile "./file.txt" + BindTo<"contents", ReadFile<"./file.txt">>, + Bind<Label<"contents">, <c extends string>() => Print<c>> +]> ``` ## Type parameters | Name | Type | Description | | :------ | :------ | :------ | -| `_Name` | extends `string` | The output generated by the effect (defaults to `unknown`) | -| `_Eff` | extends [`Effect`](effect.Effect.md) | - | +| `_Name` | extends `string` | The name of label | +| `_Eff` | extends [`Effect`](effect.Effect.md) | Effect to evaluate | ## Hierarchy |