From 44640500540525895014ce8d97d338ca0e7884fa Mon Sep 17 00:00:00 2001
From: Jerel Miller <jerelmiller@gmail.com>
Date: Mon, 22 Jan 2024 02:55:13 -0700
Subject: [PATCH] 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 <lorenz.weber-tronic@apollographql.com>
---
 src/core/ApolloClient.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/core/ApolloClient.ts b/src/core/ApolloClient.ts
index 933d4266b1e..a0b33993d61 100644
--- 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/).