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/interfaces/effect.Kind1.md | |
| parent | 78e384c2f32996478edced59c837a348dec77e57 (diff) | |
| download | ts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.tar.gz ts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.zip | |
chore: adds some docs
Diffstat (limited to 'docs/interfaces/effect.Kind1.md')
| -rw-r--r-- | docs/interfaces/effect.Kind1.md | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/docs/interfaces/effect.Kind1.md b/docs/interfaces/effect.Kind1.md index 7a865b5..0c8600f 100644 --- a/docs/interfaces/effect.Kind1.md +++ b/docs/interfaces/effect.Kind1.md @@ -4,12 +4,28 @@ [effect](../modules/effect.md).Kind1 +An implementation of `* -> *` higher-kinded type + +**`Example`** + +You can define a return property for the function body + and use `this['input']` to access the argument + Uses - [ApplyK](../modules/util.md#applyk) + +```ts +interface SomeFunc extends Kind1<number, string> { + return: `Your number is ${this['input']}`, +} + +type result = ApplyK<SomeFunc, 200> +``` + ## Type parameters -| Name | Type | -| :------ | :------ | -| `Inp` | `unknown` | -| `Out` | `unknown` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `Inp` | `unknown` | The input type | +| `Out` | `unknown` | The output type | ## Hierarchy @@ -36,7 +52,7 @@ #### Defined in -[effect.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L6) +[effect.ts:35](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/effect.ts#L35) ___ @@ -46,4 +62,4 @@ ___ #### Defined in -[effect.ts:7](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L7) +[effect.ts:36](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/effect.ts#L36) |