Skip to content

Commit 918b7e7

Browse files
wopianwopian
committed
chore(release): update documentation
1 parent 5105294 commit 918b7e7

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
@@ -135,7 +135,7 @@ All code released under [MIT]
135135

136136
### camel
137137

138-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
138+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
139139

140140
Converts kebab-case and snake_case into camelCase
141141

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

162162
### deattribute
163163

164-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
164+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
165165

166166
Hoists attributes to be top-level
167167

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

204204
### deserialise
205205

206-
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
206+
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
207207

208208
Deserialises a JSON-API response
209209

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

254254
### error
255255

256-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
256+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
257257

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

@@ -290,14 +290,14 @@ error({
290290

291291
### filterIncludes
292292

293-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
293+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
294294

295295
Filters includes for the specific relationship requested
296296

297297
#### Parameters
298298

299299
* `included` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>** The response included object
300-
* `relationship` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
300+
* `relationship` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
301301

302302
* `relationship.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship ID
303303
* `relationship.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship type
@@ -330,7 +330,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl
330330

331331
### kebab
332332

333-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
333+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
334334

335335
Converts camelCase into kebab-case
336336

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

349349
### linkRelationships
350350

351-
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
351+
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
352352

353353
Links relationships to included data
354354

@@ -386,7 +386,7 @@ Returns **any** Parsed data
386386

387387
### query
388388

389-
[packages/kitsu-core/src/query/index.js:33-42](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu-core/src/query/index.js#L33-L42 "Source code on GitHub")
389+
[packages/kitsu-core/src/query/index.js:33-42](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu-core/src/query/index.js#L33-L42 "Source code on GitHub")
390390

391391
Constructs a URL query string for JSON:API parameters
392392

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

415415
### serialise
416416

417-
[packages/kitsu-core/src/serialise/index.js:213-224](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu-core/src/serialise/index.js#L213-L224 "Source code on GitHub")
417+
[packages/kitsu-core/src/serialise/index.js:213-224](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu-core/src/serialise/index.js#L213-L224 "Source code on GitHub")
418418

419419
Serialises an object into a JSON-API structure
420420

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

460460
### snake
461461

462-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
462+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
463463

464464
Converts camelCase into snake_case
465465

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

478478
### splitModel
479479

480-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
480+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
481481

482482
Split model name from the model's resource URL
483483

‎packages/kitsu/README.md‎

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

243243
### Kitsu
244244

245-
[packages/kitsu/src/index.js:31-506](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu/src/index.js#L31-L506 "Source code on GitHub")
245+
[packages/kitsu/src/index.js:31-506](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu/src/index.js#L31-L506 "Source code on GitHub")
246246

247247
Creates a new `kitsu` instance
248248

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

288288
#### plural
289289

290-
[packages/kitsu/src/index.js:53-54](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu/src/index.js#L53-L54 "Source code on GitHub")
290+
[packages/kitsu/src/index.js:53-54](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu/src/index.js#L53-L54 "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:68-68](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu/src/index.js#L68-L68 "Source code on GitHub")
309+
[packages/kitsu/src/index.js:68-68](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu/src/index.js#L68-L68 "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:113-113](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub")
337+
[packages/kitsu/src/index.js:113-113](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu/src/index.js#L113-L113 "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:210-231](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu/src/index.js#L210-L231 "Source code on GitHub")
384+
[packages/kitsu/src/index.js:210-231](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu/src/index.js#L210-L231 "Source code on GitHub")
385385

386386
Fetch resources (alias `fetch`)
387387

@@ -517,7 +517,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
517517
518518
#### patch
519519
520-
[packages/kitsu/src/index.js:266-293](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu/src/index.js#L266-L293 "Source code on GitHub")
520+
[packages/kitsu/src/index.js:266-293](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu/src/index.js#L266-L293 "Source code on GitHub")
521521
522522
Update a resource (alias `update`)
523523
@@ -578,7 +578,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
578578
579579
#### post
580580
581-
[packages/kitsu/src/index.js:323-348](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu/src/index.js#L323-L348 "Source code on GitHub")
581+
[packages/kitsu/src/index.js:323-348](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu/src/index.js#L323-L348 "Source code on GitHub")
582582
583583
Create a new resource (alias `create`)
584584
@@ -622,7 +622,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
622622
623623
#### delete
624624
625-
[packages/kitsu/src/index.js:365-398](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu/src/index.js#L365-L398 "Source code on GitHub")
625+
[packages/kitsu/src/index.js:365-398](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu/src/index.js#L365-L398 "Source code on GitHub")
626626
627627
Remove a resource (alias `remove`)
628628
@@ -653,7 +653,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
653653
654654
#### self
655655
656-
[packages/kitsu/src/index.js:421-430](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu/src/index.js#L421-L430 "Source code on GitHub")
656+
[packages/kitsu/src/index.js:421-430](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu/src/index.js#L421-L430 "Source code on GitHub")
657657
658658
Get the authenticated user's data
659659
@@ -690,7 +690,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
690690
691691
#### request
692692
693-
[packages/kitsu/src/index.js:484-505](https://github.com/wopian/kitsu/blob/f66d077c8872a0f4c34ed46a48086ec32cdaf64e/packages/kitsu/src/index.js#L484-L505 "Source code on GitHub")
693+
[packages/kitsu/src/index.js:484-505](https://github.com/wopian/kitsu/blob/510529454e3b28b8d0877f2c7f6076bedad06323/packages/kitsu/src/index.js#L484-L505 "Source code on GitHub")
694694
695695
Send arbitrary requests
696696

0 commit comments

Comments
 (0)
⚡