Skip to content

Update README.md #382

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.

Sign up for GitHub

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

Merged
budde377 merged 1 commit into from
Jan 20, 2025
Merged

Update README.md #382

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions packages/graphql_codegen/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -623,6 +623,17 @@ no `$unknown` value will be added to your enum and all new values will be mapped

## Add typename

Please note that before toggling `addTypename` to `true` as it might just sound like a quick win for every GraphQL document,
you might want to consider that this option could end up generating documents that wouldn't be up-to-spec with the main GraphQL
specification. In particular, given that having [several root fields on subscriptions is forbidden](https://spec.graphql.org/October2021/#sec-Single-root-field)
you probably want to make sure that the server you'll be consuming the GraphQL endpoint against might enforce this rule and
[add an exception](#excluding-some-selections-from-adding-typename) to it, such as:

```yaml
addTypenameExcludedPaths:
- subscription.*
```

By default, the `addTypename` option is enabled. This'll add the `__typename` introspection field to every selection set. E.g.,

```graphql
Expand Down