diff options
| author | Akshay Nair <phenax5@gmail.com> | 2023-01-14 18:16:41 +0530 |
|---|---|---|
| committer | Akshay Nair <phenax5@gmail.com> | 2023-01-14 18:16:41 +0530 |
| commit | e75a5a15912b8f297fe9c9747f574486d6c4e334 (patch) | |
| tree | 603cd3b9fa68e6e0bd700fe66fede80e9ae657c9 /docs/interfaces/stdio.Debug.md | |
| parent | 78e384c2f32996478edced59c837a348dec77e57 (diff) | |
| download | ts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.tar.gz ts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.zip | |
chore: adds some docs
Diffstat (limited to 'docs/interfaces/stdio.Debug.md')
| -rw-r--r-- | docs/interfaces/stdio.Debug.md | 36 |
1 files changed, 12 insertions, 24 deletions
diff --git a/docs/interfaces/stdio.Debug.md b/docs/interfaces/stdio.Debug.md index 79d59f3..2f127bd 100644 --- a/docs/interfaces/stdio.Debug.md +++ b/docs/interfaces/stdio.Debug.md @@ -4,35 +4,23 @@ [stdio](../modules/stdio.md).Debug +Generic interface for declaring effects + +**`Example`** + +```ts +interface MyEffect extends Effect<string[]> {} +``` + ## Type parameters -| Name | Type | -| :------ | :------ | -| `_` | extends `string` | -| `T` | `T` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `_` | extends `string` | The output generated by the effect (defaults to `unknown`) | +| `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) |