aboutsummaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/effect.md38
-rw-r--r--docs/modules/exception.md10
-rw-r--r--docs/modules/fs.md10
-rw-r--r--docs/modules/nat.md208
-rw-r--r--docs/modules/ref.md26
-rw-r--r--docs/modules/stdio.md33
-rw-r--r--docs/modules/sys.md14
-rw-r--r--docs/modules/test.md34
-rw-r--r--docs/modules/util.md125
9 files changed, 498 insertions, 0 deletions
diff --git a/docs/modules/effect.md b/docs/modules/effect.md
new file mode 100644
index 0000000..d9146e1
--- /dev/null
+++ b/docs/modules/effect.md
@@ -0,0 +1,38 @@
+[ts-types-lang](../README.md) / [Modules](../modules.md) / effect
+
+# Module: effect
+
+## Table of contents
+
+### Interfaces
+
+- [Bind](../interfaces/effect.Bind.md)
+- [BindTo](../interfaces/effect.BindTo.md)
+- [Do](../interfaces/effect.Do.md)
+- [Effect](../interfaces/effect.Effect.md)
+- [Kind1](../interfaces/effect.Kind1.md)
+- [Label](../interfaces/effect.Label.md)
+- [Noop](../interfaces/effect.Noop.md)
+- [Pure](../interfaces/effect.Pure.md)
+- [Seq](../interfaces/effect.Seq.md)
+
+### Type Aliases
+
+- [Func](effect.md#func)
+
+## Type Aliases
+
+### Func
+
+Ƭ **Func**<`Inp`, `Out`\>: [`Kind1`](../interfaces/effect.Kind1.md)<`Inp`, `Out`\> \| <_T\>() => `Out`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Inp` | `unknown` |
+| `Out` | `unknown` |
+
+#### Defined in
+
+[effect.ts:10](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L10)
diff --git a/docs/modules/exception.md b/docs/modules/exception.md
new file mode 100644
index 0000000..ba3b0c2
--- /dev/null
+++ b/docs/modules/exception.md
@@ -0,0 +1,10 @@
+[ts-types-lang](../README.md) / [Modules](../modules.md) / exception
+
+# Module: exception
+
+## Table of contents
+
+### Interfaces
+
+- [Throw](../interfaces/exception.Throw.md)
+- [Try](../interfaces/exception.Try.md)
diff --git a/docs/modules/fs.md b/docs/modules/fs.md
new file mode 100644
index 0000000..d54aa85
--- /dev/null
+++ b/docs/modules/fs.md
@@ -0,0 +1,10 @@
+[ts-types-lang](../README.md) / [Modules](../modules.md) / fs
+
+# Module: fs
+
+## Table of contents
+
+### Interfaces
+
+- [ReadFile](../interfaces/fs.ReadFile.md)
+- [WriteFile](../interfaces/fs.WriteFile.md)
diff --git a/docs/modules/nat.md b/docs/modules/nat.md
new file mode 100644
index 0000000..610ffe7
--- /dev/null
+++ b/docs/modules/nat.md
@@ -0,0 +1,208 @@
+[ts-types-lang](../README.md) / [Modules](../modules.md) / nat
+
+# Module: nat
+
+## Table of contents
+
+### Type Aliases
+
+- [Add](nat.md#add)
+- [FromNumber](nat.md#fromnumber)
+- [Nat](nat.md#nat)
+- [Pred](nat.md#pred)
+- [Succ](nat.md#succ)
+- [ToNumber](nat.md#tonumber)
+- [Zero](nat.md#zero)
+- [\_0](nat.md#_0)
+- [\_1](nat.md#_1)
+- [\_2](nat.md#_2)
+- [\_3](nat.md#_3)
+- [\_4](nat.md#_4)
+- [\_5](nat.md#_5)
+- [\_9](nat.md#_9)
+
+## Type Aliases
+
+### Add
+
+Ƭ **Add**<`A`, `B`\>: `A` extends [`Zero`](nat.md#zero) ? `B` : [`Add`](nat.md#add)<[`Pred`](nat.md#pred)<`A`\>, [`Succ`](nat.md#succ)<`B`\>\>
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `A` | extends [`Nat`](nat.md#nat) |
+| `B` | extends [`Nat`](nat.md#nat) |
+
+#### Defined in
+
+[nat.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L6)
+
+___
+
+### FromNumber
+
+Ƭ **FromNumber**<`N`, `Res`, `Acc`\>: `N` extends `Acc`[``"length"``] ? `Res` : [`FromNumber`](nat.md#fromnumber)<`N`, [`Succ`](nat.md#succ)<`Res`\>, [...Acc, ``0``]\>
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `N` | extends `number` |
+| `Res` | extends [`Nat`](nat.md#nat) = [`Zero`](nat.md#zero) |
+| `Acc` | extends ``0``[] = [] |
+
+#### Defined in
+
+[nat.ts:14](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L14)
+
+___
+
+### Nat
+
+Ƭ **Nat**: [`Zero`](nat.md#zero) \| { `_prev`: [`Nat`](nat.md#nat) }
+
+#### Defined in
+
+[nat.ts:1](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L1)
+
+___
+
+### Pred
+
+Ƭ **Pred**<`N`\>: `N` extends [`Zero`](nat.md#zero) ? [`Zero`](nat.md#zero) : `N`[``"_prev"``]
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `N` | extends [`Nat`](nat.md#nat) |
+
+#### Defined in
+
+[nat.ts:4](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L4)
+
+___
+
+### Succ
+
+Ƭ **Succ**<`N`\>: `Object`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `N` | extends [`Nat`](nat.md#nat) |
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `_prev` | `N` |
+
+#### Defined in
+
+[nat.ts:3](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L3)
+
+___
+
+### ToNumber
+
+Ƭ **ToNumber**<`N`, `Acc`\>: `N` extends [`Zero`](nat.md#zero) ? `Acc`[``"length"``] : [`ToNumber`](nat.md#tonumber)<[`Pred`](nat.md#pred)<`N`\>, [...Acc, ``0``]\>
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `N` | extends [`Nat`](nat.md#nat) |
+| `Acc` | extends ``0``[] = [] |
+
+#### Defined in
+
+[nat.ts:10](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L10)
+
+___
+
+### Zero
+
+Ƭ **Zero**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `_prev` | ``null`` |
+
+#### Defined in
+
+[nat.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L2)
+
+___
+
+### \_0
+
+Ƭ **\_0**: [`Zero`](nat.md#zero)
+
+#### Defined in
+
+[nat.ts:20](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L20)
+
+___
+
+### \_1
+
+Ƭ **\_1**: [`Succ`](nat.md#succ)<[`_0`](nat.md#_0)\>
+
+#### Defined in
+
+[nat.ts:21](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L21)
+
+___
+
+### \_2
+
+Ƭ **\_2**: [`Succ`](nat.md#succ)<[`_1`](nat.md#_1)\>
+
+#### Defined in
+
+[nat.ts:22](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L22)
+
+___
+
+### \_3
+
+Ƭ **\_3**: [`Succ`](nat.md#succ)<[`_2`](nat.md#_2)\>
+
+#### Defined in
+
+[nat.ts:23](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L23)
+
+___
+
+### \_4
+
+Ƭ **\_4**: [`Succ`](nat.md#succ)<[`_3`](nat.md#_3)\>
+
+#### Defined in
+
+[nat.ts:24](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L24)
+
+___
+
+### \_5
+
+Ƭ **\_5**: [`Succ`](nat.md#succ)<[`_4`](nat.md#_4)\>
+
+#### Defined in
+
+[nat.ts:25](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L25)
+
+___
+
+### \_9
+
+Ƭ **\_9**: [`Add`](nat.md#add)<[`_4`](nat.md#_4), [`_5`](nat.md#_5)\>
+
+#### Defined in
+
+[nat.ts:26](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/nat.ts#L26)
diff --git a/docs/modules/ref.md b/docs/modules/ref.md
new file mode 100644
index 0000000..dea0952
--- /dev/null
+++ b/docs/modules/ref.md
@@ -0,0 +1,26 @@
+[ts-types-lang](../README.md) / [Modules](../modules.md) / ref
+
+# Module: ref
+
+## Table of contents
+
+### Interfaces
+
+- [CreateRef](../interfaces/ref.CreateRef.md)
+- [DeleteRef](../interfaces/ref.DeleteRef.md)
+- [GetRef](../interfaces/ref.GetRef.md)
+- [SetRef](../interfaces/ref.SetRef.md)
+
+### Type Aliases
+
+- [Ref](ref.md#ref)
+
+## Type Aliases
+
+### Ref
+
+Ƭ **Ref**: `string`
+
+#### Defined in
+
+[ref.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/ref.ts#L6)
diff --git a/docs/modules/stdio.md b/docs/modules/stdio.md
new file mode 100644
index 0000000..a92a239
--- /dev/null
+++ b/docs/modules/stdio.md
@@ -0,0 +1,33 @@
+[ts-types-lang](../README.md) / [Modules](../modules.md) / stdio
+
+# Module: stdio
+
+## Table of contents
+
+### Interfaces
+
+- [Debug](../interfaces/stdio.Debug.md)
+- [Print](../interfaces/stdio.Print.md)
+- [PutString](../interfaces/stdio.PutString.md)
+- [ReadLine](../interfaces/stdio.ReadLine.md)
+
+### Type Aliases
+
+- [PutStringLn](stdio.md#putstringln)
+
+## Type Aliases
+
+### PutStringLn
+
+Ƭ **PutStringLn**<`S`\>: `S` extends infer S ? [`PutString`](../interfaces/stdio.PutString.md)<\`${S}
+\`\> : `never`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `S` | extends `string` |
+
+#### Defined in
+
+[stdio.ts:11](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/stdio.ts#L11)
diff --git a/docs/modules/sys.md b/docs/modules/sys.md
new file mode 100644
index 0000000..6cb2d99
--- /dev/null
+++ b/docs/modules/sys.md
@@ -0,0 +1,14 @@
+[ts-types-lang](../README.md) / [Modules](../modules.md) / sys
+
+# Module: sys
+
+## Table of contents
+
+### Interfaces
+
+- [DefineEffect](../interfaces/sys.DefineEffect.md)
+- [Exit](../interfaces/sys.Exit.md)
+- [GetArgs](../interfaces/sys.GetArgs.md)
+- [GetEnv](../interfaces/sys.GetEnv.md)
+- [JsExpr](../interfaces/sys.JsExpr.md)
+- [SetEvalEnvironment](../interfaces/sys.SetEvalEnvironment.md)
diff --git a/docs/modules/test.md b/docs/modules/test.md
new file mode 100644
index 0000000..f3a2682
--- /dev/null
+++ b/docs/modules/test.md
@@ -0,0 +1,34 @@
+[ts-types-lang](../README.md) / [Modules](../modules.md) / test
+
+# Module: test
+
+## Table of contents
+
+### Interfaces
+
+- [Assert](../interfaces/test.Assert.md)
+- [AssertEqualsK](../interfaces/test.AssertEqualsK.md)
+- [Config](../interfaces/test.Config.md)
+- [ShowAssertionError](../interfaces/test.ShowAssertionError.md)
+- [Test](../interfaces/test.Test.md)
+
+### Type Aliases
+
+- [AssertEquals](test.md#assertequals)
+
+## Type Aliases
+
+### AssertEquals
+
+Ƭ **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`\>]\>\>
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `Left` |
+| `Right` |
+
+#### Defined in
+
+[test.ts:18](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/test.ts#L18)
diff --git a/docs/modules/util.md b/docs/modules/util.md
new file mode 100644
index 0000000..d89e23e
--- /dev/null
+++ b/docs/modules/util.md
@@ -0,0 +1,125 @@
+[ts-types-lang](../README.md) / [Modules](../modules.md) / util
+
+# Module: util
+
+## Table of contents
+
+### Interfaces
+
+- [ConstK](../interfaces/util.ConstK.md)
+- [IdK](../interfaces/util.IdK.md)
+
+### Type Aliases
+
+- [ADT](util.md#adt)
+- [ApplyK](util.md#applyk)
+- [Equals](util.md#equals)
+- [Id](util.md#id)
+- [Let](util.md#let)
+- [Not](util.md#not)
+
+## Type Aliases
+
+### ADT
+
+Ƭ **ADT**<`D`\>: { [k in keyof D]: Object } extends infer Rec ? { `t`: `Rec`[keyof `Rec`] } & { [k in keyof Rec]: ADTConstructor<Rec[k]\> } : `never`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `D` | extends `Record`<`string`, `any`\> |
+
+#### Defined in
+
+[util.ts:23](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L23)
+
+___
+
+### ApplyK
+
+Ƭ **ApplyK**<`K`, `Val`\>: `K` & { `input`: `Val` }[``"return"``]
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `K` | extends [`Kind1`](../interfaces/effect.Kind1.md) |
+| `Val` | `Val` |
+
+#### Defined in
+
+[util.ts:5](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L5)
+
+___
+
+### Equals
+
+Ƭ **Equals**<`Left`, `Right`\>: [`Left`] extends [`Right`] ? [`Right`] extends [`Left`] ? ``true`` : ``false`` : ``false``
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `Left` |
+| `Right` |
+
+#### Defined in
+
+[util.ts:29](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L29)
+
+___
+
+### Id
+
+Ƭ **Id**: <T\>() => `T`
+
+#### Type declaration
+
+▸ <`T`\>(): `T`
+
+##### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+##### Returns
+
+`T`
+
+#### Defined in
+
+[util.ts:7](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L7)
+
+___
+
+### Let
+
+Ƭ **Let**<`f`\>: `ReturnType`<`f`\>
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `f` | extends (...`args`: `any`) => `any` |
+
+#### Defined in
+
+[util.ts:3](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L3)
+
+___
+
+### Not
+
+Ƭ **Not**<`B`\>: `B` extends ``true`` ? ``false`` : ``true``
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `B` | extends `boolean` |
+
+#### Defined in
+
+[util.ts:35](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L35)