Mirror: The highly customizable and versatile GraphQL client with which you add on features like normalized caching as you grow.
docs(core): Update type of OperationContext's preferGetMethod (#2972)
+10
-10
+10
-10
docs/api/core.md
+10
-10
docs/api/core.md
···
199
199
Some of these options are set when the `Client` is initialised, so in the following list of
200
200
properties you'll likely see some options that exist on the `Client` as well.
201
201
202
-
| Prop | Type | Description |
203
-
| --------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
204
-
| `fetchOptions` | `?RequestInit \| (() => RequestInit)` | Additional `fetchOptions` that `fetch` in `fetchExchange` should use to make a request. |
205
-
| `fetch` | `typeof fetch` | An alternative implementation of `fetch` that will be used by the `fetchExchange` instead of `window.fetch` |
206
-
| `requestPolicy` | `RequestPolicy` | An optional [request policy](../basics/document-caching.md#request-policies) that should be used specifying the cache strategy. |
207
-
| `url` | `string` | The GraphQL endpoint, when using GET you should use absolute url's |
208
-
| `meta` | `?OperationDebugMeta` | Metadata that is only available in development for devtools. |
209
-
| `suspense` | `?boolean` | Whether suspense is enabled. |
210
-
| `preferGetMethod` | `?boolean` | Instructs the `fetchExchange` to use HTTP GET for queries. |
211
-
| `additionalTypenames` | `?string[]` | Allows you to tell the operation that it depends on certain typenames (used in document-cache.) |
202
+
| Prop | Type | Description |
203
+
| --------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
204
+
| `fetchOptions` | `?RequestInit \| (() => RequestInit)` | Additional `fetchOptions` that `fetch` in `fetchExchange` should use to make a request. |
205
+
| `fetch` | `typeof fetch` | An alternative implementation of `fetch` that will be used by the `fetchExchange` instead of `window.fetch` |
206
+
| `requestPolicy` | `RequestPolicy` | An optional [request policy](../basics/document-caching.md#request-policies) that should be used specifying the cache strategy. |
207
+
| `url` | `string` | The GraphQL endpoint, when using GET you should use absolute url's |
208
+
| `meta` | `?OperationDebugMeta` | Metadata that is only available in development for devtools. |
209
+
| `suspense` | `?boolean` | Whether suspense is enabled. |
210
+
| `preferGetMethod` | `?boolean \| 'force' \| 'within-url-limit'` | Instructs the `fetchExchange` to use HTTP GET for queries. |
211
+
| `additionalTypenames` | `?string[]` | Allows you to tell the operation that it depends on certain typenames (used in document-cache.) |
212
212
213
213
It also accepts additional, untyped parameters that can be used to send more
214
214
information to custom exchanges.