Skip to content

Commit 483d7ad

Browse files
committed
Regenerate readme after dependencies updated.
1 parent da509b5 commit 483d7ad

File tree

1 file changed

+29
-23
lines changed

1 file changed

+29
-23
lines changed

readme.md

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,9 @@ client.mutate({
138138

139139
Used to mark a [React Native `File` substitute](#type-reactnativefilesubstitute). It’s too risky to assume all objects with `uri`, `type` and `name` properties are files to extract. Re-exported from [`extract-files`](https://npm.im/extract-files) for convenience.
140140

141-
| Parameter | Type | Description |
142-
| :-------- | :----------------------------------------------------------- | :----------------------------------------------------------------------------------- |
143-
| `file` | [ReactNativeFileSubstitute](#type-reactnativefilesubstitute) | A React Native [`File`](https://developer.mozilla.org/docs/web/api/file) substitute. |
141+
| Parameter | Type | Description |
142+
| :-- | :-- | :-- |
143+
| `file` | [ReactNativeFileSubstitute](#type-reactnativefilesubstitute) | A React Native [`File`](https://developer.mozilla.org/docs/web/api/file) substitute. |
144144

145145
#### Examples
146146

@@ -156,19 +156,21 @@ _A React Native file that can be used in query or mutation variables._
156156
> })
157157
> ```
158158
159+
---
160+
159161
### function createUploadLink
160162
161163
Creates a terminating [Apollo Link](https://apollographql.com/docs/link) capable of file uploads. Options match [`createHttpLink`](https://apollographql.com/docs/link/links/http#options).
162164
163-
| Parameter | Type | Description |
164-
| :-------------------------- | :-------------------------------------------- | :------------------------------------------------------------------------------------------------ |
165-
| `options` | [Object](https://mdn.io/object) | Options. |
166-
| `options.uri` | [string](https://mdn.io/string)? = `/graphql` | GraphQL endpoint URI. |
167-
| `options.fetch` | [function](https://mdn.io/function)? | [`fetch`](https://fetch.spec.whatwg.org) implementation to use, defaulting to the `fetch` global. |
168-
| `options.fetchOptions` | [FetchOptions](#type-fetchoptions)? | `fetch` options; overridden by upload requirements. |
169-
| `options.credentials` | [string](https://mdn.io/string)? | Overrides `options.fetchOptions.credentials`. |
170-
| `options.headers` | [Object](https://mdn.io/object)? | Merges with and overrides `options.fetchOptions.headers`. |
171-
| `options.includeExtensions` | [boolean](https://mdn.io/boolean)? = `false` | Toggles sending `extensions` fields to the GraphQL server. |
165+
| Parameter | Type | Description |
166+
| :-- | :-- | :-- |
167+
| `options` | Object | Options. |
168+
| `options.uri` | string? = `/graphql` | GraphQL endpoint URI. |
169+
| `options.fetch` | function? | [`fetch`](https://fetch.spec.whatwg.org) implementation to use, defaulting to the `fetch` global. |
170+
| `options.fetchOptions` | [FetchOptions](#type-fetchoptions)? | `fetch` options; overridden by upload requirements. |
171+
| `options.credentials` | string? | Overrides `options.fetchOptions.credentials`. |
172+
| `options.headers` | Object? | Merges with and overrides `options.fetchOptions.headers`. |
173+
| `options.includeExtensions` | boolean? = `false` | Toggles sending `extensions` fields to the GraphQL server. |
172174
173175
**Returns:** ApolloLink — A terminating [Apollo Link](https://apollographql.com/docs/link) capable of file uploads.
174176
@@ -192,34 +194,38 @@ _A basic Apollo Client setup._
192194
> })
193195
> ```
194196
197+
---
198+
195199
### type FetchOptions
196200
197201
GraphQL request `fetch` options.
198202
199-
**Type:** [Object](https://mdn.io/object)
203+
**Type:** Object
200204
201-
| Property | Type | Description |
202-
| :------------ | :------------------------------- | :------------------------------- |
203-
| `headers` | [Object](https://mdn.io/object) | HTTP request headers. |
204-
| `credentials` | [string](https://mdn.io/string)? | Authentication credentials mode. |
205+
| Property | Type | Description |
206+
| :------------ | :------ | :------------------------------- |
207+
| `headers` | Object | HTTP request headers. |
208+
| `credentials` | string? | Authentication credentials mode. |
205209
206210
#### See
207211
208212
- [Polyfillable fetch options](https://github.github.io/fetch#options).
209213
214+
---
215+
210216
### type ReactNativeFileSubstitute
211217
212218
A React Native [`File`](https://developer.mozilla.org/docs/web/api/file) substitute.
213219
214220
Be aware that inspecting network requests with Chrome dev tools interferes with the React Native `FormData` implementation, causing network errors.
215221
216-
**Type:** [Object](https://mdn.io/object)
222+
**Type:** Object
217223
218-
| Property | Type | Description |
219-
| :------- | :------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ |
220-
| `uri` | [String](https://mdn.io/string) | Filesystem path. |
221-
| `name` | [String](https://mdn.io/string)? | File name. |
222-
| `type` | [String](https://mdn.io/string)? | File content type. Some environments (particularly Android) require a valid MIME type; Expo `ImageResult.type` is unreliable as it can be just `image`. |
224+
| Property | Type | Description |
225+
| :-- | :-- | :-- |
226+
| `uri` | String | Filesystem path. |
227+
| `name` | String? | File name. |
228+
| `type` | String? | File content type. Some environments (particularly Android) require a valid MIME type; Expo `ImageResult.type` is unreliable as it can be just `image`. |
223229
224230
#### See
225231

0 commit comments

Comments
 (0)