Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doc comment for headers property on ApolloClient #11508

Merged
merged 2 commits into from
Jan 22, 2024

Conversation

jerelmiller
Copy link
Member

Closes #11506

Adds a doc comment for the headers option that mentions that it will be ignored when using the link option.

Copy link

changeset-bot bot commented Jan 19, 2024

⚠️ No Changeset found

Latest commit: c254c66

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Jan 19, 2024

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 38.24 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 46.04 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production) 43.59 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 33.96 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production) 31.89 KB (0%)
import { ApolloProvider } from "dist/react/index.js" 1.24 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production) 1.22 KB (0%)
import { useQuery } from "dist/react/index.js" 5.2 KB (0%)
import { useQuery } from "dist/react/index.js" (production) 4.27 KB (0%)
import { useLazyQuery } from "dist/react/index.js" 5.51 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production) 4.58 KB (0%)
import { useMutation } from "dist/react/index.js" 3.51 KB (0%)
import { useMutation } from "dist/react/index.js" (production) 2.73 KB (0%)
import { useSubscription } from "dist/react/index.js" 3.19 KB (0%)
import { useSubscription } from "dist/react/index.js" (production) 2.38 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" 5.29 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production) 3.94 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" 4.76 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production) 3.4 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" 4.97 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" (production) 3.63 KB (0%)
import { useReadQuery } from "dist/react/index.js" 3.04 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production) 2.98 KB (0%)
import { useFragment } from "dist/react/index.js" 2.19 KB (0%)
import { useFragment } from "dist/react/index.js" (production) 2.13 KB (0%)

Copy link

netlify bot commented Jan 19, 2024

Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit 0c38f01
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/65aabc9d20ca4e0008efff82
😎 Deploy Preview https://deploy-preview-11508--apollo-client-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

src/core/ApolloClient.ts Outdated Show resolved Hide resolved
@github-actions github-actions bot added the auto-cleanup 🤖 label Jan 22, 2024
@phryneas phryneas merged commit 4464050 into release-3.9 Jan 22, 2024
10 of 17 checks passed
@phryneas phryneas deleted the jerel/document-headers-field branch January 22, 2024 09:55
@apollo-bot2
Copy link

Detected SAST Vulnerabilities

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

It's unclear that headers prop only works when there is no link prop
3 participants