diff options
Diffstat (limited to 'docs/interfaces/fs.ReadFile.md')
| -rw-r--r-- | docs/interfaces/fs.ReadFile.md | 34 |
1 files changed, 11 insertions, 23 deletions
diff --git a/docs/interfaces/fs.ReadFile.md b/docs/interfaces/fs.ReadFile.md index f0462c0..81bfbc6 100644 --- a/docs/interfaces/fs.ReadFile.md +++ b/docs/interfaces/fs.ReadFile.md @@ -4,34 +4,22 @@ [fs](../modules/fs.md).ReadFile +Generic interface for declaring effects + +**`Example`** + +```ts +interface MyEffect extends Effect<string[]> {} +``` + ## Type parameters -| Name | Type | -| :------ | :------ | -| `_Path` | extends `string` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `_Path` | extends `string` | The output generated by the effect (defaults to `unknown`) | ## 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) |