Skip to content

Commit bd8b116

Browse files
committed
Don’t include source links in API docs.
See documentationjs/documentation#1027.
1 parent 99142e9 commit bd8b116

File tree

2 files changed

+1
-35
lines changed

2 files changed

+1
-35
lines changed

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
"build:js": "babel src -d lib",
8080
"build:mjs": "cross-env MODULE=true babel src -d lib --keep-file-extension",
8181
"postbuild": "prettier 'lib/**/*.{js,mjs}' --write",
82-
"jsdoc": "documentation readme src --re mjs --pe mjs -s API -q -g",
82+
"jsdoc": "documentation readme src --re mjs --pe mjs -s API -q",
8383
"postjsdoc": "prettier readme.md --write",
8484
"prewatch": "npm run build",
8585
"watch": "run-p watch:*",

readme.md

-34
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,6 @@ See the [example Next.js app and GraphQL API](example/readme.md).
8686

8787
### Provider
8888

89-
[src/components.mjs:23-23](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/components.mjs#L23-L23 'Source code on GitHub')
90-
9189
A React component that puts a [GraphQL](#graphql) instance in context for nested [Consumer](#consumer) components to use.
9290

9391
**Parameters**
@@ -111,8 +109,6 @@ Returns **ReactElement** React virtual DOM element.
111109

112110
### Consumer
113111

114-
[src/components.mjs:39-39](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/components.mjs#L39-L39 'Source code on GitHub')
115-
116112
A React component that gets the [GraphQL](#graphql) instance from context.
117113

118114
**Parameters**
@@ -137,8 +133,6 @@ Returns **ReactElement** React virtual DOM element.
137133

138134
### Query
139135

140-
[src/components.mjs:241-245](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/components.mjs#L241-L245 'Source code on GitHub')
141-
142136
A React component to manage a GraphQL query or mutation.
143137

144138
**Parameters**
@@ -217,8 +211,6 @@ Returns **ReactElement** React virtual DOM element.
217211

218212
### QueryRender
219213

220-
[src/components.mjs:247-254](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/components.mjs#L247-L254 'Source code on GitHub')
221-
222214
Renders the status of a query or mutation.
223215

224216
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
@@ -249,8 +241,6 @@ Returns **ReactElement** React virtual DOM element.
249241

250242
### ConsumerRender
251243

252-
[src/components.mjs:247-254](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/components.mjs#L247-L254 'Source code on GitHub')
253-
254244
Renders a [GraphQL](#graphql) consumer.
255245

256246
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
@@ -271,8 +261,6 @@ Returns **ReactElement** React virtual DOM element.
271261

272262
### HTTPError
273263

274-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207 'Source code on GitHub')
275-
276264
Fetch HTTP error.
277265

278266
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
@@ -284,8 +272,6 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
284272

285273
### Operation
286274

287-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207 'Source code on GitHub')
288-
289275
A GraphQL operation object. Additional properties may be used; all are sent to the GraphQL server.
290276

291277
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
@@ -297,8 +283,6 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
297283

298284
### RequestOptions
299285

300-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207 'Source code on GitHub')
301-
302286
Options for a GraphQL fetch request. See [polyfillable fetch options](https://github.github.io/fetch/#options).
303287

304288
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
@@ -312,8 +296,6 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
312296

313297
### RequestOptionsOverride
314298

315-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207 'Source code on GitHub')
316-
317299
A way to override request options generated for a fetch. Modify the provided options object directly; no return.
318300

319301
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
@@ -333,8 +315,6 @@ options => {
333315

334316
### GraphQL
335317

336-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207 'Source code on GitHub')
337-
338318
A lightweight GraphQL client that caches requests.
339319

340320
**Parameters**
@@ -358,14 +338,10 @@ const graphql = new GraphQL({
358338

359339
#### cache
360340

361-
[src/graphql.mjs:25-25](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L25-L25 'Source code on GitHub')
362-
363341
GraphQL request cache.
364342

365343
#### reset
366344

367-
[src/graphql.mjs:75-79](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L75-L79 'Source code on GitHub')
368-
369345
Resets the cache. Useful when a user logs out.
370346

371347
**Examples**
@@ -376,8 +352,6 @@ graphql.reset()
376352

377353
#### query
378354

379-
[src/graphql.mjs:194-206](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L194-L206 'Source code on GitHub')
380-
381355
Queries a GraphQL server.
382356

383357
**Parameters**
@@ -388,8 +362,6 @@ Returns **[ActiveQuery](#activequery)** In-flight query details.
388362

389363
### RequestCache
390364

391-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207 'Source code on GitHub')
392-
393365
JSON serializable result of a request (including all errors and data) for caching purposes.
394366

395367
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
@@ -403,8 +375,6 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
403375

404376
### CacheUpdateCallback
405377

406-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207 'Source code on GitHub')
407-
408378
A cache update listener callback.
409379

410380
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
@@ -415,16 +385,12 @@ Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Sta
415385

416386
### RequestCachePromise
417387

418-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207 'Source code on GitHub')
419-
420388
A promise for an in-flight query that resolves the request cache.
421389

422390
Type: [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RequestCache](#requestcache)>
423391

424392
### ActiveQuery
425393

426-
[src/graphql.mjs:19-207](https://github.com/jaydenseric/graphql-react/blob/79fe2b0ccbc29aa48d5bc47415c853fa282384c0/src/graphql.mjs#L19-L207 'Source code on GitHub')
427-
428394
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
429395

430396
**Properties**

0 commit comments

Comments
 (0)