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/test.AssertEqualsK.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) (limited to 'docs/interfaces/test.AssertEqualsK.md') diff --git a/docs/interfaces/test.AssertEqualsK.md b/docs/interfaces/test.AssertEqualsK.md index e6b4d63..b2c2e81 100644 --- a/docs/interfaces/test.AssertEqualsK.md +++ b/docs/interfaces/test.AssertEqualsK.md @@ -4,11 +4,27 @@ [test](../modules/test.md).AssertEqualsK +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 +``` + ## Type parameters -| Name | Type | -| :------ | :------ | -| `Right` | extends `unknown` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `Right` | extends `unknown` | The input type | ## Hierarchy @@ -35,7 +51,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) ___ @@ -49,4 +65,4 @@ ___ #### Defined in -[test.ts:24](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/test.ts#L24) +[test.ts:34](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/test.ts#L34) -- cgit v1.3.1