diff options
| author | Akshay Nair <phenax5@gmail.com> | 2023-01-14 18:16:41 +0530 |
|---|---|---|
| committer | Akshay Nair <phenax5@gmail.com> | 2023-01-14 18:16:41 +0530 |
| commit | e75a5a15912b8f297fe9c9747f574486d6c4e334 (patch) | |
| tree | 603cd3b9fa68e6e0bd700fe66fede80e9ae657c9 /docs/modules/effect.md | |
| parent | 78e384c2f32996478edced59c837a348dec77e57 (diff) | |
| download | ts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.tar.gz ts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.zip | |
chore: adds some docs
Diffstat (limited to 'docs/modules/effect.md')
| -rw-r--r-- | docs/modules/effect.md | 24 |
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) |