@prexjs/promise 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Prexjs (https://prexjs.com)
+Copyright (c) 2026 Sorabh (https://sorabh.org)
+
+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

@@ -1,3 +1,82 @@
-# Temporary Holding Version
+# @prexjs/promise
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Lightweight, zero-dependency type guard utility to test if a value is a Promise or Thenable.**
+
+[![npm version](https://img.shields.io/npm/v/@prexjs/promise)](https://www.npmjs.com/package/@prexjs/promise)
+[![npm downloads](https://img.shields.io/npm/dm/@prexjs/promise)](https://www.npmjs.com/package/@prexjs/promise)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-supported-blue)](https://www.typescriptlang.org/)
+
+`@prexjs/promise` provides an ultra-fast, robust TypeScript type guard `isPromise(val)` to determine if a value is an ES6 Promise, async thenable, or third-party promise (Bluebird, Q, etc.).
+
+## Features
+
+- Validates whether an object or function qualifies as a Promise/A+ thenable.
+- TypeScript user-defined type guard narrowing (`value is PromiseLike<T>`).
+- Dual ES Module (`.mjs`) and CommonJS (`.cjs`) support with TypeScript definitions.
+- Zero runtime dependencies.
+
+## Installation
+
+Install using your preferred package manager:
+
+```bash
+# npm
+npm install @prexjs/promise
+
+# pnpm
+pnpm add @prexjs/promise
+
+# Yarn
+yarn add @prexjs/promise
+
+# Bun
+bun add @prexjs/promise
+```
+
+## Quick start
+
+```ts
+import isPromise from '@prexjs/promise';
+
+console.log(isPromise(Promise.resolve('antigravity'))); // true
+console.log(isPromise({ then: (resolve) => resolve(1) })); // true
+console.log(isPromise('not a promise')); // false
+console.log(isPromise(null)); // false
+```
+
+Both default and named exports are supported:
+
+```ts
+import isPromise, { isPromise as namedIsPromise } from '@prexjs/promise';
+```
+
+## Examples
+
+### Handling synchronous or asynchronous results
+
+```ts
+import isPromise from '@prexjs/promise';
+
+function handle(result: unknown) {
+  if (isPromise(result)) {
+    result.then((val) => {
+      console.log('Async resolved:', val);
+    });
+  } else {
+    console.log('Sync result:', result);
+  }
+}
+```
+
+## Compatibility
+
+`@prexjs/promise` runs anywhere ECMAScript executes (Node.js, Deno, Bun, and all browsers).
+
+## License
+
+This project is licensed under the MIT License. See [LICENSE](./LICENSE) for the full license text.
+
+## Related projects
+
+- [prex.js](https://github.com/prexjs/prex.js) — prex.js monorepo and ecosystem.

package/lib/index.cjs

@@ -0,0 +1,7 @@
+/*!
+ * @prexjs/promise
+ * Copyright (c) 2026 Prexjs (https://prexjs.com)
+ * Copyright (c) 2026 Sorabh (https://Sorabh.org)
+ * MIT Licensed
+ */
+"use strict";function e(e){return!!e&&("object"==typeof e||"function"==typeof e)&&"function"==typeof e.then}Object.defineProperty(exports,"__esModule",{value:!0}),e.default=e,e.isPromise=e,exports.default=e,exports.isPromise=e;

package/lib/index.d.cts

@@ -0,0 +1,12 @@
+/**
+ * Checks whether a value is a promise or any "thenable"
+ * (an object or function with a `then` method).
+ *
+ * @example
+ * isPromise(Promise.resolve(1)); // true
+ * isPromise({ then() {} });      // true
+ * isPromise(42);                 // false
+ */
+declare function isPromise<T, S>(obj: PromiseLike<T> | S): obj is PromiseLike<T>;
+
+export { isPromise as default, isPromise };

package/lib/index.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Checks whether a value is a promise or any "thenable"
+ * (an object or function with a `then` method).
+ *
+ * @example
+ * isPromise(Promise.resolve(1)); // true
+ * isPromise({ then() {} });      // true
+ * isPromise(42);                 // false
+ */
+declare function isPromise<T, S>(obj: PromiseLike<T> | S): obj is PromiseLike<T>;
+
+export { isPromise as default, isPromise };

package/lib/index.mjs

@@ -0,0 +1,7 @@
+/*!
+ * @prexjs/promise
+ * Copyright (c) 2026 Prexjs (https://prexjs.com)
+ * Copyright (c) 2026 Sorabh (https://Sorabh.org)
+ * MIT Licensed
+ */
+function t(t){return!!t&&("object"==typeof t||"function"==typeof t)&&"function"==typeof t.then}t.default=t,t.isPromise=t;export{t as default,t as isPromise};

package/package.json

@@ -1,6 +1,64 @@
 {
   "name": "@prexjs/promise",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Lightweight, zero-dependency type guard utility to test if a value is a Promise or Thenable.",
+  "authors": [
+    {
+      "name": "Prexjs",
+      "email": "hello@prexjs.com",
+      "url": "https://prexjs.com"
+    },
+    {
+      "name": "Sorabh",
+      "email": "hello@sorabh.org",
+      "url": "https://sorabh.org"
+    }
+  ],
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "lib",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.mjs",
+  "types": "./lib/index.d.cts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./lib/index.d.cts",
+        "default": "./lib/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/prexjs/prex.js.git",
+    "directory": "packages/promise"
+  },
+  "homepage": "https://github.com/prexjs/prex.js/tree/main/packages/promise#readme",
+  "bugs": {
+    "url": "https://github.com/prexjs/prex.js/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "prexjs",
+    "promise",
+    "ispromise",
+    "thenable",
+    "async",
+    "typeguard",
+    "deferred",
+    "check",
+    "typescript"
+  ]
+}