Better JSDoc

wu-hui · wu-hui · commit 21f5cdf7ee7d · 2020-12-03T17:05:40.000-05:00
diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts
@@ -8325,7 +8325,7 @@ declare namespace firebase.firestore {
    *
    * The API is compatible with `Promise<LoadBundleTaskProgress>`.
    */
-  export interface LoadBundleTask extends PromiseLIke< LoadBundleTaskProgress> {
+  export interface LoadBundleTask extends PromiseLike<LoadBundleTaskProgress> {
     /**
      * Registers functions to listen to bundle loading progresses.
      * @param next Called there is a progress update from bundle loading, typically whenever
diff --git a/packages/firestore-types/index.d.ts b/packages/firestore-types/index.d.ts
@@ -105,7 +105,7 @@ export class FirebaseFirestore {
   INTERNAL: { delete: () => Promise<void> };
 }
 
-export interface LoadBundleTask {
+export interface LoadBundleTask extends PromiseLike<LoadBundleTaskProgress> {
   onProgress(
     next?: (progress: LoadBundleTaskProgress) => any,
     error?: (error: Error) => any,
diff --git a/packages/firestore/exp-types/index.d.ts b/packages/firestore/exp-types/index.d.ts
@@ -516,7 +516,7 @@ export function snapshotEqual<T>(
   right: DocumentSnapshot<T> | QuerySnapshot<T>
 ): boolean;
 
-export interface LoadBundleTask {
+export interface LoadBundleTask extends PromiseLike<LoadBundleTaskProgress> {
   onProgress(
     next?: (progress: LoadBundleTaskProgress) => any,
     error?: (error: Error) => any,

Original file line number	Diff line number	Diff line change
`@@ -8325,7 +8325,7 @@ declare namespace firebase.firestore {`
`8325`	`8325`	`*`
`8326`	`8326`	* The API is compatible with `Promise<LoadBundleTaskProgress>`.
`8327`	`8327`	`*/`
`8328`		`- export interface LoadBundleTask extends PromiseLIke< LoadBundleTaskProgress> {`
	`8328`	`+ export interface LoadBundleTask extends PromiseLike<LoadBundleTaskProgress> {`
`8329`	`8329`	`/**`
`8330`	`8330`	`* Registers functions to listen to bundle loading progresses.`
`8331`	`8331`	`* @param next Called there is a progress update from bundle loading, typically whenever`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ export class FirebaseFirestore {`
`105`	`105`	`INTERNAL: { delete: () => Promise<void> };`
`106`	`106`	`}`
`107`	`107`
`108`		`-export interface LoadBundleTask {`
	`108`	`+export interface LoadBundleTask extends PromiseLike<LoadBundleTaskProgress> {`
`109`	`109`	`onProgress(`
`110`	`110`	`next?: (progress: LoadBundleTaskProgress) => any,`
`111`	`111`	`error?: (error: Error) => any,`