Merge pull request #3 from nakanoasaservice/feature/change-default-cause

feat!: Change default 'cause' type to undefined for type safety

Author: nakanoasaservice

deno.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.7",
+  "version": "1.0.0",
   "name": "@nakanoaas/tagged-error",
   "license": "MIT",
   "exports": "./index.ts",

index.test.ts

@@ -75,7 +75,7 @@ describe("TaggedError in practice", () => {
       result.message,
       "Cannot calculate square root of negative number",
     );
-    assertEquals(result.cause.value, -10);
+    assertEquals(result.cause?.value, -10);
   });
 });
 

index.ts

@@ -2,7 +2,7 @@
  * Options for creating a TaggedError
  * @template Cause - The type of the cause data
  */
-interface TaggedErrorOptions<Cause = never> {
+interface TaggedErrorOptions<Cause = undefined> {
   /** Optional error message */
   message?: string;
   /** Optional cause data */
@@ -31,7 +31,7 @@ interface TaggedErrorOptions<Cause = never> {
  * }
  * ```
  */
-export class TaggedError<Tag extends string, Cause = never> extends Error {
+export class TaggedError<Tag extends string, Cause = undefined> extends Error {
   /** The tag identifying the type of error */
   tag: Tag;
   /** The cause data associated with the error */

llms.txt

@@ -40,7 +40,7 @@ Tagged Error is a TypeScript library that provides type-safe error handling with
 
 ## Type Parameters
 - `Tag extends string`: The literal string type of the error tag
-- `Cause = never`: The type of the cause data (optional)
+- `Cause = undefined`: The type of the cause data (optional)
 
 ## Constructor
 ```typescript