From e75a5a15912b8f297fe9c9747f574486d6c4e334 Mon Sep 17 00:00:00 2001 From: Akshay Nair Date: Sat, 14 Jan 2023 18:16:41 +0530 Subject: chore: adds some docs --- docs/interfaces/util.IdK.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) (limited to 'docs/interfaces/util.IdK.md') diff --git a/docs/interfaces/util.IdK.md b/docs/interfaces/util.IdK.md index c46bd22..35bcab6 100644 --- a/docs/interfaces/util.IdK.md +++ b/docs/interfaces/util.IdK.md @@ -4,6 +4,22 @@ [util](../modules/util.md).IdK +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 { + return: `Your number is ${this['input']}`, +} + +type result = ApplyK +``` + ## Hierarchy - [`Kind1`](effect.Kind1.md) @@ -29,7 +45,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) ___ @@ -43,4 +59,4 @@ ___ #### Defined in -[util.ts:9](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L9) +[util.ts:9](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L9) -- cgit v1.3.1