refactor(promise-kit): Rename PromiseRecord to PromiseKit (#4201)

Agoric · Dec 24, 2021 · ecb8097 · ecb8097
1 parent fea822e
commit ecb8097
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/packages/promise-kit/src/promiseKit.js b/packages/promise-kit/src/promiseKit.js
@@ -9,12 +9,19 @@ const BestPipelinablePromise = globalThis.HandledPromise || Promise;
 
 /**
  * @template T
- * @typedef {Object} PromiseRecord A reified Promise
+ * @typedef {Object} PromiseKit A reified Promise
  * @property {(value: ERef<T>) => void} resolve
  * @property {(reason: any) => void} reject
  * @property {Promise<T>} promise
  */
 
+/**
+ * PromiseRecord is deprecated in favor of PromiseKit.
+ *
+ * @template T
+ * @typedef {PromiseKit<T>} PromiseRecord
+ */
+
 /**
  * @template T
  * @typedef {T | PromiseLike<T>} ERef
@@ -35,7 +42,7 @@ const NOOP_INITIALIZER = harden(() => {});
  * and rejecting it.
  *
  * @template T
- * @returns {PromiseRecord<T>}
+ * @returns {PromiseKit<T>}
  */
 export function makePromiseKit() {
   /** @type {(value: ERef<T>) => void} */