From 78e384c2f32996478edced59c837a348dec77e57 Mon Sep 17 00:00:00 2001 From: Akshay Nair Date: Sat, 14 Jan 2023 17:53:00 +0530 Subject: feat: adds basic md docs --- docs/interfaces/effect.Bind.md | 38 +++++++++++++ docs/interfaces/effect.BindTo.md | 38 +++++++++++++ docs/interfaces/effect.Do.md | 37 +++++++++++++ docs/interfaces/effect.Effect.md | 87 ++++++++++++++++++++++++++++++ docs/interfaces/effect.Kind1.md | 49 +++++++++++++++++ docs/interfaces/effect.Label.md | 37 +++++++++++++ docs/interfaces/effect.Noop.md | 31 +++++++++++ docs/interfaces/effect.Pure.md | 37 +++++++++++++ docs/interfaces/effect.Seq.md | 37 +++++++++++++ docs/interfaces/exception.Throw.md | 37 +++++++++++++ docs/interfaces/exception.Try.md | 38 +++++++++++++ docs/interfaces/fs.ReadFile.md | 37 +++++++++++++ docs/interfaces/fs.WriteFile.md | 38 +++++++++++++ docs/interfaces/ref.CreateRef.md | 37 +++++++++++++ docs/interfaces/ref.DeleteRef.md | 37 +++++++++++++ docs/interfaces/ref.GetRef.md | 37 +++++++++++++ docs/interfaces/ref.SetRef.md | 38 +++++++++++++ docs/interfaces/stdio.Debug.md | 38 +++++++++++++ docs/interfaces/stdio.Print.md | 37 +++++++++++++ docs/interfaces/stdio.PutString.md | 37 +++++++++++++ docs/interfaces/stdio.ReadLine.md | 31 +++++++++++ docs/interfaces/sys.DefineEffect.md | 38 +++++++++++++ docs/interfaces/sys.Exit.md | 37 +++++++++++++ docs/interfaces/sys.GetArgs.md | 31 +++++++++++ docs/interfaces/sys.GetEnv.md | 37 +++++++++++++ docs/interfaces/sys.JsExpr.md | 37 +++++++++++++ docs/interfaces/sys.SetEvalEnvironment.md | 37 +++++++++++++ docs/interfaces/test.Assert.md | 37 +++++++++++++ docs/interfaces/test.AssertEqualsK.md | 52 ++++++++++++++++++ docs/interfaces/test.Config.md | 5 ++ docs/interfaces/test.ShowAssertionError.md | 38 +++++++++++++ docs/interfaces/test.Test.md | 38 +++++++++++++ docs/interfaces/util.ConstK.md | 52 ++++++++++++++++++ docs/interfaces/util.IdK.md | 46 ++++++++++++++++ 34 files changed, 1318 insertions(+) create mode 100644 docs/interfaces/effect.Bind.md create mode 100644 docs/interfaces/effect.BindTo.md create mode 100644 docs/interfaces/effect.Do.md create mode 100644 docs/interfaces/effect.Effect.md create mode 100644 docs/interfaces/effect.Kind1.md create mode 100644 docs/interfaces/effect.Label.md create mode 100644 docs/interfaces/effect.Noop.md create mode 100644 docs/interfaces/effect.Pure.md create mode 100644 docs/interfaces/effect.Seq.md create mode 100644 docs/interfaces/exception.Throw.md create mode 100644 docs/interfaces/exception.Try.md create mode 100644 docs/interfaces/fs.ReadFile.md create mode 100644 docs/interfaces/fs.WriteFile.md create mode 100644 docs/interfaces/ref.CreateRef.md create mode 100644 docs/interfaces/ref.DeleteRef.md create mode 100644 docs/interfaces/ref.GetRef.md create mode 100644 docs/interfaces/ref.SetRef.md create mode 100644 docs/interfaces/stdio.Debug.md create mode 100644 docs/interfaces/stdio.Print.md create mode 100644 docs/interfaces/stdio.PutString.md create mode 100644 docs/interfaces/stdio.ReadLine.md create mode 100644 docs/interfaces/sys.DefineEffect.md create mode 100644 docs/interfaces/sys.Exit.md create mode 100644 docs/interfaces/sys.GetArgs.md create mode 100644 docs/interfaces/sys.GetEnv.md create mode 100644 docs/interfaces/sys.JsExpr.md create mode 100644 docs/interfaces/sys.SetEvalEnvironment.md create mode 100644 docs/interfaces/test.Assert.md create mode 100644 docs/interfaces/test.AssertEqualsK.md create mode 100644 docs/interfaces/test.Config.md create mode 100644 docs/interfaces/test.ShowAssertionError.md create mode 100644 docs/interfaces/test.Test.md create mode 100644 docs/interfaces/util.ConstK.md create mode 100644 docs/interfaces/util.IdK.md (limited to 'docs/interfaces') diff --git a/docs/interfaces/effect.Bind.md b/docs/interfaces/effect.Bind.md new file mode 100644 index 0000000..f11db50 --- /dev/null +++ b/docs/interfaces/effect.Bind.md @@ -0,0 +1,38 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [effect](../modules/effect.md) / Bind + +# Interface: Bind<_Eff, _Fn\> + +[effect](../modules/effect.md).Bind + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Eff` | extends [`Effect`](effect.Effect.md) | +| `_Fn` | extends [`Func`](../modules/effect.md#func) | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`Bind`** + +## Table of contents + +### Properties + +- [output](effect.Bind.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/effect.BindTo.md b/docs/interfaces/effect.BindTo.md new file mode 100644 index 0000000..135dc23 --- /dev/null +++ b/docs/interfaces/effect.BindTo.md @@ -0,0 +1,38 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [effect](../modules/effect.md) / BindTo + +# Interface: BindTo<_Name, _Eff\> + +[effect](../modules/effect.md).BindTo + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Name` | extends `string` | +| `_Eff` | extends [`Effect`](effect.Effect.md) | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`BindTo`** + +## Table of contents + +### Properties + +- [output](effect.BindTo.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/effect.Do.md b/docs/interfaces/effect.Do.md new file mode 100644 index 0000000..1e8860f --- /dev/null +++ b/docs/interfaces/effect.Do.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [effect](../modules/effect.md) / Do + +# Interface: Do<_Effs\> + +[effect](../modules/effect.md).Do + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Effs` | extends [`Effect`](effect.Effect.md)[] | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`Do`** + +## Table of contents + +### Properties + +- [output](effect.Do.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/effect.Effect.md b/docs/interfaces/effect.Effect.md new file mode 100644 index 0000000..2c5287f --- /dev/null +++ b/docs/interfaces/effect.Effect.md @@ -0,0 +1,87 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [effect](../modules/effect.md) / Effect + +# Interface: Effect + +[effect](../modules/effect.md).Effect + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +## Hierarchy + +- **`Effect`** + + ↳ [`Bind`](effect.Bind.md) + + ↳ [`BindTo`](effect.BindTo.md) + + ↳ [`Label`](effect.Label.md) + + ↳ [`Seq`](effect.Seq.md) + + ↳ [`Do`](effect.Do.md) + + ↳ [`Pure`](effect.Pure.md) + + ↳ [`Noop`](effect.Noop.md) + + ↳ [`Try`](exception.Try.md) + + ↳ [`Throw`](exception.Throw.md) + + ↳ [`WriteFile`](fs.WriteFile.md) + + ↳ [`ReadFile`](fs.ReadFile.md) + + ↳ [`CreateRef`](ref.CreateRef.md) + + ↳ [`GetRef`](ref.GetRef.md) + + ↳ [`SetRef`](ref.SetRef.md) + + ↳ [`DeleteRef`](ref.DeleteRef.md) + + ↳ [`PutString`](stdio.PutString.md) + + ↳ [`Print`](stdio.Print.md) + + ↳ [`Debug`](stdio.Debug.md) + + ↳ [`ReadLine`](stdio.ReadLine.md) + + ↳ [`GetEnv`](sys.GetEnv.md) + + ↳ [`GetArgs`](sys.GetArgs.md) + + ↳ [`JsExpr`](sys.JsExpr.md) + + ↳ [`DefineEffect`](sys.DefineEffect.md) + + ↳ [`Exit`](sys.Exit.md) + + ↳ [`SetEvalEnvironment`](sys.SetEvalEnvironment.md) + + ↳ [`Assert`](test.Assert.md) + + ↳ [`Test`](test.Test.md) + + ↳ [`ShowAssertionError`](test.ShowAssertionError.md) + +## Table of contents + +### Properties + +- [output](effect.Effect.md#output) + +## Properties + +### output + +• **output**: `T` + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/effect.Kind1.md b/docs/interfaces/effect.Kind1.md new file mode 100644 index 0000000..7a865b5 --- /dev/null +++ b/docs/interfaces/effect.Kind1.md @@ -0,0 +1,49 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [effect](../modules/effect.md) / Kind1 + +# Interface: Kind1 + +[effect](../modules/effect.md).Kind1 + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Inp` | `unknown` | +| `Out` | `unknown` | + +## Hierarchy + +- **`Kind1`** + + ↳ [`AssertEqualsK`](test.AssertEqualsK.md) + + ↳ [`IdK`](util.IdK.md) + + ↳ [`ConstK`](util.ConstK.md) + +## Table of contents + +### Properties + +- [input](effect.Kind1.md#input) +- [return](effect.Kind1.md#return) + +## Properties + +### input + +• **input**: `Inp` + +#### Defined in + +[effect.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L6) + +___ + +### return + +• **return**: `Out` + +#### Defined in + +[effect.ts:7](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L7) diff --git a/docs/interfaces/effect.Label.md b/docs/interfaces/effect.Label.md new file mode 100644 index 0000000..dc325a6 --- /dev/null +++ b/docs/interfaces/effect.Label.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [effect](../modules/effect.md) / Label + +# Interface: Label<_Name\> + +[effect](../modules/effect.md).Label + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Name` | extends `string` | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`Label`** + +## Table of contents + +### Properties + +- [output](effect.Label.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/effect.Noop.md b/docs/interfaces/effect.Noop.md new file mode 100644 index 0000000..84d5a14 --- /dev/null +++ b/docs/interfaces/effect.Noop.md @@ -0,0 +1,31 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [effect](../modules/effect.md) / Noop + +# Interface: Noop + +[effect](../modules/effect.md).Noop + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`Noop`** + +## Table of contents + +### Properties + +- [output](effect.Noop.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/effect.Pure.md b/docs/interfaces/effect.Pure.md new file mode 100644 index 0000000..cc93955 --- /dev/null +++ b/docs/interfaces/effect.Pure.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [effect](../modules/effect.md) / Pure + +# Interface: Pure + +[effect](../modules/effect.md).Pure + +## Type parameters + +| Name | +| :------ | +| `V` | + +## Hierarchy + +- [`Effect`](effect.Effect.md)<`V`\> + + ↳ **`Pure`** + +## Table of contents + +### Properties + +- [output](effect.Pure.md#output) + +## Properties + +### output + +• **output**: `V` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/effect.Seq.md b/docs/interfaces/effect.Seq.md new file mode 100644 index 0000000..f82db81 --- /dev/null +++ b/docs/interfaces/effect.Seq.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [effect](../modules/effect.md) / Seq + +# Interface: Seq<_Effs\> + +[effect](../modules/effect.md).Seq + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Effs` | extends [`Effect`](effect.Effect.md)[] | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`Seq`** + +## Table of contents + +### Properties + +- [output](effect.Seq.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/exception.Throw.md b/docs/interfaces/exception.Throw.md new file mode 100644 index 0000000..a5a8a77 --- /dev/null +++ b/docs/interfaces/exception.Throw.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [exception](../modules/exception.md) / Throw + +# Interface: Throw<_E\> + +[exception](../modules/exception.md).Throw + +## Type parameters + +| Name | +| :------ | +| `_E` | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`Throw`** + +## Table of contents + +### Properties + +- [output](exception.Throw.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/exception.Try.md b/docs/interfaces/exception.Try.md new file mode 100644 index 0000000..fb54ddf --- /dev/null +++ b/docs/interfaces/exception.Try.md @@ -0,0 +1,38 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [exception](../modules/exception.md) / Try + +# Interface: Try<_E, _Catch\> + +[exception](../modules/exception.md).Try + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_E` | extends [`Effect`](effect.Effect.md) | +| `_Catch` | extends [`Func`](../modules/effect.md#func) | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`Try`** + +## Table of contents + +### Properties + +- [output](exception.Try.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/fs.ReadFile.md b/docs/interfaces/fs.ReadFile.md new file mode 100644 index 0000000..f0462c0 --- /dev/null +++ b/docs/interfaces/fs.ReadFile.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [fs](../modules/fs.md) / ReadFile + +# Interface: ReadFile<_Path\> + +[fs](../modules/fs.md).ReadFile + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Path` | extends `string` | + +## Hierarchy + +- [`Effect`](effect.Effect.md)<`string`\> + + ↳ **`ReadFile`** + +## Table of contents + +### Properties + +- [output](fs.ReadFile.md#output) + +## Properties + +### output + +• **output**: `string` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/fs.WriteFile.md b/docs/interfaces/fs.WriteFile.md new file mode 100644 index 0000000..e1a961b --- /dev/null +++ b/docs/interfaces/fs.WriteFile.md @@ -0,0 +1,38 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [fs](../modules/fs.md) / WriteFile + +# Interface: WriteFile<_Path, _Content\> + +[fs](../modules/fs.md).WriteFile + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Path` | extends `string` | +| `_Content` | extends `string` | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`WriteFile`** + +## Table of contents + +### Properties + +- [output](fs.WriteFile.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/ref.CreateRef.md b/docs/interfaces/ref.CreateRef.md new file mode 100644 index 0000000..74425d0 --- /dev/null +++ b/docs/interfaces/ref.CreateRef.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [ref](../modules/ref.md) / CreateRef + +# Interface: CreateRef<_Val\> + +[ref](../modules/ref.md).CreateRef + +## Type parameters + +| Name | +| :------ | +| `_Val` | + +## Hierarchy + +- [`Effect`](effect.Effect.md)<[`Ref`](../modules/ref.md#ref)\> + + ↳ **`CreateRef`** + +## Table of contents + +### Properties + +- [output](ref.CreateRef.md#output) + +## Properties + +### output + +• **output**: `string` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/ref.DeleteRef.md b/docs/interfaces/ref.DeleteRef.md new file mode 100644 index 0000000..0099928 --- /dev/null +++ b/docs/interfaces/ref.DeleteRef.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [ref](../modules/ref.md) / DeleteRef + +# Interface: DeleteRef<_Key\> + +[ref](../modules/ref.md).DeleteRef + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Key` | extends [`Ref`](../modules/ref.md#ref) | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`DeleteRef`** + +## Table of contents + +### Properties + +- [output](ref.DeleteRef.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/ref.GetRef.md b/docs/interfaces/ref.GetRef.md new file mode 100644 index 0000000..11819c7 --- /dev/null +++ b/docs/interfaces/ref.GetRef.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [ref](../modules/ref.md) / GetRef + +# Interface: GetRef<_Key\> + +[ref](../modules/ref.md).GetRef + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Key` | extends [`Ref`](../modules/ref.md#ref) | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`GetRef`** + +## Table of contents + +### Properties + +- [output](ref.GetRef.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/ref.SetRef.md b/docs/interfaces/ref.SetRef.md new file mode 100644 index 0000000..f198b95 --- /dev/null +++ b/docs/interfaces/ref.SetRef.md @@ -0,0 +1,38 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [ref](../modules/ref.md) / SetRef + +# Interface: SetRef<_Key, _Val\> + +[ref](../modules/ref.md).SetRef + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Key` | extends [`Ref`](../modules/ref.md#ref) | +| `_Val` | `_Val` | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`SetRef`** + +## Table of contents + +### Properties + +- [output](ref.SetRef.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/stdio.Debug.md b/docs/interfaces/stdio.Debug.md new file mode 100644 index 0000000..79d59f3 --- /dev/null +++ b/docs/interfaces/stdio.Debug.md @@ -0,0 +1,38 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [stdio](../modules/stdio.md) / Debug + +# Interface: Debug<_, T\> + +[stdio](../modules/stdio.md).Debug + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_` | extends `string` | +| `T` | `T` | + +## Hierarchy + +- [`Effect`](effect.Effect.md)<`T`\> + + ↳ **`Debug`** + +## Table of contents + +### Properties + +- [output](stdio.Debug.md#output) + +## Properties + +### output + +• **output**: `T` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/stdio.Print.md b/docs/interfaces/stdio.Print.md new file mode 100644 index 0000000..c4b7e50 --- /dev/null +++ b/docs/interfaces/stdio.Print.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [stdio](../modules/stdio.md) / Print + +# Interface: Print<_\> + +[stdio](../modules/stdio.md).Print + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_` | extends `any` | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`Print`** + +## Table of contents + +### Properties + +- [output](stdio.Print.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/stdio.PutString.md b/docs/interfaces/stdio.PutString.md new file mode 100644 index 0000000..1960d1a --- /dev/null +++ b/docs/interfaces/stdio.PutString.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [stdio](../modules/stdio.md) / PutString + +# Interface: PutString<_\> + +[stdio](../modules/stdio.md).PutString + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_` | extends `string` | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`PutString`** + +## Table of contents + +### Properties + +- [output](stdio.PutString.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/stdio.ReadLine.md b/docs/interfaces/stdio.ReadLine.md new file mode 100644 index 0000000..fd2443e --- /dev/null +++ b/docs/interfaces/stdio.ReadLine.md @@ -0,0 +1,31 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [stdio](../modules/stdio.md) / ReadLine + +# Interface: ReadLine + +[stdio](../modules/stdio.md).ReadLine + +## Hierarchy + +- [`Effect`](effect.Effect.md)<`string`\> + + ↳ **`ReadLine`** + +## Table of contents + +### Properties + +- [output](stdio.ReadLine.md#output) + +## Properties + +### output + +• **output**: `string` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/sys.DefineEffect.md b/docs/interfaces/sys.DefineEffect.md new file mode 100644 index 0000000..56c3d65 --- /dev/null +++ b/docs/interfaces/sys.DefineEffect.md @@ -0,0 +1,38 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [sys](../modules/sys.md) / DefineEffect + +# Interface: DefineEffect<_Name, _Func\> + +[sys](../modules/sys.md).DefineEffect + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Name` | extends `string` | +| `_Func` | extends `string` | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`DefineEffect`** + +## Table of contents + +### Properties + +- [output](sys.DefineEffect.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/sys.Exit.md b/docs/interfaces/sys.Exit.md new file mode 100644 index 0000000..ee24029 --- /dev/null +++ b/docs/interfaces/sys.Exit.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [sys](../modules/sys.md) / Exit + +# Interface: Exit<_\> + +[sys](../modules/sys.md).Exit + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_` | extends `number` \| `undefined` = `undefined` | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`Exit`** + +## Table of contents + +### Properties + +- [output](sys.Exit.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/sys.GetArgs.md b/docs/interfaces/sys.GetArgs.md new file mode 100644 index 0000000..d373dbe --- /dev/null +++ b/docs/interfaces/sys.GetArgs.md @@ -0,0 +1,31 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [sys](../modules/sys.md) / GetArgs + +# Interface: GetArgs + +[sys](../modules/sys.md).GetArgs + +## Hierarchy + +- [`Effect`](effect.Effect.md)<`string`[]\> + + ↳ **`GetArgs`** + +## Table of contents + +### Properties + +- [output](sys.GetArgs.md#output) + +## Properties + +### output + +• **output**: `string`[] + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/sys.GetEnv.md b/docs/interfaces/sys.GetEnv.md new file mode 100644 index 0000000..ab1192b --- /dev/null +++ b/docs/interfaces/sys.GetEnv.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [sys](../modules/sys.md) / GetEnv + +# Interface: GetEnv<_Name\> + +[sys](../modules/sys.md).GetEnv + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Name` | extends `string` | + +## Hierarchy + +- [`Effect`](effect.Effect.md)<`string`\> + + ↳ **`GetEnv`** + +## Table of contents + +### Properties + +- [output](sys.GetEnv.md#output) + +## Properties + +### output + +• **output**: `string` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/sys.JsExpr.md b/docs/interfaces/sys.JsExpr.md new file mode 100644 index 0000000..db406bf --- /dev/null +++ b/docs/interfaces/sys.JsExpr.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [sys](../modules/sys.md) / JsExpr + +# Interface: JsExpr<_Expr\> + +[sys](../modules/sys.md).JsExpr + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Expr` | extends `string` | + +## Hierarchy + +- [`Effect`](effect.Effect.md)<`any`\> + + ↳ **`JsExpr`** + +## Table of contents + +### Properties + +- [output](sys.JsExpr.md#output) + +## Properties + +### output + +• **output**: `any` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/sys.SetEvalEnvironment.md b/docs/interfaces/sys.SetEvalEnvironment.md new file mode 100644 index 0000000..4784697 --- /dev/null +++ b/docs/interfaces/sys.SetEvalEnvironment.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [sys](../modules/sys.md) / SetEvalEnvironment + +# Interface: SetEvalEnvironment<_Env\> + +[sys](../modules/sys.md).SetEvalEnvironment + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_Env` | extends ``"test.node"`` \| ``"node"`` | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`SetEvalEnvironment`** + +## Table of contents + +### Properties + +- [output](sys.SetEvalEnvironment.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/test.Assert.md b/docs/interfaces/test.Assert.md new file mode 100644 index 0000000..b066763 --- /dev/null +++ b/docs/interfaces/test.Assert.md @@ -0,0 +1,37 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [test](../modules/test.md) / Assert + +# Interface: Assert<_B\> + +[test](../modules/test.md).Assert + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_B` | extends `boolean` | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`Assert`** + +## Table of contents + +### Properties + +- [output](test.Assert.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/test.AssertEqualsK.md b/docs/interfaces/test.AssertEqualsK.md new file mode 100644 index 0000000..e6b4d63 --- /dev/null +++ b/docs/interfaces/test.AssertEqualsK.md @@ -0,0 +1,52 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [test](../modules/test.md) / AssertEqualsK + +# Interface: AssertEqualsK + +[test](../modules/test.md).AssertEqualsK + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Right` | extends `unknown` | + +## Hierarchy + +- [`Kind1`](effect.Kind1.md) + + ↳ **`AssertEqualsK`** + +## Table of contents + +### Properties + +- [input](test.AssertEqualsK.md#input) +- [return](test.AssertEqualsK.md#return) + +## Properties + +### input + +• **input**: `unknown` + +#### Inherited from + +[Kind1](effect.Kind1.md).[input](effect.Kind1.md#input) + +#### Defined in + +[effect.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L6) + +___ + +### return + +• **return**: [`AssertEquals`](../modules/test.md#assertequals)<`unknown`, `Right`\> + +#### Overrides + +[Kind1](effect.Kind1.md).[return](effect.Kind1.md#return) + +#### Defined in + +[test.ts:24](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/test.ts#L24) diff --git a/docs/interfaces/test.Config.md b/docs/interfaces/test.Config.md new file mode 100644 index 0000000..5919847 --- /dev/null +++ b/docs/interfaces/test.Config.md @@ -0,0 +1,5 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [test](../modules/test.md) / Config + +# Interface: Config + +[test](../modules/test.md).Config diff --git a/docs/interfaces/test.ShowAssertionError.md b/docs/interfaces/test.ShowAssertionError.md new file mode 100644 index 0000000..49ba54b --- /dev/null +++ b/docs/interfaces/test.ShowAssertionError.md @@ -0,0 +1,38 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [test](../modules/test.md) / ShowAssertionError + +# Interface: ShowAssertionError<_L, _R\> + +[test](../modules/test.md).ShowAssertionError + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_L` | extends `unknown` | +| `_R` | extends `unknown` | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`ShowAssertionError`** + +## Table of contents + +### Properties + +- [output](test.ShowAssertionError.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/test.Test.md b/docs/interfaces/test.Test.md new file mode 100644 index 0000000..66e6c93 --- /dev/null +++ b/docs/interfaces/test.Test.md @@ -0,0 +1,38 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [test](../modules/test.md) / Test + +# Interface: Test<_m, _effs\> + +[test](../modules/test.md).Test + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `_m` | extends `string` | +| `_effs` | extends [`Effect`](effect.Effect.md)[] | + +## Hierarchy + +- [`Effect`](effect.Effect.md) + + ↳ **`Test`** + +## Table of contents + +### Properties + +- [output](test.Test.md#output) + +## Properties + +### output + +• **output**: `unknown` + +#### Inherited from + +[Effect](effect.Effect.md).[output](effect.Effect.md#output) + +#### Defined in + +[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) diff --git a/docs/interfaces/util.ConstK.md b/docs/interfaces/util.ConstK.md new file mode 100644 index 0000000..d75c33a --- /dev/null +++ b/docs/interfaces/util.ConstK.md @@ -0,0 +1,52 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [util](../modules/util.md) / ConstK + +# Interface: ConstK + +[util](../modules/util.md).ConstK + +## Type parameters + +| Name | +| :------ | +| `Val` | + +## Hierarchy + +- [`Kind1`](effect.Kind1.md)<`unknown`, `Val`\> + + ↳ **`ConstK`** + +## Table of contents + +### Properties + +- [input](util.ConstK.md#input) +- [return](util.ConstK.md#return) + +## Properties + +### input + +• **input**: `unknown` + +#### Inherited from + +[Kind1](effect.Kind1.md).[input](effect.Kind1.md#input) + +#### Defined in + +[effect.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L6) + +___ + +### return + +• **return**: `Val` + +#### Overrides + +[Kind1](effect.Kind1.md).[return](effect.Kind1.md#return) + +#### Defined in + +[util.ts:13](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L13) diff --git a/docs/interfaces/util.IdK.md b/docs/interfaces/util.IdK.md new file mode 100644 index 0000000..c46bd22 --- /dev/null +++ b/docs/interfaces/util.IdK.md @@ -0,0 +1,46 @@ +[ts-types-lang](../README.md) / [Modules](../modules.md) / [util](../modules/util.md) / IdK + +# Interface: IdK + +[util](../modules/util.md).IdK + +## Hierarchy + +- [`Kind1`](effect.Kind1.md) + + ↳ **`IdK`** + +## Table of contents + +### Properties + +- [input](util.IdK.md#input) +- [return](util.IdK.md#return) + +## Properties + +### input + +• **input**: `unknown` + +#### Inherited from + +[Kind1](effect.Kind1.md).[input](effect.Kind1.md#input) + +#### Defined in + +[effect.ts:6](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L6) + +___ + +### return + +• **return**: `unknown` + +#### Overrides + +[Kind1](effect.Kind1.md).[return](effect.Kind1.md#return) + +#### Defined in + +[util.ts:9](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/util.ts#L9) -- cgit v1.3.1