aboutsummaryrefslogtreecommitdiff
path: root/docs/interfaces/util.IdK.md
diff options
context:
space:
mode:
authorAkshay Nair <phenax5@gmail.com>2023-01-14 18:16:41 +0530
committerAkshay Nair <phenax5@gmail.com>2023-01-14 18:16:41 +0530
commite75a5a15912b8f297fe9c9747f574486d6c4e334 (patch)
tree603cd3b9fa68e6e0bd700fe66fede80e9ae657c9 /docs/interfaces/util.IdK.md
parent78e384c2f32996478edced59c837a348dec77e57 (diff)
downloadts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.tar.gz
ts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.zip
chore: adds some docs
Diffstat (limited to 'docs/interfaces/util.IdK.md')
-rw-r--r--docs/interfaces/util.IdK.md20
1 files changed, 18 insertions, 2 deletions
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<number, string> {
+ return: `Your number is ${this['input']}`,
+}
+
+type result = ApplyK<SomeFunc, 200>
+```
+
## 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)