docs: improve retryOptions doc string

googleapis · Jul 11, 2024 · efe2a73 · efe2a73
1 parent 895c7ee
commit efe2a73
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/bigquery.ts b/src/bigquery.ts
@@ -235,9 +235,13 @@ export interface BigQueryOptions extends GoogleAuthOptions {
 
   /**
    * Customize retry configuration for all requests in the SDK.
-   * If the response is related to rate limits or certain intermittent server errors.
+   * By default, a request is retried if the response is related to rate limits
+   * or certain intermittent server errors.
    * We will exponentially backoff subsequent requests by default.
    *
+   * More on the default retry predicate on the `shouldRetryRequest` method:
+   * https://github.com/googleapis/nodejs-common/blob/main/src/util.ts
+   *
    * Defaults:
    * - retryOptions.autoRetry: true
    * - retryOptions.maxRetries: 3