Improve Data.Error / TaggedError (#1483)

Effect-TS · Oct 5, 2023 · e68453b · e68453b
1 parent 3ace6fd
commit e68453b
Show file tree

Hide file tree

Showing 134 changed files with 289 additions and 332 deletions.
diff --git a/.changeset/clever-windows-heal.md b/.changeset/clever-windows-heal.md
@@ -0,0 +1,5 @@
+---
+"effect": minor
+---
+
+Include stack in Data.Error/Data.TaggedError
diff --git a/.changeset/forty-rockets-build.md b/.changeset/forty-rockets-build.md
@@ -0,0 +1,5 @@
+---
+"effect": minor
+---
+
+Include Error module in Data
diff --git a/.gitignore b/.gitignore
@@ -44,7 +44,6 @@ dist/
 /Encoding
 /Equal
 /Equivalence
-/Error
 /ExecutionStrategy
 /Exit
 /Fiber

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -40,7 +40,6 @@
     "Encoding": true,
     "Equal": true,
     "Equivalence": true,
-    "Error": true,
     "ExecutionStrategy": true,
     "Exit": true,
     "Fiber": true,

diff --git a/docs/modules/Data.ts.md b/docs/modules/Data.ts.md
@@ -14,8 +14,10 @@ Added in v2.0.0
 
 - [constructors](#constructors)
   - [Class](#class)
+  - [Error](#error)
   - [Structural](#structural)
   - [TaggedClass](#taggedclass)
+  - [TaggedError](#taggederror)
   - [array](#array)
   - [case](#case)
   - [struct](#struct)
@@ -28,6 +30,7 @@ Added in v2.0.0
   - [Case (interface)](#case-interface)
   - [Data (type alias)](#data-type-alias)
   - [TaggedEnum (type alias)](#taggedenum-type-alias)
+  - [YieldableError (interface)](#yieldableerror-interface)
 - [utils](#utils)
   - [Case (namespace)](#case-namespace)
     - [Constructor (interface)](#constructor-interface)
@@ -55,6 +58,20 @@ export declare const Class: new <A extends Record<string, any>>(
 
 Added in v2.0.0
 
+## Error
+
+Provides a constructor for a Case Class.
+
+**Signature**
+
+```ts
+export declare const Error: new <A extends Record<string, any>>(
+  args: Types.Equals<Omit<A, keyof Equal.Equal>, {}> extends true ? void : Omit<A, keyof Equal.Equal>
+) => YieldableError & A
+```
+
+Added in v2.0.0
+
 ## Structural
 
 **Signature**
@@ -83,6 +100,20 @@ export declare const TaggedClass: <Tag extends string>(
 
 Added in v2.0.0
 
+## TaggedError
+
+**Signature**
+
+```ts
+export declare const TaggedError: <Tag extends string>(
+  tag: Tag
+) => new <A extends Record<string, any>>(
+  args: Types.Equals<Omit<A, keyof Equal.Equal>, {}> extends true ? void : Omit<A, keyof Equal.Equal>
+) => YieldableError & { readonly _tag: Tag } & A
+```
+
+Added in v2.0.0
+
 ## array
 
 **Signature**
@@ -288,6 +319,29 @@ export type TaggedEnum<A extends Record<string, Record<string, any>>> = {
 
 Added in v2.0.0
 
+## YieldableError (interface)
+
+**Signature**
+
+```ts
+export interface YieldableError extends Case, Pipeable, Inspectable.Inspectable {
+  readonly [Effectable.EffectTypeId]: Effect.Effect.VarianceStruct<never, this, never>
+  readonly [Effectable.StreamTypeId]: Effect.Effect.VarianceStruct<never, this, never>
+  readonly [Effectable.SinkTypeId]: Sink.Sink.VarianceStruct<never, this, unknown, never, never>
+  readonly [Effectable.ChannelTypeId]: Channel.Channel.VarianceStruct<
+    never,
+    unknown,
+    unknown,
+    unknown,
+    this,
+    never,
+    never
+  >
+}
+```
+
+Added in v2.0.0
+
 # utils
 
 ## Case (namespace)

diff --git a/docs/modules/Error.ts.md b/docs/modules/Error.ts.md
diff --git a/docs/modules/ExecutionStrategy.ts.md b/docs/modules/ExecutionStrategy.ts.md
@@ -1,6 +1,6 @@
 ---
 title: ExecutionStrategy.ts
-nav_order: 35
+nav_order: 34
 parent: Modules
 ---
 

diff --git a/docs/modules/Exit.ts.md b/docs/modules/Exit.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Exit.ts
-nav_order: 36
+nav_order: 35
 parent: Modules
 ---
 

diff --git a/docs/modules/Fiber.ts.md b/docs/modules/Fiber.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Fiber.ts
-nav_order: 37
+nav_order: 36
 parent: Modules
 ---
 

diff --git a/docs/modules/FiberId.ts.md b/docs/modules/FiberId.ts.md
@@ -1,6 +1,6 @@
 ---
 title: FiberId.ts
-nav_order: 38
+nav_order: 37
 parent: Modules
 ---
 

diff --git a/docs/modules/FiberRef.ts.md b/docs/modules/FiberRef.ts.md
@@ -1,6 +1,6 @@
 ---
 title: FiberRef.ts
-nav_order: 39
+nav_order: 38
 parent: Modules
 ---
 

diff --git a/docs/modules/FiberRefs.ts.md b/docs/modules/FiberRefs.ts.md
@@ -1,6 +1,6 @@
 ---
 title: FiberRefs.ts
-nav_order: 40
+nav_order: 39
 parent: Modules
 ---
 

diff --git a/docs/modules/FiberRefsPatch.ts.md b/docs/modules/FiberRefsPatch.ts.md
@@ -1,6 +1,6 @@
 ---
 title: FiberRefsPatch.ts
-nav_order: 41
+nav_order: 40
 parent: Modules
 ---
 

diff --git a/docs/modules/FiberStatus.ts.md b/docs/modules/FiberStatus.ts.md
@@ -1,6 +1,6 @@
 ---
 title: FiberStatus.ts
-nav_order: 42
+nav_order: 41
 parent: Modules
 ---
 

diff --git a/docs/modules/Function.ts.md b/docs/modules/Function.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Function.ts
-nav_order: 43
+nav_order: 42
 parent: Modules
 ---
 

diff --git a/docs/modules/GlobalValue.ts.md b/docs/modules/GlobalValue.ts.md
@@ -1,6 +1,6 @@
 ---
 title: GlobalValue.ts
-nav_order: 44
+nav_order: 43
 parent: Modules
 ---
 

diff --git a/docs/modules/GroupBy.ts.md b/docs/modules/GroupBy.ts.md
@@ -1,6 +1,6 @@
 ---
 title: GroupBy.ts
-nav_order: 45
+nav_order: 44
 parent: Modules
 ---
 

diff --git a/docs/modules/HKT.ts.md b/docs/modules/HKT.ts.md
@@ -1,6 +1,6 @@
 ---
 title: HKT.ts
-nav_order: 49
+nav_order: 48
 parent: Modules
 ---
 

diff --git a/docs/modules/Hash.ts.md b/docs/modules/Hash.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Hash.ts
-nav_order: 46
+nav_order: 45
 parent: Modules
 ---
 

diff --git a/docs/modules/HashMap.ts.md b/docs/modules/HashMap.ts.md
@@ -1,6 +1,6 @@
 ---
 title: HashMap.ts
-nav_order: 47
+nav_order: 46
 parent: Modules
 ---
 

diff --git a/docs/modules/HashSet.ts.md b/docs/modules/HashSet.ts.md
@@ -1,6 +1,6 @@
 ---
 title: HashSet.ts
-nav_order: 48
+nav_order: 47
 parent: Modules
 ---
 

diff --git a/docs/modules/Inspectable.ts.md b/docs/modules/Inspectable.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Inspectable.ts
-nav_order: 51
+nav_order: 50
 parent: Modules
 ---
 

diff --git a/docs/modules/KeyedPool.ts.md b/docs/modules/KeyedPool.ts.md
@@ -1,6 +1,6 @@
 ---
 title: KeyedPool.ts
-nav_order: 52
+nav_order: 51
 parent: Modules
 ---
 

diff --git a/docs/modules/Layer.ts.md b/docs/modules/Layer.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Layer.ts
-nav_order: 53
+nav_order: 52
 parent: Modules
 ---
 

diff --git a/docs/modules/List.ts.md b/docs/modules/List.ts.md
@@ -1,6 +1,6 @@
 ---
 title: List.ts
-nav_order: 54
+nav_order: 53
 parent: Modules
 ---
 

diff --git a/docs/modules/LogLevel.ts.md b/docs/modules/LogLevel.ts.md
@@ -1,6 +1,6 @@
 ---
 title: LogLevel.ts
-nav_order: 56
+nav_order: 55
 parent: Modules
 ---
 

diff --git a/docs/modules/LogSpan.ts.md b/docs/modules/LogSpan.ts.md
@@ -1,6 +1,6 @@
 ---
 title: LogSpan.ts
-nav_order: 57
+nav_order: 56
 parent: Modules
 ---
 

diff --git a/docs/modules/Logger.ts.md b/docs/modules/Logger.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Logger.ts
-nav_order: 55
+nav_order: 54
 parent: Modules
 ---
 

diff --git a/docs/modules/Metric.ts.md b/docs/modules/Metric.ts.md
@@ -1,6 +1,6 @@
 ---
 title: Metric.ts
-nav_order: 58
+nav_order: 57
 parent: Modules
 ---
 

diff --git a/docs/modules/MetricBoundaries.ts.md b/docs/modules/MetricBoundaries.ts.md
@@ -1,6 +1,6 @@
 ---
 title: MetricBoundaries.ts
-nav_order: 59
+nav_order: 58
 parent: Modules
 ---
 

diff --git a/docs/modules/MetricHook.ts.md b/docs/modules/MetricHook.ts.md
@@ -1,6 +1,6 @@
 ---
 title: MetricHook.ts
-nav_order: 60
+nav_order: 59
 parent: Modules
 ---