Skip to content

Commit bddbed4

Browse files
author
denisp22
committed
Attempt to fix API doc Github source links.
1 parent e6459f5 commit bddbed4

File tree

1 file changed

+40
-40
lines changed

1 file changed

+40
-40
lines changed

readme.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ See the [example Next.js app and GraphQL API](example/readme.md).
7171
* [Query](#query)
7272
* [QueryRender](#queryrender)
7373
* [ConsumerRender](#consumerrender)
74-
* [ActiveQuery](#activequery)
7574
* [HTTPError](#httperror)
7675
* [Operation](#operation)
7776
* [RequestOptions](#requestoptions)
@@ -80,13 +79,14 @@ See the [example Next.js app and GraphQL API](example/readme.md).
8079
* [cache](#cache)
8180
* [reset](#reset)
8281
* [query](#query-1)
83-
* [RequestCachePromise](#requestcachepromise)
84-
* [CacheUpdateCallback](#cacheupdatecallback)
8582
* [RequestCache](#requestcache)
83+
* [CacheUpdateCallback](#cacheupdatecallback)
84+
* [RequestCachePromise](#requestcachepromise)
85+
* [ActiveQuery](#activequery)
8686

8787
### Provider
8888

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')
9090

9191
A React component that puts a [GraphQL](#graphql) instance in context for nested [Consumer](#consumer) components to use.
9292

@@ -111,7 +111,7 @@ Returns **ReactElement** React virtual DOM element.
111111

112112
### Consumer
113113

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')
115115

116116
A React component that gets the [GraphQL](#graphql) instance from context.
117117

@@ -137,7 +137,7 @@ Returns **ReactElement** React virtual DOM element.
137137

138138
### Query
139139

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')
141141

142142
A React component to manage a GraphQL query or mutation.
143143

@@ -217,7 +217,7 @@ Returns **ReactElement** React virtual DOM element.
217217

218218
### QueryRender
219219

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')
221221

222222
Renders the status of a query or mutation.
223223

@@ -249,7 +249,7 @@ Returns **ReactElement** React virtual DOM element.
249249

250250
### ConsumerRender
251251

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')
253253

254254
Renders a [GraphQL](#graphql) consumer.
255255

@@ -269,21 +269,9 @@ graphql => <button onClick={graphql.reset}>Reset cache</button>
269269

270270
Returns **ReactElement** React virtual DOM element.
271271

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')
275-
276-
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
277-
278-
**Properties**
279-
280-
* `pastRequestCache` **[RequestCache](#requestcache)?** Results from the last identical request.
281-
* `requestHash` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Request options hash.
282-
* `request` **[RequestCachePromise](#requestcachepromise)** Promise that resolves fresh request cache.
283-
284272
### HTTPError
285273

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')
287275

288276
Fetch HTTP error.
289277

@@ -296,7 +284,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
296284

297285
### Operation
298286

299-
[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')
300288

301289
A GraphQL operation object. Additional properties may be used; all are sent to the GraphQL server.
302290

@@ -309,7 +297,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
309297

310298
### RequestOptions
311299

312-
[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')
313301

314302
Options for a GraphQL fetch request. See [polyfillable fetch options](https://github.github.io/fetch/#options).
315303

@@ -324,7 +312,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
324312

325313
### RequestOptionsOverride
326314

327-
[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')
328316

329317
A way to override request options generated for a fetch. Modify the provided options object directly; no return.
330318

@@ -345,7 +333,7 @@ options => {
345333

346334
### GraphQL
347335

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')
349337

350338
A lightweight GraphQL client that caches requests.
351339

@@ -370,13 +358,13 @@ const graphql = new GraphQL({
370358

371359
#### cache
372360

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')
374362

375363
GraphQL request cache.
376364

377365
#### reset
378366

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')
380368

381369
Resets the cache. Useful when a user logs out.
382370

@@ -388,7 +376,7 @@ graphql.reset()
388376

389377
#### query
390378

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')
392380

393381
Queries a GraphQL server.
394382

@@ -398,17 +386,24 @@ Queries a GraphQL server.
398386

399387
Returns **[ActiveQuery](#activequery)** In-flight query details.
400388

401-
### RequestCachePromise
389+
### RequestCache
402390

403-
[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')
404392

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.
406394

407-
Type: [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[RequestCache](#requestcache)>
395+
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
396+
397+
**Properties**
398+
399+
* `httpError` **[HTTPError](#httperror)?** Fetch HTTP error.
400+
* `parseError` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Parse error message.
401+
* `graphQLErrors` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** GraphQL response errors.
402+
* `data` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** GraphQL response data.
408403

409404
### CacheUpdateCallback
410405

411-
[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')
412407

413408
A cache update listener callback.
414409

@@ -418,17 +413,22 @@ Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Sta
418413

419414
* `requestCache` **[RequestCache](#requestcache)** Request cache.
420415

421-
### RequestCache
416+
### RequestCachePromise
422417

423-
[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')
424419

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.
421+
422+
Type: [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[RequestCache](#requestcache)>
423+
424+
### ActiveQuery
425+
426+
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207 'Source code on GitHub')
426427

427428
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
428429

429430
**Properties**
430431

431-
* `httpError` **[HTTPError](#httperror)?** Fetch HTTP error.
432-
* `parseError` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Parse error message.
433-
* `graphQLErrors` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** GraphQL response errors.
434-
* `data` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** GraphQL response data.
432+
* `pastRequestCache` **[RequestCache](#requestcache)?** Results from the last identical request.
433+
* `requestHash` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Request options hash.
434+
* `request` **[RequestCachePromise](#requestcachepromise)** Promise that resolves fresh request cache.

0 commit comments

Comments
 (0)