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 | |
| parent | 78e384c2f32996478edced59c837a348dec77e57 (diff) | |
| download | ts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.tar.gz ts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.zip | |
chore: adds some docs
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/effect.md | 24 | ||||
| -rw-r--r-- | docs/modules/nat.md | 28 | ||||
| -rw-r--r-- | docs/modules/ref.md | 2 | ||||
| -rw-r--r-- | docs/modules/stdio.md | 2 | ||||
| -rw-r--r-- | docs/modules/test.md | 3 | ||||
| -rw-r--r-- | docs/modules/util.md | 12 |
6 files changed, 42 insertions, 29 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) diff --git a/docs/modules/nat.md b/docs/modules/nat.md index 610ffe7..40bddf7 100644 --- a/docs/modules/nat.md +++ b/docs/modules/nat.md @@ -36,7 +36,7 @@ #### Defined in -[nat.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L6) +[nat.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L6) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[nat.ts:14](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L14) +[nat.ts:14](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L14) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[nat.ts:1](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L1) +[nat.ts:1](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L1) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[nat.ts:4](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L4) +[nat.ts:4](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L4) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[nat.ts:3](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L3) +[nat.ts:3](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L3) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[nat.ts:10](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L10) +[nat.ts:10](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L10) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[nat.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L2) +[nat.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L2) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -[nat.ts:20](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L20) +[nat.ts:20](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L20) ___ @@ -155,7 +155,7 @@ ___ #### Defined in -[nat.ts:21](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L21) +[nat.ts:21](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L21) ___ @@ -165,7 +165,7 @@ ___ #### Defined in -[nat.ts:22](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L22) +[nat.ts:22](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L22) ___ @@ -175,7 +175,7 @@ ___ #### Defined in -[nat.ts:23](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L23) +[nat.ts:23](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L23) ___ @@ -185,7 +185,7 @@ ___ #### Defined in -[nat.ts:24](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L24) +[nat.ts:24](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L24) ___ @@ -195,7 +195,7 @@ ___ #### Defined in -[nat.ts:25](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L25) +[nat.ts:25](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L25) ___ @@ -205,4 +205,4 @@ ___ #### Defined in -[nat.ts:26](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L26) +[nat.ts:26](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L26) diff --git a/docs/modules/ref.md b/docs/modules/ref.md index dea0952..d282eaa 100644 --- a/docs/modules/ref.md +++ b/docs/modules/ref.md @@ -23,4 +23,4 @@ #### Defined in -[ref.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/ref.ts#L6) +[ref.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/ref.ts#L6) diff --git a/docs/modules/stdio.md b/docs/modules/stdio.md index a92a239..ba6eb16 100644 --- a/docs/modules/stdio.md +++ b/docs/modules/stdio.md @@ -30,4 +30,4 @@ #### Defined in -[stdio.ts:11](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/stdio.ts#L11) +[stdio.ts:11](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/stdio.ts#L11) diff --git a/docs/modules/test.md b/docs/modules/test.md index f3a2682..dc0ec99 100644 --- a/docs/modules/test.md +++ b/docs/modules/test.md @@ -8,7 +8,6 @@ - [Assert](../interfaces/test.Assert.md) - [AssertEqualsK](../interfaces/test.AssertEqualsK.md) -- [Config](../interfaces/test.Config.md) - [ShowAssertionError](../interfaces/test.ShowAssertionError.md) - [Test](../interfaces/test.Test.md) @@ -31,4 +30,4 @@ #### Defined in -[test.ts:18](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/test.ts#L18) +[test.ts:28](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/test.ts#L28) diff --git a/docs/modules/util.md b/docs/modules/util.md index d89e23e..753e94b 100644 --- a/docs/modules/util.md +++ b/docs/modules/util.md @@ -32,7 +32,7 @@ #### Defined in -[util.ts:23](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L23) +[util.ts:23](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L23) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[util.ts:5](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L5) +[util.ts:5](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L5) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[util.ts:29](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L29) +[util.ts:29](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L29) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[util.ts:7](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L7) +[util.ts:7](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L7) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[util.ts:3](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L3) +[util.ts:3](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L3) ___ @@ -122,4 +122,4 @@ ___ #### Defined in -[util.ts:35](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L35) +[util.ts:35](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L35) |
