Skip to content

Commit

Permalink
Add thin docs for disableMasking
Browse files Browse the repository at this point in the history
  • Loading branch information
kitten committed Feb 22, 2024
1 parent d86497c commit 0a889b6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 0 additions & 2 deletions website/src/content/docs/guides/fragment-colocation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -288,5 +288,3 @@ type maskedAuthor = {
};
};
```


4 changes: 4 additions & 0 deletions website/src/content/docs/reference/gql-tada-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -376,10 +376,14 @@ declare module 'gql.tada' {
| ----------- | ----------- |
| `introspection` property | Introspection of your schema in the `IntrospectionQuery` format. |
| `scalars` property | An optional object type with scalar names as keys and the corresponding scalar types as values. |
| `disableMasking` flag | This may be set to `true` to disable fragment masking globally. |

This is used either via [`setupSchema`](#setupschema) or [`initGraphQLTada()`](#initgraphqltada) to set
up your schema and scalars. Your configuration objects must match the shape of this type.

The `scalars` option is optional and can be used to set up more scalars, apart
from the default ones (like: Int, Float, String, Boolean).
It must be an object map of scalar names to their desired TypeScript types.

The `disableMasking` flag may be set to `true` instead of using `@_unmask` on individual fragments
and allows fragment masking to be disabled globally.

0 comments on commit 0a889b6

Please sign in to comment.