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 documentation on using TypeScript with data masking #12165

Merged
merged 33 commits into from
Dec 4, 2024

Conversation

jerelmiller
Copy link
Member

Closes #11684
Closes #11685

Adds a new section in the data masking docs specifically for TypeScript. Includes all the instructions need to configure GraphQL Codegen to output masked types and use them throughout your application.

@jerelmiller jerelmiller requested a review from a team as a code owner November 27, 2024 23:44
@svc-apollo-docs
Copy link

svc-apollo-docs commented Nov 27, 2024

✅ Docs Preview Ready

No new or changed pages found.

Copy link

changeset-bot bot commented Nov 27, 2024

⚠️ No Changeset found

Latest commit: 22ed43a

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

@jerelmiller jerelmiller added 📝 documentation 🎭 data-masking Issues/PRs related to data masking labels Nov 27, 2024
@jerelmiller jerelmiller added this to the Data masking milestone Nov 27, 2024
@jerelmiller jerelmiller requested a review from phryneas November 27, 2024 23:44
Copy link

pkg-pr-new bot commented Nov 27, 2024

npm i https://pkg.pr.new/@apollo/client@12165

commit: 22ed43a

Copy link
Contributor

github-actions bot commented Nov 27, 2024

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 40.64 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 50.03 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production) 47.15 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 36.14 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production) 33.55 KB (0%)
import { ApolloProvider } from "dist/react/index.js" 1.26 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production) 1.24 KB (0%)
import { useQuery } from "dist/react/index.js" 5.21 KB (0%)
import { useQuery } from "dist/react/index.js" (production) 4.3 KB (0%)
import { useLazyQuery } from "dist/react/index.js" 5.71 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production) 4.78 KB (0%)
import { useMutation } from "dist/react/index.js" 3.62 KB (0%)
import { useMutation } from "dist/react/index.js" (production) 2.85 KB (0%)
import { useSubscription } from "dist/react/index.js" 4.43 KB (0%)
import { useSubscription } from "dist/react/index.js" (production) 3.48 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" 5.51 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production) 4.17 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" 5.01 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production) 3.66 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" 5.09 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" (production) 3.74 KB (0%)
import { useReadQuery } from "dist/react/index.js" 3.42 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production) 3.36 KB (0%)
import { useFragment } from "dist/react/index.js" 2.37 KB (0%)
import { useFragment } from "dist/react/index.js" (production) 2.31 KB (0%)

@jerelmiller jerelmiller force-pushed the jerel/typescript-docs branch from d725e9b to 0369f61 Compare December 2, 2024 17:46
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Show resolved Hide resolved
Copy link
Contributor

@Meschreiber Meschreiber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just one clarifying question at the beginning and a handful of stylistic suggestions.

docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
docs/source/data/fragments.mdx Outdated Show resolved Hide resolved
jerelmiller and others added 15 commits December 4, 2024 08:26
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
Co-authored-by: Maria Elisabeth Schreiber <[email protected]>
@jerelmiller jerelmiller merged commit a8d208c into release-3.12 Dec 4, 2024
42 of 46 checks passed
@jerelmiller jerelmiller deleted the jerel/typescript-docs branch December 4, 2024 15:42
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 4, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
auto-cleanup 🤖 🎭 data-masking Issues/PRs related to data masking 📝 documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants