@endo/promise-kit 0.2.50 → 0.2.51

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+### [0.2.51](https://github.com/endojs/endo/compare/@endo/promise-kit@0.2.50...@endo/promise-kit@0.2.51) (2022-10-24)
+
+**Note:** Version bump only for package @endo/promise-kit
+
+
+
+
+
 ### [0.2.50](https://github.com/endojs/endo/compare/@endo/promise-kit@0.2.49...@endo/promise-kit@0.2.50) (2022-10-19)
 
 **Note:** Version bump only for package @endo/promise-kit

package/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * makePromiseKit() builds a Promise object, and returns a record
+ * containing the promise itself, as well as separate facets for resolving
+ * and rejecting it.
+ *
+ * @template T
+ * @returns {import('./src/types.js').PromiseKit<T>}
+ */
+export function makePromiseKit<T>(): import("./src/types.js").PromiseKit<T>;
+/**
+ * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
+ * or rejected.
+ *
+ * Unlike `Promise.race` it cleans up after itself so a non-resolved value doesn't hold onto
+ * the result promise.
+ *
+ * @template T
+ * @param {Iterable<T>} values An iterable of Promises.
+ * @returns {Promise<Awaited<T>>} A new Promise.
+ */
+export function racePromises<T>(values: Iterable<T>): Promise<Awaited<T>>;
+export * from "./src/is-promise.js";
+export * from "./src/types.js";
+//# sourceMappingURL=index.d.ts.map

package/index.js

@@ -1,5 +1,4 @@
 /* global globalThis */
-// @ts-check
 
 /// <reference types="ses"/>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@endo/promise-kit",
-  "version": "0.2.50",
+  "version": "0.2.51",
   "description": "Helper for making promises",
   "keywords": [
     "promise"
@@ -25,6 +25,9 @@
   },
   "scripts": {
     "build": "exit 0",
+    "clean": "tsc --build jsconfig.build.json --clean",
+    "prepack": "tsc --build jsconfig.build.json",
+    "postpack": "yarn clean",
     "cover": "c8 ava",
     "lint": "yarn lint:types && yarn lint:js",
     "lint-check": "yarn lint",
@@ -35,11 +38,12 @@
     "test:xs": "exit 0"
   },
   "dependencies": {
-    "ses": "^0.16.0"
+    "ses": "^0.17.0"
   },
   "devDependencies": {
     "@endo/eslint-config": "^0.5.1",
-    "@endo/ses-ava": "^0.2.34",
+    "@endo/ses-ava": "^0.2.35",
+    "@types/node": ">=14.0",
     "ava": "^3.12.1",
     "babel-eslint": "^10.0.3",
     "c8": "^7.7.3",
@@ -80,5 +84,5 @@
   "engines": {
     "node": ">=11.0"
   },
-  "gitHead": "8da6dc1002417c0f18cd43b351f8f62d7010260c"
+  "gitHead": "8fb324d8f13a0c6939dc0c1feb831f72298f1853"
 }

package/shim.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=shim.d.ts.map

package/src/is-promise.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Determine if the argument is a Promise.
+ *
+ * @param {unknown} maybePromise The value to examine
+ * @returns {maybePromise is Promise} Whether it is a promise
+ */
+export function isPromise(maybePromise: unknown): maybePromise is Promise<any>;
+//# sourceMappingURL=is-promise.d.ts.map

package/src/is-promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-promise.d.ts","sourceRoot":"","sources":["is-promise.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wCAHW,OAAO,gCAKjB"}

package/src/is-promise.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 /**
  * Determine if the argument is a Promise.
  *

package/src/memo-race.d.ts

@@ -0,0 +1,27 @@
+export { race as memoRace };
+export type Deferred<T = any> = {
+    resolve: (value?: import("./types.js").ERef<T> | undefined) => void;
+    reject: (err?: any) => void;
+};
+export type PromiseMemoRecord = never | {
+    settled: false;
+    deferreds: Set<Deferred>;
+} | {
+    settled: true;
+    deferreds?: undefined;
+};
+/**
+ * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
+ * or rejected.
+ *
+ * Unlike `Promise.race` it cleans up after itself so a non-resolved value doesn't hold onto
+ * the result promise.
+ *
+ * @template T
+ * @template {PromiseConstructor} [P=PromiseConstructor]
+ * @this {P}
+ * @param {Iterable<T>} values An iterable of Promises.
+ * @returns {Promise<Awaited<T>>} A new Promise.
+ */
+declare function race<T, P extends PromiseConstructor = PromiseConstructor>(this: P, values: Iterable<T>): Promise<Awaited<T>>;
+//# sourceMappingURL=memo-race.d.ts.map

package/src/memo-race.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memo-race.d.ts","sourceRoot":"","sources":["memo-race.js"],"names":[],"mappings":";;mEAmCyD,IAAI;mBACxC,GAAG,KAAM,IAAI;;gCAIpB,KAAK,GACb;IAAC,OAAO,EAAE,KAAK,CAAC;IAAC,SAAS,EAAE,IAAI,QAAQ,CAAC,CAAA;CAAC,GAC1C;IAAC,OAAO,EAAE,IAAI,CAAC;IAAC,SAAS,CAAC,EAAE,SAAS,CAAA;CAAC;AAgE1C;;;;;;;;;;;;GAYG;AACH,+HA8BC"}

package/src/memo-race.js

@@ -1,4 +1,3 @@
-// @ts-check
 /*
 Initial version authored by Brian Kim:
 https://github.com/nodejs/node/issues/17469#issuecomment-685216777

package/src/promise-executor-kit.d.ts

@@ -0,0 +1,8 @@
+export function makeReleasingExecutorKit<T>(): Pick<import("./types.js").PromiseKit<T>, "resolve" | "reject"> & {
+    executor: PromiseExecutor<T>;
+};
+/**
+ * The promise executor
+ */
+export type PromiseExecutor<T> = (resolve: (value: import('./types.js').ERef<T>) => void, reject: (reason: any) => void) => any;
+//# sourceMappingURL=promise-executor-kit.d.ts.map

package/src/promise-executor-kit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise-executor-kit.d.ts","sourceRoot":"","sources":["promise-executor-kit.js"],"names":[],"mappings":"AAiBO;;EAmCN;;;;mDA/CkB,OAAO,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,mBACpC,GAAG,KAAK,IAAI"}

package/src/promise-executor-kit.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 /// <reference types="ses"/>
 
 /**

package/src/types.d.ts

@@ -0,0 +1,20 @@
+/**
+ * A reified Promise
+ */
+export type PromiseKit<T> = {
+    resolve: (value: ERef<T>) => void;
+    reject: (reason: any) => void;
+    promise: Promise<T>;
+};
+/**
+ * PromiseRecord is deprecated in favor of PromiseKit.
+ */
+export type PromiseRecord<T> = PromiseKit<T>;
+/**
+ * A reference of some kind for to an object of type T. It may be a direct
+ * reference to a local T. It may be a local presence for a remote T. It may
+ * be a promise for a local or remote T. Or it may even be a thenable
+ * (a promise-like non-promise with a "then" method) for a T.
+ */
+export type ERef<T> = T | PromiseLike<T>;
+//# sourceMappingURL=types.d.ts.map

package/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":";;;;qBAGsB,KAAK,CAAC,CAAC,KAAK,IAAI;qBACf,GAAG,KAAK,IAAI;aACrB,QAAQ,CAAC,CAAC;;;;;+BAOX,WAAW,CAAC,CAAC;;;;;;;sBAKb,CAAC,GAAG,YAAY,CAAC,CAAC"}