p-safe 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Shahrad Elahi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# p-safe
+
+> Safely handle promise rejections
+
+[![codecov](https://codecov.io/gh/shahradelahi/p-safe/branch/master/graph/badge.svg)](https://codecov.io/gh/shahradelahi/p-safe)
+[![npm](https://img.shields.io/npm/v/p-safe)](https://www.npmjs.com/package/p-safe)
+[![npm bundle size](https://packagephobia.now.sh/badge?p=p-safe)](https://packagephobia.now.sh/result?p=p-safe)
+
+### Install
+
+```bash
+npm install p-safe
+```
+
+### Usage
+
+```typescript
+import { trySafe, type SafeReturn } from 'p-safe';
+
+const { error } = trySafe(async (): SafeReturn<never, Error> => {
+  await promiseThatMightReject();
+  await fetch('...');
+});
+
+if (error) {
+  // Handle error
+  console.error(error);
+  return;
+}
+
+console.log(error); // undefined
+```
+
+Or implement your function and only use `SafeReturn` type:
+
+```typescript
+import type { SafeReturn } from 'p-safe';
+
+async function foo(): Promise<SafeReturn<object, Error>> {
+  const resp = await fetch('...');
+  if (!resp.ok) {
+    return { error: new Error('Request failed for a silly reason') };
+  }
+  return { data: await resp.json() };
+}
+
+const { data, error } = await foo();
+
+if (error) {
+  // Handle error
+  console.error(error);
+  return;
+}
+
+console.log(error); // undefined
+console.log(data); // { ... }
+```
+
+Are you still confused? Let me explain it in a simple way. `p-safe` is a simple utility that helps you to safely handle
+promise rejections. It's a simple and clean way to handle promise rejections without using `try/catch` blocks.
+
+Check out the [tests](/index.test.ts) for more examples.
+
+## Related
+
+- [p-catch-if](https://github.com/sindresorhus/p-catch-if) - Conditional promise catch handler
+- [p-if](https://github.com/sindresorhus/p-if) - Conditional promise chains
+- [p-tap](https://github.com/sindresorhus/p-tap) - Tap into a promise chain without affecting its value or state
+- [p-log](https://github.com/sindresorhus/p-log) - Log the value/error of a promise
+- [More…](https://github.com/sindresorhus/promise-fun)
+
+### License
+
+[MIT](/LICENSE) © [Shahrad Elahi](https://github.com/shahradelahi)

package/dist/index.d.mts

@@ -0,0 +1,14 @@
+type SafeReturn<T, K = Error> = Partial<{
+    data: T;
+    error: K;
+}> & ({
+    data: T;
+    error?: never;
+} | {
+    data?: never;
+    error: K;
+});
+type TrySafeFn<T, K> = () => SafeReturn<T, K> | Promise<SafeReturn<T, K>> | void | Promise<void>;
+declare function trySafe<T = void, E = Error>(fn: TrySafeFn<T, E>): Promise<SafeReturn<T, E>>;
+
+export { type SafeReturn, type TrySafeFn, trySafe };

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+type SafeReturn<T, K = Error> = Partial<{
+    data: T;
+    error: K;
+}> & ({
+    data: T;
+    error?: never;
+} | {
+    data?: never;
+    error: K;
+});
+type TrySafeFn<T, K> = () => SafeReturn<T, K> | Promise<SafeReturn<T, K>> | void | Promise<void>;
+declare function trySafe<T = void, E = Error>(fn: TrySafeFn<T, E>): Promise<SafeReturn<T, E>>;
+
+export { type SafeReturn, type TrySafeFn, trySafe };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var o=Object.defineProperty;var i=Object.getOwnPropertyDescriptor;var T=Object.getOwnPropertyNames;var f=Object.prototype.hasOwnProperty;var d=(e,r)=>{for(var a in r)o(e,a,{get:r[a],enumerable:!0})},u=(e,r,a,n)=>{if(r&&typeof r=="object"||typeof r=="function")for(let t of T(r))!f.call(e,t)&&t!==a&&o(e,t,{get:()=>r[t],enumerable:!(n=i(r,t))||n.enumerable});return e};var s=e=>u(o({},"__esModule",{value:!0}),e);var S={};d(S,{trySafe:()=>y});module.exports=s(S);async function y(e){try{let r=await e();return typeof r=="object"?r:{data:void 0,error:void 0}}catch(r){return{error:r}}}0&&(module.exports={trySafe});

package/dist/index.mjs

@@ -0,0 +1 @@
+async function t(e){try{let r=await e();return typeof r=="object"?r:{data:void 0,error:void 0}}catch(r){return{error:r}}}export{t as trySafe};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "p-safe",
+  "version": "0.1.0",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "test": "mocha \"**/*.test.ts\"",
+    "typecheck": "tsc --noEmit",
+    "format:check": "prettier --check \"**/*.{ts,md}\"",
+    "format": "prettier --write .",
+    "prepublishOnly": "pnpm test && pnpm run format:check && pnpm run typecheck && pnpm build"
+  },
+  "packageManager": "pnpm@8.15.0",
+  "devDependencies": {
+    "@types/chai": "^4.3.12",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.11.28",
+    "chai": "^5.1.0",
+    "mocha": "^10.3.0",
+    "prettier": "^3.2.5",
+    "tsd": "^0.30.7",
+    "tsup": "^8.0.2",
+    "tsx": "^4.7.1",
+    "typescript": "^5.4.2"
+  },
+  "license": "MIT",
+  "author": "Shahrad Elahi <shahrad@litehex.com> (https://github.com/shahradelahi)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/shahradelahi/p-safe.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "keywords": [
+    "promise",
+    "safe",
+    "try"
+  ]
+}