aboutsummaryrefslogtreecommitdiff
path: root/docs/interfaces/test.AssertEqualsK.md
diff options
context:
space:
mode:
authorAkshay Nair <phenax5@gmail.com>2023-01-15 00:13:04 +0530
committerAkshay Nair <phenax5@gmail.com>2023-01-15 00:13:04 +0530
commitd5c3af89ab8076bcf4107859c1ba6b47a7815142 (patch)
tree1da469a7007fe2cfced0647ae62c1cd003a3fa0d /docs/interfaces/test.AssertEqualsK.md
parente75a5a15912b8f297fe9c9747f574486d6c4e334 (diff)
downloadts-types-lang-d5c3af89ab8076bcf4107859c1ba6b47a7815142.tar.gz
ts-types-lang-d5c3af89ab8076bcf4107859c1ba6b47a7815142.zip
chore: some more documentation
Diffstat (limited to 'docs/interfaces/test.AssertEqualsK.md')
-rw-r--r--docs/interfaces/test.AssertEqualsK.md28
1 files changed, 13 insertions, 15 deletions
diff --git a/docs/interfaces/test.AssertEqualsK.md b/docs/interfaces/test.AssertEqualsK.md
index b2c2e81..6390521 100644
--- a/docs/interfaces/test.AssertEqualsK.md
+++ b/docs/interfaces/test.AssertEqualsK.md
@@ -4,27 +4,25 @@
[test](../modules/test.md).AssertEqualsK
-An implementation of `* -> *` higher-kinded type
+An alternate point-free api for [AssertEquals](../modules/test.md#assertequals)
-**`Example`**
+**`Type Param`**
-You can define a return property for the function body
- and use `this['input']` to access the argument
- Uses - [ApplyK](../modules/util.md#applyk)
+Right value
-```ts
-interface SomeFunc extends Kind1<number, string> {
- return: `Your number is ${this['input']}`,
-}
+**`Example`**
-type result = ApplyK<SomeFunc, 200>
+```ts
+type main = [
+ Bind<JsExpr<'21 * 3'>, AssertEqualsK<63>>
+]
```
## Type parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `Right` | extends `unknown` | The input type |
+| Name | Type |
+| :------ | :------ |
+| `Right` | extends `unknown` |
## Hierarchy
@@ -51,7 +49,7 @@ type result = ApplyK<SomeFunc, 200>
#### Defined in
-[effect.ts:35](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/effect.ts#L35)
+[effect.ts:35](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/effect.ts#L35)
___
@@ -65,4 +63,4 @@ ___
#### Defined in
-[test.ts:34](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/test.ts#L34)
+[test.ts:77](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/test.ts#L77)