chore: Fix or suppress eslint warnings introduced with UpdateData. (#…

…1910)
googleapis · Oct 3, 2023 · eb88276 · eb88276
1 parent da4f8f8
commit eb88276
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 14 deletions.
diff --git a/dev/src/bulk-writer.ts b/dev/src/bulk-writer.ts
@@ -336,6 +336,7 @@ export class BulkWriterError extends Error {
     readonly message: string,
 
     /** The document reference the operation was performed on. */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     readonly documentRef: firestore.DocumentReference<any, any>,
 
     /** The type of operation performed. */
@@ -782,6 +783,7 @@ export class BulkWriter {
    */
   onWriteResult(
     successCallback: (
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       documentRef: firestore.DocumentReference<any, any>,
       result: WriteResult
     ) => void

diff --git a/dev/src/index.ts b/dev/src/index.ts
@@ -1401,8 +1401,9 @@ export class Firestore implements firestore.Firestore {
    * ```
    */
   recursiveDelete(
-    ref:
-      | firestore.CollectionReference<any, any>
+    ref: // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    | firestore.CollectionReference<any, any>
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       | firestore.DocumentReference<any, any>,
     bulkWriter?: BulkWriter
   ): Promise<void> {

diff --git a/dev/src/reference.ts b/dev/src/reference.ts
@@ -2095,9 +2095,7 @@ export class Query<
    * ```
    */
   startAt(
-    ...fieldValuesOrDocumentSnapshot: Array<
-      firestore.DocumentSnapshot<any, any> | unknown
-    >
+    ...fieldValuesOrDocumentSnapshot: Array<unknown>
   ): Query<AppModelType, DbModelType> {
     validateMinNumberOfArguments(
       'Query.startAt',
@@ -2141,9 +2139,7 @@ export class Query<
    * ```
    */
   startAfter(
-    ...fieldValuesOrDocumentSnapshot: Array<
-      firestore.DocumentSnapshot<any, any> | unknown
-    >
+    ...fieldValuesOrDocumentSnapshot: Array<unknown>
   ): Query<AppModelType, DbModelType> {
     validateMinNumberOfArguments(
       'Query.startAfter',
@@ -2186,9 +2182,7 @@ export class Query<
    * ```
    */
   endBefore(
-    ...fieldValuesOrDocumentSnapshot: Array<
-      firestore.DocumentSnapshot<any, any> | unknown
-    >
+    ...fieldValuesOrDocumentSnapshot: Array<unknown>
   ): Query<AppModelType, DbModelType> {
     validateMinNumberOfArguments(
       'Query.endBefore',
@@ -2231,9 +2225,7 @@ export class Query<
    * ```
    */
   endAt(
-    ...fieldValuesOrDocumentSnapshot: Array<
-      firestore.DocumentSnapshot<any, any> | unknown
-    >
+    ...fieldValuesOrDocumentSnapshot: Array<unknown>
   ): Query<AppModelType, DbModelType> {
     validateMinNumberOfArguments(
       'Query.endAt',

diff --git a/dev/src/transaction.ts b/dev/src/transaction.ts
@@ -410,6 +410,7 @@ export class Transaction implements firestore.Transaction {
    * ```
    */
   delete(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     documentRef: DocumentReference<any, any>,
     precondition?: firestore.Precondition
   ): this {

diff --git a/dev/src/watch.ts b/dev/src/watch.ts
@@ -54,6 +54,7 @@ export const WATCH_IDLE_TIMEOUT_MS = 120 * 1000;
 /*!
  * Sentinel value for a document remove.
  */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const REMOVED = {} as DocumentSnapshotBuilder<any, any>;
 
 /*!

diff --git a/dev/src/write-batch.ts b/dev/src/write-batch.ts
@@ -254,6 +254,7 @@ export class WriteBatch implements firestore.WriteBatch {
    * ```
    */
   delete(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     documentRef: firestore.DocumentReference<any, any>,
     precondition?: firestore.Precondition
   ): WriteBatch {

diff --git a/dev/test/types.ts b/dev/test/types.ts
@@ -39,6 +39,8 @@ describe('FirestoreTypeConverter', () => {
         };
       },
     };
+    // The intent of the function below is to test TypeScript compile and not execute.
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async function _(docRef: DocumentReference): Promise<void> {
       const newDocRef = docRef.withConverter(converter);
       await newDocRef.set({stringProperty: 'foo', numberProperty: 42});
@@ -66,6 +68,8 @@ describe('FirestoreTypeConverter', () => {
         };
       },
     };
+    // The intent of the function below is to test TypeScript compile and not execute.
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async function _(docRef: DocumentReference): Promise<void> {
       const newDocRef = docRef.withConverter(converter);
       await newDocRef.set({stringProperty: 'foo', numberProperty: 42});
@@ -109,6 +113,8 @@ describe('FirestoreTypeConverter', () => {
         };
       },
     };
+    // The intent of the function below is to test TypeScript compile and not execute.
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async function _(docRef: DocumentReference): Promise<void> {
       const newDocRef = docRef.withConverter(converter);
       await newDocRef.set({stringProperty: 'foo', numberProperty: 42});
@@ -136,6 +142,8 @@ describe('FirestoreTypeConverter', () => {
         };
       },
     };
+    // The intent of the function below is to test TypeScript compile and not execute.
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async function _(docRef: DocumentReference): Promise<void> {
       const newDocRef = docRef.withConverter(converter);
       await newDocRef.set({stringProperty: 'foo', numberProperty: 42});
@@ -167,6 +175,8 @@ describe('FirestoreTypeConverter', () => {
         };
       },
     };
+    // The intent of the function below is to test TypeScript compile and not execute.
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async function _(docRef: DocumentReference): Promise<void> {
       const newDocRef = docRef.withConverter(converter);
       await newDocRef.set({stringProperty: 'foo', numberProperty: 42});
-Original file line number
+Diff line change
@@ Expand Up / @@ -54,6 +54,7 @@ export const WATCH_IDLE_TIMEOUT_MS = 120 * 1000; @@
     /*!
      * Sentinel value for a document remove.
      */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const REMOVED = {} as DocumentSnapshotBuilder<any, any>;
     /*!
@@ Expand Down @@