aboutsummaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/effect.md2
-rw-r--r--docs/modules/nat.md28
-rw-r--r--docs/modules/ref.md2
-rw-r--r--docs/modules/stdio.md2
-rw-r--r--docs/modules/test.md21
-rw-r--r--docs/modules/util.md12
6 files changed, 43 insertions, 24 deletions
diff --git a/docs/modules/effect.md b/docs/modules/effect.md
index 621dede..bfb3341 100644
--- a/docs/modules/effect.md
+++ b/docs/modules/effect.md
@@ -49,4 +49,4 @@ type main = Bind<
#### Defined in
-[effect.ts:56](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/effect.ts#L56)
+[effect.ts:56](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/effect.ts#L56)
diff --git a/docs/modules/nat.md b/docs/modules/nat.md
index 40bddf7..0430c20 100644
--- a/docs/modules/nat.md
+++ b/docs/modules/nat.md
@@ -36,7 +36,7 @@
#### Defined in
-[nat.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L6)
+[nat.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L6)
___
@@ -54,7 +54,7 @@ ___
#### Defined in
-[nat.ts:14](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L14)
+[nat.ts:14](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L14)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
-[nat.ts:1](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L1)
+[nat.ts:1](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L1)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
-[nat.ts:4](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L4)
+[nat.ts:4](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L4)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
-[nat.ts:3](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L3)
+[nat.ts:3](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L3)
___
@@ -119,7 +119,7 @@ ___
#### Defined in
-[nat.ts:10](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L10)
+[nat.ts:10](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L10)
___
@@ -135,7 +135,7 @@ ___
#### Defined in
-[nat.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L2)
+[nat.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L2)
___
@@ -145,7 +145,7 @@ ___
#### Defined in
-[nat.ts:20](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L20)
+[nat.ts:20](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L20)
___
@@ -155,7 +155,7 @@ ___
#### Defined in
-[nat.ts:21](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L21)
+[nat.ts:21](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L21)
___
@@ -165,7 +165,7 @@ ___
#### Defined in
-[nat.ts:22](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L22)
+[nat.ts:22](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L22)
___
@@ -175,7 +175,7 @@ ___
#### Defined in
-[nat.ts:23](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L23)
+[nat.ts:23](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L23)
___
@@ -185,7 +185,7 @@ ___
#### Defined in
-[nat.ts:24](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L24)
+[nat.ts:24](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L24)
___
@@ -195,7 +195,7 @@ ___
#### Defined in
-[nat.ts:25](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L25)
+[nat.ts:25](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L25)
___
@@ -205,4 +205,4 @@ ___
#### Defined in
-[nat.ts:26](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/nat.ts#L26)
+[nat.ts:26](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/nat.ts#L26)
diff --git a/docs/modules/ref.md b/docs/modules/ref.md
index d282eaa..aacdb6c 100644
--- a/docs/modules/ref.md
+++ b/docs/modules/ref.md
@@ -23,4 +23,4 @@
#### Defined in
-[ref.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/ref.ts#L6)
+[ref.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/ref.ts#L6)
diff --git a/docs/modules/stdio.md b/docs/modules/stdio.md
index ba6eb16..21f5f15 100644
--- a/docs/modules/stdio.md
+++ b/docs/modules/stdio.md
@@ -30,4 +30,4 @@
#### Defined in
-[stdio.ts:11](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/stdio.ts#L11)
+[stdio.ts:11](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/stdio.ts#L11)
diff --git a/docs/modules/test.md b/docs/modules/test.md
index dc0ec99..df117e3 100644
--- a/docs/modules/test.md
+++ b/docs/modules/test.md
@@ -21,6 +21,25 @@
Ƭ **AssertEquals**<`Left`, `Right`\>: [`Try`](../interfaces/exception.Try.md)<[`Assert`](../interfaces/test.Assert.md)<[`Equals`](util.md#equals)<`Left`, `Right`\>\>, <m\>() => [`Do`](../interfaces/effect.Do.md)<[[`ShowAssertionError`](../interfaces/test.ShowAssertionError.md)<`Left`, `Right`\>, [`Throw`](../interfaces/exception.Throw.md)<`m`\>]\>\>
+Assert if left and right values are equal structurally
+
+**`Type Param`**
+
+Left value
+
+**`Type Param`**
+
+Right value
+
+**`Example`**
+
+```ts
+type main = [
+ AssertEquals<`Foo ${'bar'}`, 'Foo bar'>
+ AssertEquals<[2, ...[3, 4]], [2, 3, 4]>
+]
+```
+
#### Type parameters
| Name |
@@ -30,4 +49,4 @@
#### Defined in
-[test.ts:28](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/test.ts#L28)
+[test.ts:59](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/test.ts#L59)
diff --git a/docs/modules/util.md b/docs/modules/util.md
index 753e94b..d9ef12e 100644
--- a/docs/modules/util.md
+++ b/docs/modules/util.md
@@ -32,7 +32,7 @@
#### Defined in
-[util.ts:23](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L23)
+[util.ts:23](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/util.ts#L23)
___
@@ -49,7 +49,7 @@ ___
#### Defined in
-[util.ts:5](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L5)
+[util.ts:5](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/util.ts#L5)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
-[util.ts:29](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L29)
+[util.ts:29](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/util.ts#L29)
___
@@ -90,7 +90,7 @@ ___
#### Defined in
-[util.ts:7](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L7)
+[util.ts:7](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/util.ts#L7)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
-[util.ts:3](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L3)
+[util.ts:3](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/util.ts#L3)
___
@@ -122,4 +122,4 @@ ___
#### Defined in
-[util.ts:35](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/util.ts#L35)
+[util.ts:35](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/util.ts#L35)