Add doc comment for headers property on ApolloClient (#11508)

* Add doc comment for `headers` property on ApolloClient * Update src/core/ApolloClient.ts --------- Co-authored-by: Lenz Weber-Tronic <[email protected]>
apollographql · Jan 22, 2024 · 4464050 · 4464050
1 parent cfe6b78
commit 4464050
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/core/ApolloClient.ts b/src/core/ApolloClient.ts
@@ -51,6 +51,11 @@ export interface ApolloClientOptions<TCacheShape> {
    */
   uri?: string | UriFunction;
   credentials?: string;
+  /**
+   * An object representing headers to include in every HTTP request, such as `{Authorization: 'Bearer 1234'}`
+   *
+   * This value will be ignored when using the `link` option.
+   */
   headers?: Record<string, string>;
   /**
    * You can provide an {@link ApolloLink} instance to serve as Apollo Client's network layer. For more information, see [Advanced HTTP networking](https://www.apollographql.com/docs/react/networking/advanced-http-networking/).