safe-clone-async 1.0.0

package/README.md

@@ -0,0 +1,83 @@
+# safe-clone-async
+
+A clean, safe alternative to `try/catch` for async code. 
+Inspired by `safe-await`, `safe-clone` wraps your promises and returns a tuple `[data, error]`, ensuring your code never throws unhandled errors.
+
+## Features
+
+- ✅ **Never throws**: Errors are caught and returned as values.
+- ✅ **Type-safe**: Generic support for return types and error types.
+- ✅ **Works with any Promise**: Compatible with all async functions and libraries.
+- ✅ **Dual Support**: Works with both **ES Modules (ESM)** and **CommonJS (CJS)**.
+- ✅ **Zero Dependencies**: Lightweight and fast.
+
+## Installation
+
+```bash
+npm install safe-clone-async
+```
+
+## Usage
+
+### Basic Usage
+
+Use `safeClone` to wrap any promise. It returns an array where the first element is the data (or null) and the second is the error (or null).
+
+```typescript
+import { safeClone } from 'safe-clone-async';
+
+async function getUser() {
+  const [user, error] = await safeClone(fetchUser(1));
+
+  if (error) {
+    console.error('Failed to fetch user:', error);
+    return;
+  }
+
+  console.log('User data:', user);
+}
+```
+
+### With Custom Error Types
+
+You can specify the error type for better type safety.
+
+```typescript
+import { safeClone } from 'safe-clone-async';
+
+interface ApiError {
+  message: string;
+  code: number;
+}
+
+// ... inside async function
+const [data, error] = await safeClone<User, ApiError>(fetchUser(1));
+
+if (error) {
+  // error is typed as ApiError
+  console.log(error.code); 
+}
+```
+
+### CommonJS (require)
+
+```javascript
+const { safeClone } = require('safe-clone-async');
+
+safeClone(somePromise).then(([data, error]) => {
+  // ...
+});
+```
+
+## API
+
+### `safeClone<T, E = Error>(promise: Promise<T>): Promise<[T | null, E | null]>`
+
+- **promise**: The promise to execute.
+- **Returns**: A promise that resolves to:
+  - `[data, null]` if the promise resolves.
+  - `[null, error]` if the promise rejects.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,8 @@
+/**
+ * A safe wrapper for promises that returns a tuple [data, error]
+ * @param promise The promise to wrap
+ * @returns A tuple containing [data, null] if successful, or [null, error] if failed
+ */
+declare function safeClone<T, E = Error>(promise: Promise<T>): Promise<[T, null] | [null, E]>;
+
+export { safeClone as default, safeClone };

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * A safe wrapper for promises that returns a tuple [data, error]
+ * @param promise The promise to wrap
+ * @returns A tuple containing [data, null] if successful, or [null, error] if failed
+ */
+declare function safeClone<T, E = Error>(promise: Promise<T>): Promise<[T, null] | [null, E]>;
+
+export { safeClone as default, safeClone };

package/dist/index.js

@@ -0,0 +1,40 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default,
+  safeClone: () => safeClone
+});
+module.exports = __toCommonJS(index_exports);
+async function safeClone(promise) {
+  try {
+    const data = await promise;
+    return [data, null];
+  } catch (error) {
+    return [null, error];
+  }
+}
+var index_default = safeClone;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  safeClone
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * A safe wrapper for promises that returns a tuple [data, error]\n * @param promise The promise to wrap\n * @returns A tuple containing [data, null] if successful, or [null, error] if failed\n */\nexport async function safeClone<T, E = Error>(\n  promise: Promise<T>\n): Promise<[T, null] | [null, E]> {\n  try {\n    const data = await promise;\n    return [data, null];\n  } catch (error) {\n    return [null, error as E];\n  }\n}\n\nexport default safeClone;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,eAAsB,UACpB,SACgC;AAChC,MAAI;AACF,UAAM,OAAO,MAAM;AACnB,WAAO,CAAC,MAAM,IAAI;AAAA,EACpB,SAAS,OAAO;AACd,WAAO,CAAC,MAAM,KAAU;AAAA,EAC1B;AACF;AAEA,IAAO,gBAAQ;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,15 @@
+// src/index.ts
+async function safeClone(promise) {
+  try {
+    const data = await promise;
+    return [data, null];
+  } catch (error) {
+    return [null, error];
+  }
+}
+var index_default = safeClone;
+export {
+  index_default as default,
+  safeClone
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * A safe wrapper for promises that returns a tuple [data, error]\n * @param promise The promise to wrap\n * @returns A tuple containing [data, null] if successful, or [null, error] if failed\n */\nexport async function safeClone<T, E = Error>(\n  promise: Promise<T>\n): Promise<[T, null] | [null, E]> {\n  try {\n    const data = await promise;\n    return [data, null];\n  } catch (error) {\n    return [null, error as E];\n  }\n}\n\nexport default safeClone;\n"],"mappings":";AAKA,eAAsB,UACpB,SACgC;AAChC,MAAI;AACF,UAAM,OAAO,MAAM;AACnB,WAAO,CAAC,MAAM,IAAI;AAAA,EACpB,SAAS,OAAO;AACd,WAAO,CAAC,MAAM,KAAU;AAAA,EAC1B;AACF;AAEA,IAAO,gBAAQ;","names":[]}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "safe-clone-async",
+  "version": "1.0.0",
+  "description": "A clean alternative to try/catch for async code, returning a tuple [data, error].",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest",
+    "lint": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "async",
+    "await",
+    "try-catch",
+    "error-handling",
+    "safe",
+    "promise",
+    "tuple"
+  ],
+  "author": "Ahmer Arain",
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^1.0.0",
+    "@types/node": "^20.0.0"
+  }
+}