Renamed function

Author: maneesht

common/api-review/util.api.md

@@ -346,6 +346,11 @@ export function ordinal(i: number): string;
 // @public (undocumented)
 export type PartialObserver<T> = Partial<Observer<T>>;
 
+// Warning: (ae-internal-missing-underscore) The name "promiseWithTimeout" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export function promiseWithTimeout<T>(promise: Promise<T>, timeInMS?: number): Promise<T>;
+
 // Warning: (ae-missing-release-tag) "querystring" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public
@@ -417,11 +422,6 @@ export interface Subscribe<T> {
     (observer: PartialObserver<T>): Unsubscribe;
 }
 
-// Warning: (ae-missing-release-tag) "timeoutResolve" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public
-export function timeoutResolve<T>(promise: Promise<T>, timeInMS?: number): Promise<T>;
-
 // Warning: (ae-missing-release-tag) "Unsubscribe" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)

packages/database-compat/test/query.test.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { timeoutResolve } from '@firebase/util';
+import { promiseWithTimeout } from '@firebase/util';
 import { expect, use } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import * as _ from 'lodash';
@@ -3227,7 +3227,7 @@ describe('Query Tests', () => {
     const node = getRandomNode() as Reference;
     node.database.goOffline();
     try {
-      const getPromise = timeoutResolve(node.get());
+      const getPromise = promiseWithTimeout(node.get());
       await expect(getPromise).to.eventually.be.rejected;
     } finally {
       node.database.goOnline();

packages/database/test/exp/integration.test.ts

@@ -16,7 +16,7 @@
  */
 
 import { initializeApp, deleteApp } from '@firebase/app';
-import { Deferred, timeoutResolve } from '@firebase/util';
+import { Deferred, promiseWithTimeout } from '@firebase/util';
 import { expect, use } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 
@@ -275,10 +275,10 @@ describe('Database@exp Tests', () => {
     };
     await set(r, initial);
     goOffline(db);
-    const getValue = timeoutResolve(get(r));
+    const getValue = promiseWithTimeout(get(r));
     expect(getValue).to.be.rejectedWith('timeout!');
     goOnline(db);
-    const deferredTimeout2 = await timeoutResolve(get(r));
+    const deferredTimeout2 = await promiseWithTimeout(get(r));
     expect(deferredTimeout2.val()).to.deep.equal(initial);
   });
 

packages/util/src/promise.ts

@@ -17,11 +17,11 @@
 
 import { Deferred } from "./deferred";
 
-/*
-    Rejects if the given promise doesn't resolve in timeInMS milliseconds.
-    @internal
-*/
-export function timeoutResolve<T>(promise: Promise<T>, timeInMS = 2000) {
+/**
+ * Rejects if the given promise doesn't resolve in timeInMS milliseconds.
+ * @internal
+ */
+export function promiseWithTimeout<T>(promise: Promise<T>, timeInMS = 2000): Promise<T> {
   const deferredPromise = new Deferred<T>();
   setTimeout(() => deferredPromise.reject('timeout!'), timeInMS);
   promise.then(deferredPromise.resolve, deferredPromise.reject);