Merge pull request #4 from dancastillo/v0.0.3-docs-and-types

fix: documentation and types exporting

CHANGELOG.md

@@ -1,5 +1,11 @@
 # @dancastillo/error
 
+## 0.0.3
+
+### Patch Changes
+
+- Update documentation and exporting types
+
 ## 0.0.2
 
 ### Patch Changes

README.md

@@ -4,30 +4,46 @@ A small utility for generating consistent errors
 
 ### Install
 
+npm
+
 ```bash
 npm install @dancastillo/error
 ```
 
+yarn
+
+```bash
+npm add @dancastillo/error
+```
+
+pnpm
+
+```bash
+pnpm install @dancastillo/error
+```
+
 ### Usage
 
 ```
-createError(code, message [, details [, statusCode [, error]]])
+createError(code, message [, details [, meta]])
 ```
 
-- `code` (`string`, required) - The error code, you can access it via`error.code`. For consistency, it is recommended using [ErrorCode](./src/types/index.ts)
-- `message` (`string`, required) - The error message. This can be customized to use interpolated strings for formatting the message.
+- `code` (`number | string`, required) - The error code, you can access it via`error.code`. For http error, it is recommended using [ErrorCode](./src/types/http.types.ts)
+- `message` (`string`, required) - The error message.
 - `details` (`string[]`, optional) - The error details. You can include additional information about the error that has occurred. Default is an empty array.
-- `statusCode` (`number`, optional) - The status code that will be used if you want to sent via HTTP. Note this will be automatically populated based on the `code` you pass in
+- `meta` (`T`, optional) - Additional metadata that you can pass in with generic.
 
 ```js
-import createError from '@dancastillo/error
+import { createError, type DCError} from '@dancastillo/error
 
-const CreatedError = createError('INTERNAL_ERROR', 'Error happened')
+type Meta = { userId: string }
 
-const err = CreatedError()
+const err = createError<Meta>('INTERNAL_ERROR', 'Error happened', ['Details'], { userId: 'some-user-id' })
 
 console.log(err.code)    // 'INTERNAL_ERROR'
 console.log(err.message) // 'Error happened'
+console.log(err.details) // ['Details']
+console.log(err.meta) // { userId: 'some-user-id' }
 ```
 
 ## License

package.json

@@ -1,15 +1,15 @@
 {
   "name": "@dancastillo/error",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A small utility for generating consistent errors",
   "main": "dist/index.js",
   "type": "module",
   "types": "dist/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
   "homepage": "https://github.com/dancastillo/error#readme",
@@ -35,8 +35,8 @@
     "format:check": "prettier --write .",
     "lint": "eslint ./src",
     "prepare": "husky",
-    "build": "tsup",
-    "prepublish": "npm run build && npm run lint && npm run format:check && npm run test"
+    "build": "rm -rf dist && tsup",
+    "prepublish": "npm run lint && npm run format:check && npm run test && npm run build"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.7",

src/types/dc-error.ts

@@ -1,4 +1,4 @@
-export type DCError<T> = {
+export type DCError<T = unknown> = {
   /**
    * The error message.
    */