feat: v0.0.2 update package - all (#15)

Author: dancastillo

.gitignore

@@ -129,5 +129,6 @@ dist
 .yarn/install-state.gz
 .pnp.*
 
-# pnpm dependencies
+# dependencies
 pnpm-lock.yaml
+package-lock.json

.husky/pre-commit

@@ -1 +1 @@
-pnpm lint && pnpm format && pnpm exec lint-staged
+npm run prepublish

README.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-A package to handle errors as a result and not throw errors
+A package to handle results. Success, errors or partial success as results and not throw errors
 
 ## Installation
 
@@ -19,48 +19,57 @@ pnpm install @dancastillo/nothrow
 
 ## Usage
 
+#### TypeScript
+
 ```typescript
-import { Result } from '@dancastillo/nothrow'
+import {
+  type Result,
+  createSuccessfulResult,
+  createFailureResult,
+  createPartialSuccessfulResult,
+} from '@dancastillo/nothrow'
 ```
 
-## API Documentation
+## Method Documentation
 
-### `successful`
+### `createSuccessfulResult`
 
 Constructs a successful result with no errors
 
 ```typescript
-const result = Result.successful({ success: true })
+const result = createSuccessfulResult({ success: true })
 // result.data = { success: true }
-// result.errors = undefined
+// result.errors = []
 ```
 
-### `failure`
+### `createFailureResult`
 
-Constructs a failed result with no data
+Constructs a failure result with no data
 
 ```typescript
-const result = Result.failure({ success: false })
-// result.data = undefined
-// result.errors = { success: false }
+const result = createFailureResult([{ error: true }])
+// result.data = null
+// result.errors = [{ success: false }]
 ```
 
-### `partialSuccess`
+### `createPartialSuccessResult`
 
 Constructs a result with data and errors
 
 ```typescript
-const result = Result.partialSuccess({ success: true }, [{ error: 'Missing input' }, { error: 'Not found' }])
+const result = createPartialSuccessReuslt({ success: true }, [{ error: 'Missing input' }, { error: 'Not found' }])
 // result.data ={ success: true }
 // result.errors = [{ error: 'Missing input' }, { error: 'Not found' }]
 ```
 
-### `map`
+## API Documentation
+
+### `mapTo`
 
 Map the data result and errors result to the wanted type. This method takes in two functions as its arguments
 
 ```typescript
-const mappedResult = result.map(
+const mappedResult = result.mapTo(
   (data: DataType) => {
     return <MappedDataType>{ id: data.id }
   },
@@ -96,35 +105,15 @@ const mappedResult = result.mapErrors((errors: ErrorType) => {
 
 ### `isSuccessful`
 
-Returns `TRUE` if the result was successful and no errors
+Returns `boolean`
 
 ### `isFailure`
 
-Returns `TRUE` if the result was N error reults and no data
+Returns `boolean`
 
 ### `isPartialSuccess`
 
-Returns `FALSE` if the result returned both a data result and error result
-
-### `hasData`
-
-Helper method to determine if the `Result` has data value set
-
-### `getData`
-
-Helper method to retrieve the `Result` data value set
-
-### `hasErrors`
-
-Helper method to determine if the `Result` has error values set
-
-### `getErrors`
-
-Helper method to retrieve the `Result` error values set
-
-### `errorCount`
-
-Helper method to retrieve the `Result` error values count
+Returns `boolean`
 
 ### License
 

package.json

@@ -1,14 +1,15 @@
 {
   "name": "@dancastillo/nothrow",
-  "version": "0.0.1",
-  "description": "A package to handle errors as a result",
+  "version": "0.0.2",
+  "description": "A package to handle results. Success, errors or partial success as results and not throw errors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "type": "module",
   "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/nothrow",
@@ -25,23 +26,22 @@
     "dist"
   ],
   "keywords": [
-    "error",
     "nothrow",
     "result",
-    "throw"
+    "error",
+    "result",
+    "partialSuccess"
   ],
   "scripts": {
-    "test": "tsc --project tsconfig.test.json && borp --coverage",
-    "format": "prettier --check .",
-    "format:fix": "prettier --write .",
+    "test": "rm -rf dist && tsc --project tsconfig.test.json && borp --coverage",
+    "format:check": "prettier --check .",
+    "format": "prettier --write .",
     "lint": "eslint ./src",
     "prepare": "husky",
-    "build": "tsup",
-    "check-exports": "attw --pack .",
-    "prepublish": "pnpm build && pnpm check-exports && pnpm lint && pnpm format && pnpm test"
+    "build": "rm -rf dist && tsup",
+    "prepublish": "pnpm lint && pnpm format:check && pnpm test && pnpm build"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.0",
     "@changesets/cli": "^2.27.7",
     "@eslint/js": "^9.9.1",
     "@types/node": "^22.5.0",

src/error/error-result.ts

@@ -1,9 +1,4 @@
 /**
  * Result Class object
  */
-export { Result } from './result'
-
-/**
- * Type
- */
-export type { Undefinable } from './types'
+export { type Result, createSuccessfulResult, createFailureResult, createPartialSuccessfulResult } from './result.js'