You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+40-40Lines changed: 40 additions & 40 deletions
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,6 @@ See the [example Next.js app and GraphQL API](example/readme.md).
71
71
*[Query](#query)
72
72
*[QueryRender](#queryrender)
73
73
*[ConsumerRender](#consumerrender)
74
-
*[ActiveQuery](#activequery)
75
74
*[HTTPError](#httperror)
76
75
*[Operation](#operation)
77
76
*[RequestOptions](#requestoptions)
@@ -80,13 +79,14 @@ See the [example Next.js app and GraphQL API](example/readme.md).
80
79
*[cache](#cache)
81
80
*[reset](#reset)
82
81
*[query](#query-1)
83
-
*[RequestCachePromise](#requestcachepromise)
84
-
*[CacheUpdateCallback](#cacheupdatecallback)
85
82
*[RequestCache](#requestcache)
83
+
*[CacheUpdateCallback](#cacheupdatecallback)
84
+
*[RequestCachePromise](#requestcachepromise)
85
+
*[ActiveQuery](#activequery)
86
86
87
87
### Provider
88
88
89
-
[src/components.mjs:23-23](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/components.mjs#L23-L23'Source code on GitHub')
89
+
[src/components.mjs:23-23](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/components.mjs#L23-L23'Source code on GitHub')
90
90
91
91
A React component that puts a [GraphQL](#graphql) instance in context for nested [Consumer](#consumer) components to use.
92
92
@@ -111,7 +111,7 @@ Returns **ReactElement** React virtual DOM element.
111
111
112
112
### Consumer
113
113
114
-
[src/components.mjs:39-39](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/components.mjs#L39-L39'Source code on GitHub')
114
+
[src/components.mjs:39-39](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/components.mjs#L39-L39'Source code on GitHub')
115
115
116
116
A React component that gets the [GraphQL](#graphql) instance from context.
117
117
@@ -137,7 +137,7 @@ Returns **ReactElement** React virtual DOM element.
137
137
138
138
### Query
139
139
140
-
[src/components.mjs:241-245](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/components.mjs#L241-L245'Source code on GitHub')
140
+
[src/components.mjs:241-245](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/components.mjs#L241-L245'Source code on GitHub')
141
141
142
142
A React component to manage a GraphQL query or mutation.
143
143
@@ -217,7 +217,7 @@ Returns **ReactElement** React virtual DOM element.
217
217
218
218
### QueryRender
219
219
220
-
[src/components.mjs:247-254](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/components.mjs#L247-L254'Source code on GitHub')
220
+
[src/components.mjs:247-254](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/components.mjs#L247-L254'Source code on GitHub')
221
221
222
222
Renders the status of a query or mutation.
223
223
@@ -249,7 +249,7 @@ Returns **ReactElement** React virtual DOM element.
249
249
250
250
### ConsumerRender
251
251
252
-
[src/components.mjs:247-254](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/components.mjs#L247-L254'Source code on GitHub')
252
+
[src/components.mjs:247-254](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/components.mjs#L247-L254'Source code on GitHub')
Returns **ReactElement** React virtual DOM element.
271
271
272
-
### ActiveQuery
273
-
274
-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L19-L207'Source code on GitHub')
*`request`**[RequestCachePromise](#requestcachepromise)** Promise that resolves fresh request cache.
283
-
284
272
### HTTPError
285
273
286
-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L19-L207'Source code on GitHub')
274
+
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207'Source code on GitHub')
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L19-L207'Source code on GitHub')
287
+
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207'Source code on GitHub')
300
288
301
289
A GraphQL operation object. Additional properties may be used; all are sent to the GraphQL server.
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L19-L207'Source code on GitHub')
300
+
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207'Source code on GitHub')
313
301
314
302
Options for a GraphQL fetch request. See [polyfillable fetch options](https://github.github.io/fetch/#options).
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L19-L207'Source code on GitHub')
315
+
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207'Source code on GitHub')
328
316
329
317
A way to override request options generated for a fetch. Modify the provided options object directly; no return.
330
318
@@ -345,7 +333,7 @@ options => {
345
333
346
334
### GraphQL
347
335
348
-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L19-L207'Source code on GitHub')
336
+
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207'Source code on GitHub')
349
337
350
338
A lightweight GraphQL client that caches requests.
351
339
@@ -370,13 +358,13 @@ const graphql = new GraphQL({
370
358
371
359
#### cache
372
360
373
-
[src/graphql.mjs:25-25](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L25-L25'Source code on GitHub')
361
+
[src/graphql.mjs:25-25](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L25-L25'Source code on GitHub')
374
362
375
363
GraphQL request cache.
376
364
377
365
#### reset
378
366
379
-
[src/graphql.mjs:75-79](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L75-L79'Source code on GitHub')
367
+
[src/graphql.mjs:75-79](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L75-L79'Source code on GitHub')
380
368
381
369
Resets the cache. Useful when a user logs out.
382
370
@@ -388,7 +376,7 @@ graphql.reset()
388
376
389
377
#### query
390
378
391
-
[src/graphql.mjs:194-206](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L194-L206'Source code on GitHub')
379
+
[src/graphql.mjs:194-206](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L194-L206'Source code on GitHub')
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L19-L207'Source code on GitHub')
391
+
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207'Source code on GitHub')
404
392
405
-
A promise for an in-flight query that resolves the request cache.
393
+
JSON serializable result of a request (including all errors and data) for caching purposes.
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L19-L207'Source code on GitHub')
406
+
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207'Source code on GitHub')
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/f908346ed98ffff6e01b29c42236745bed87a7a8/src/graphql.mjs#L19-L207'Source code on GitHub')
418
+
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207'Source code on GitHub')
424
419
425
-
JSON serializable result of a request (including all errors and data) for caching purposes.
420
+
A promise for an in-flight query that resolves the request cache.
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207'Source code on GitHub')
0 commit comments