aboutsummaryrefslogtreecommitdiff
path: root/docs/modules/effect.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/modules/effect.md')
-rw-r--r--docs/modules/effect.md24
1 files changed, 19 insertions, 5 deletions
diff --git a/docs/modules/effect.md b/docs/modules/effect.md
index d9146e1..621dede 100644
--- a/docs/modules/effect.md
+++ b/docs/modules/effect.md
@@ -26,13 +26,27 @@
Ƭ **Func**<`Inp`, `Out`\>: [`Kind1`](../interfaces/effect.Kind1.md)<`Inp`, `Out`\> \| <_T\>() => `Out`
+Generic function definition as a union of a kind and anonymous function
+
+**`Example`**
+
+In addition to defining a kind (see - [Kind1](../interfaces/effect.Kind1.md)),
+ you can also in some places, use inline lambda functions
+
+```ts
+type main = Bind<
+ ReadFile<"./file.txt">,
+ <contents extends string>() => Print<contents>
+>
+```
+
#### Type parameters
-| Name | Type |
-| :------ | :------ |
-| `Inp` | `unknown` |
-| `Out` | `unknown` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `Inp` | `unknown` | The input type |
+| `Out` | `unknown` | The output type |
#### Defined in
-[effect.ts:10](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L10)
+[effect.ts:56](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/effect.ts#L56)