From e75a5a15912b8f297fe9c9747f574486d6c4e334 Mon Sep 17 00:00:00 2001 From: Akshay Nair Date: Sat, 14 Jan 2023 18:16:41 +0530 Subject: chore: adds some docs --- docs/interfaces/ref.SetRef.md | 36 ++++++++++++------------------------ 1 file changed, 12 insertions(+), 24 deletions(-) (limited to 'docs/interfaces/ref.SetRef.md') diff --git a/docs/interfaces/ref.SetRef.md b/docs/interfaces/ref.SetRef.md index f198b95..52d6d59 100644 --- a/docs/interfaces/ref.SetRef.md +++ b/docs/interfaces/ref.SetRef.md @@ -4,35 +4,23 @@ [ref](../modules/ref.md).SetRef +Generic interface for declaring effects + +**`Example`** + +```ts +interface MyEffect extends Effect {} +``` + ## Type parameters -| Name | Type | -| :------ | :------ | -| `_Key` | extends [`Ref`](../modules/ref.md#ref) | -| `_Val` | `_Val` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `_Key` | extends [`Ref`](../modules/ref.md#ref) | The output generated by the effect (defaults to `unknown`) | +| `_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) -- cgit v1.3.1