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/effect.Effect.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/effect.Effect.md')
| -rw-r--r-- | docs/interfaces/effect.Effect.md | 30 |
1 files changed, 11 insertions, 19 deletions
diff --git a/docs/interfaces/effect.Effect.md b/docs/interfaces/effect.Effect.md index 2c5287f..1ac2c7f 100644 --- a/docs/interfaces/effect.Effect.md +++ b/docs/interfaces/effect.Effect.md @@ -4,11 +4,19 @@ [effect](../modules/effect.md).Effect +Generic interface for declaring effects + +**`Example`** + +```ts +interface MyEffect extends Effect<string[]> {} +``` + ## Type parameters -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `T` | `unknown` | The output generated by the effect (defaults to `unknown`) | ## Hierarchy @@ -69,19 +77,3 @@ ↳ [`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) |