Skip to content

Commit 87168c8

Browse files
wopianwopian
committed
chore(release): update documentation
1 parent 15821c9 commit 87168c8

2 files changed

Lines changed: 22 additions & 22 deletions

File tree

‎packages/kitsu-core/README.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ All code released under [MIT]
137137

138138
### camel
139139

140-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
140+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
141141

142142
Converts kebab-case and snake\_case into camelCase
143143

@@ -163,7 +163,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
163163

164164
### deattribute
165165

166-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
166+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
167167

168168
Hoists attributes to be top-level
169169

@@ -205,7 +205,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
205205

206206
### deserialise
207207

208-
[packages/kitsu-core/src/deserialise/index.js:62-77](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/deserialise/index.js#L62-L77 "Source code on GitHub")
208+
[packages/kitsu-core/src/deserialise/index.js:63-78](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/deserialise/index.js#L63-L78 "Source code on GitHub")
209209

210210
Deserialises a JSON-API response
211211

@@ -255,7 +255,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
255255

256256
### error
257257

258-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
258+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
259259

260260
Uniform error handling for Axios, JSON:API and internal package errors. Mutated Error object is rethrown to the caller.
261261

@@ -292,7 +292,7 @@ error({
292292

293293
### filterIncludes
294294

295-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
295+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
296296

297297
Filters includes for the specific relationship requested
298298

@@ -332,7 +332,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
332332

333333
### kebab
334334

335-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
335+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
336336

337337
Converts camelCase into kebab-case
338338

@@ -350,7 +350,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
350350

351351
### linkRelationships
352352

353-
[packages/kitsu-core/src/linkRelationships/index.js:144-164](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/linkRelationships/index.js#L144-L164 "Source code on GitHub")
353+
[packages/kitsu-core/src/linkRelationships/index.js:144-164](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/linkRelationships/index.js#L144-L164 "Source code on GitHub")
354354

355355
Links relationships to included data
356356

@@ -390,7 +390,7 @@ Returns **any** Parsed data
390390

391391
### isDeepEqual
392392

393-
[packages/kitsu-core/src/deepEqual/index.js:18-42](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/deepEqual/index.js#L18-L42 "Source code on GitHub")
393+
[packages/kitsu-core/src/deepEqual/index.js:18-42](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/deepEqual/index.js#L18-L42 "Source code on GitHub")
394394

395395
Compare two objects equality
396396

@@ -419,7 +419,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
419419

420420
### query
421421

422-
[packages/kitsu-core/src/query/index.js:57-66](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/query/index.js#L57-L66 "Source code on GitHub")
422+
[packages/kitsu-core/src/query/index.js:57-66](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/query/index.js#L57-L66 "Source code on GitHub")
423423

424424
Constructs a URL query string for JSON:API parameters
425425

@@ -448,7 +448,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
448448

449449
### serialise
450450

451-
[packages/kitsu-core/src/serialise/index.js:210-221](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/serialise/index.js#L210-L221 "Source code on GitHub")
451+
[packages/kitsu-core/src/serialise/index.js:210-221](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/serialise/index.js#L210-L221 "Source code on GitHub")
452452

453453
Serialises an object into a JSON-API structure
454454

@@ -493,7 +493,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
493493

494494
### snake
495495

496-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
496+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
497497

498498
Converts camelCase into snake\_case
499499

@@ -511,7 +511,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
511511

512512
### splitModel
513513

514-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
514+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
515515

516516
Split model name from the model's resource URL
517517

‎packages/kitsu/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ All code released under [MIT]
241241

242242
### Kitsu
243243

244-
[packages/kitsu/src/index.js:31-567](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu/src/index.js#L31-L567 "Source code on GitHub")
244+
[packages/kitsu/src/index.js:31-567](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu/src/index.js#L31-L567 "Source code on GitHub")
245245

246246
Creates a new `kitsu` instance
247247

@@ -287,7 +287,7 @@ const api = new Kitsu({
287287

288288
#### plural
289289

290-
[packages/kitsu/src/index.js:58-59](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu/src/index.js#L58-L59 "Source code on GitHub")
290+
[packages/kitsu/src/index.js:58-59](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu/src/index.js#L58-L59 "Source code on GitHub")
291291

292292
* **See**: <https://www.npmjs.com/package/pluralize> for documentation
293293
* **See**: [Kitsu](#kitsu) constructor options for disabling pluralization
@@ -306,7 +306,7 @@ api.plural.plural('paper') //=> 'paper'
306306

307307
#### headers
308308

309-
[packages/kitsu/src/index.js:73-73](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu/src/index.js#L73-L73 "Source code on GitHub")
309+
[packages/kitsu/src/index.js:73-73](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu/src/index.js#L73-L73 "Source code on GitHub")
310310

311311
Get the current headers or add additional headers
312312

@@ -334,7 +334,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
334334

335335
#### interceptors
336336

337-
[packages/kitsu/src/index.js:120-120](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu/src/index.js#L120-L120 "Source code on GitHub")
337+
[packages/kitsu/src/index.js:120-120](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu/src/index.js#L120-L120 "Source code on GitHub")
338338

339339
* **See**: <https://github.com/axios/axios#interceptors> for documentation
340340

@@ -381,7 +381,7 @@ api.interceptors.request.eject(myInterceptor)
381381

382382
#### get
383383

384-
[packages/kitsu/src/index.js:218-253](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu/src/index.js#L218-L253 "Source code on GitHub")
384+
[packages/kitsu/src/index.js:218-253](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu/src/index.js#L218-L253 "Source code on GitHub")
385385

386386
Fetch resources (alias `fetch`)
387387

@@ -518,7 +518,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
518518

519519
#### patch
520520

521-
[packages/kitsu/src/index.js:289-323](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu/src/index.js#L289-L323 "Source code on GitHub")
521+
[packages/kitsu/src/index.js:289-323](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu/src/index.js#L289-L323 "Source code on GitHub")
522522

523523
Update a resource (alias `update`)
524524

@@ -580,7 +580,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
580580

581581
#### post
582582

583-
[packages/kitsu/src/index.js:358-390](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu/src/index.js#L358-L390 "Source code on GitHub")
583+
[packages/kitsu/src/index.js:358-390](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu/src/index.js#L358-L390 "Source code on GitHub")
584584

585585
Create a new resource (alias `create`)
586586

@@ -629,7 +629,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
629629

630630
#### delete
631631

632-
[packages/kitsu/src/index.js:410-450](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu/src/index.js#L410-L450 "Source code on GitHub")
632+
[packages/kitsu/src/index.js:410-450](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu/src/index.js#L410-L450 "Source code on GitHub")
633633

634634
Remove a resource (alias `remove`)
635635

@@ -667,7 +667,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
667667

668668
#### self
669669

670-
[packages/kitsu/src/index.js:474-483](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu/src/index.js#L474-L483 "Source code on GitHub")
670+
[packages/kitsu/src/index.js:474-483](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu/src/index.js#L474-L483 "Source code on GitHub")
671671

672672
Get the authenticated user's data
673673

@@ -705,7 +705,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
705705

706706
#### request
707707

708-
[packages/kitsu/src/index.js:538-566](https://github.com/wopian/kitsu/blob/8bf9d387e3bd45936dd6ec49f9bd6f043571b9e6/packages/kitsu/src/index.js#L538-L566 "Source code on GitHub")
708+
[packages/kitsu/src/index.js:538-566](https://github.com/wopian/kitsu/blob/15821c91364346014867a874144d758cf7922483/packages/kitsu/src/index.js#L538-L566 "Source code on GitHub")
709709

710710
Send arbitrary requests
711711

0 commit comments

Comments
 (0)
⚡