Update API reference docs for links: part 2

[jerelmiller]

No description provided.

[changeset-bot]

🦋 Changeset detected

Latest commit: d6a21a9

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

[pkg-pr-new]

npm i https://pkg.pr.new/apollographql/apollo-client/@apollo/client@12822

commit: d6a21a9

[apollo-librarian]

⚠️ Docs preview not attached to branch

The preview was not built because the PR's base branch release-4.0 is not in the list of sources.

An Apollo team member can comment one of the following commands to dictate which branch to attach the preview to:

• !docs set-base-branch version-2.6
• !docs set-base-branch main

Build ID: a5e10da6007ca0bda7d65ff7
Build Logs: View logs

[github-actions]

size-limit report 📦

Path	Size
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (CJS)	42.88 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production) (CJS)	37.65 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client"	32.77 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production)	26.91 KB (0%)
import { ApolloProvider } from "@apollo/client/react"	5.9 KB (0%)
import { ApolloProvider } from "@apollo/client/react" (production)	971 B (0%)
import { useQuery } from "@apollo/client/react"	7.21 KB (0%)
import { useQuery } from "@apollo/client/react" (production)	2.23 KB (0%)
import { useLazyQuery } from "@apollo/client/react"	7.1 KB (0%)
import { useLazyQuery } from "@apollo/client/react" (production)	2.13 KB (0%)
import { useMutation } from "@apollo/client/react"	6.45 KB (0%)
import { useMutation } from "@apollo/client/react" (production)	1.48 KB (0%)
import { useSubscription } from "@apollo/client/react"	6.78 KB (0%)
import { useSubscription } from "@apollo/client/react" (production)	1.8 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react"	8.58 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react" (production)	3.63 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react"	8.33 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react" (production)	3.38 KB (0%)
import { useLoadableQuery } from "@apollo/client/react"	8.28 KB (0%)
import { useLoadableQuery } from "@apollo/client/react" (production)	3.36 KB (0%)
import { useReadQuery } from "@apollo/client/react"	6.59 KB (0%)
import { useReadQuery } from "@apollo/client/react" (production)	1.63 KB (0%)
import { useFragment } from "@apollo/client/react"	6.65 KB (0%)
import { useFragment } from "@apollo/client/react" (production)	1.69 KB (0%)

[jerelmiller]

!docs set-base-branch release-4.0

[jerelmiller]

Much of this doc really should live in another part of the docs site, but given our limited time, let's do that a different time.

[phryneas]

This is great :)

[phryneas]

I would show setting at least one property here.

Suggested change

	* return {
	* // ...
	* return {
	* credentials: "include",
	* // ...

[phryneas]

I'm not 100% sure, but maybe it might even sense to show something with a bit of type safety here in case users cannot enhance their global operation type?

const link = new SetContextLink((prevContext, operation) => {
  return {
    credentials: "include",
  } satisfies Partial<HttpLink.ContextOptions>;
});

[jerelmiller]

I might go the simple route for now and revisit once I write up the TypeScript declaration merging section for context (hopefully later today 🙂). Ideally I can link to that in this doc block.

[phryneas]

We could show using the subtle crypto API that's both supported in the browser and node at this point:
https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#basic_example