Skip to content

Commit

Permalink
Add more documentation on how to use the `removeTypenameFromVariables…
Browse files Browse the repository at this point in the history
…` link to reduce confusion (#11395)

Co-authored-by: Maria Elisabeth Schreiber <maria.schreiber@apollographql.com>
Co-authored-by: jerelmiller <jerelmiller@users.noreply.github.com>
  • Loading branch information
3 people authored Nov 30, 2023
1 parent 89ec18e commit b9332e0
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 10 deletions.
4 changes: 2 additions & 2 deletions .size-limits.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"dist/apollo-client.min.cjs": 37973,
"import { ApolloClient, InMemoryCache, HttpLink } from \"dist/index.js\" (production)": 32022
"dist/apollo-client.min.cjs": 37960,
"import { ApolloClient, InMemoryCache, HttpLink } from \"dist/index.js\" (production)": 32018
}
63 changes: 55 additions & 8 deletions docs/source/api/link/apollo-link-remove-typename.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,7 @@ minVersion: 3.8.0

## Overview

When reusing data from a query as an argument to another GraphQL operation, `__typename` fields can cause errors. To avoid this, you can use the `removeTypenameFromVariables` link to automatically remove `__typename` fields from variables in operations. You can import and instantiate it like so:

```ts
import { removeTypenameFromVariables } from '@apollo/client/link/remove-typename';

const removeTypenameLink = removeTypenameFromVariables();
```
When reusing data from a query as an argument to another GraphQL operation, `__typename` fields can cause errors. To avoid this, you can use the `removeTypenameFromVariables` link to automatically remove `__typename` fields from variables in operations.

## Remove `__typename` from all variables

Expand Down Expand Up @@ -60,6 +54,60 @@ await client.mutate({

Without the use of the `removeTypenameFromVariables` link, the server will return an error because `data.dashboard` still contains the `__typename` field.

## Usage

You can import and instantiate it like so:

```ts
import { removeTypenameFromVariables } from '@apollo/client/link/remove-typename';

const removeTypenameLink = removeTypenameFromVariables();
```

Include `removeTypeNameLink` anywhere in your [link chain](./introduction/#your-first-link-chain) before your [terminating link](./introduction#the-terminating-link)
to remove `__typename` fields from variables for all operations.

```ts
import { from } from '@apollo/client';

const link = from([removeTypenameLink, httpLink]);

const client = new ApolloClient({
link,
// ... other options
});
```

If you're using [directional composition](./link/introduction#directional-composition),
for example, to [send a subscription to a websocket connection](../data/subscriptions#3-split-communication-by-operation-recommended),
place `removeTypenameLink` before `splitLink` to remove `__typename` from variables for all operations.

```ts
import { from, split } from '@apollo/client';
import { removeTypenameFromVariables } from '@apollo/client/link/remove-typename';

const removeTypenameLink = removeTypenameFromVariables();

const splitLink = split(
({ query }) => {
const definition = getMainDefinition(query);
return (
definition.kind === 'OperationDefinition' &&
definition.operation === 'subscription'
);
},
wsLink,
httpLink,
);

const link = from([removeTypenameLink, splitLink]);

const client = new ApolloClient({
link,
// ... other options
});
```

## Keep `__typename` in JSON scalars

Sometimes, you may need to retain the `__typename` field from a query's response—for example, in the case of [JSON scalar](https://github.com/taion/graphql-type-json) input fields.
Expand Down Expand Up @@ -194,4 +242,3 @@ Determines which input types should retain `__typename`. This maps the input typ

</tbody>
</table>

0 comments on commit b9332e0

Please sign in to comment.