Skip to content

Commit 3817edc

Browse files
wopianwopian
committed
chore(release): update documentation
1 parent 8811add commit 3817edc

2 files changed

Lines changed: 24 additions & 24 deletions

File tree

‎packages/kitsu-core/README.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu-core/MIGRATING.md>Migration guide</a> for v9 & previous major releases</p>
3030

31-
#
31+
#
3232

3333
## Features
3434

@@ -118,7 +118,7 @@ kitsuCore.camel(...)
118118

119119
### deattribute
120120

121-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
121+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
122122

123123
Hoists attributes to be top-level
124124

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

163163
### deserialise
164164

165-
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
165+
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
166166

167167
Deserialises a JSON-API response
168168

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

215215
### error
216216

217-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
217+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
218218

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

@@ -251,14 +251,14 @@ error({
251251

252252
### filterIncludes
253253

254-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
254+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
255255

256256
Filters includes for the specific relationship requested
257257

258258
#### Parameters
259259

260260
- `included` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>** The response included object
261-
- `relationship` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
261+
- `relationship` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
262262
- `relationship.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship ID
263263
- `relationship.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship type
264264

@@ -290,7 +290,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl
290290

291291
### linkRelationships
292292

293-
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
293+
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
294294

295295
Links relationships to included data
296296

@@ -328,7 +328,7 @@ Returns **any** Parsed data
328328

329329
### query
330330

331-
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
331+
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
332332

333333
Constructs a URL query string for JSON:API parameters
334334

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

357357
### serialise
358358

359-
[packages/kitsu-core/src/serialise/index.js:249-260](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu-core/src/serialise/index.js#L249-L260 "Source code on GitHub")
359+
[packages/kitsu-core/src/serialise/index.js:249-260](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/serialise/index.js#L249-L260 "Source code on GitHub")
360360

361361
Serialises an object into a JSON-API structure
362362

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

403403
### splitModel
404404

405-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
405+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
406406

407407
Split model name from the model's resource URL
408408

@@ -445,7 +445,7 @@ Returns **\[[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference
445445

446446
### camel
447447

448-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
448+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
449449

450450
Converts kebab-case and snake_case into camelCase
451451

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

474474
### kebab
475475

476-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
476+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
477477

478478
Converts camelCase into kebab-case
479479

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

492492
### snake
493493

494-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
494+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
495495

496496
Converts camelCase into snake_case
497497

‎packages/kitsu/README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu/MIGRATING.md>Migration guide</a> for v9 & previous major releases</p>
3030

31-
#
31+
#
3232

3333
## Features
3434

@@ -213,7 +213,7 @@ If you're working with [Kitsu.io]'s API, their [API docs][kitsu.io api docs] lis
213213

214214
### Kitsu
215215

216-
[packages/kitsu/src/index.js:30-463](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu/src/index.js#L30-L463 "Source code on GitHub")
216+
[packages/kitsu/src/index.js:30-463](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L30-L463 "Source code on GitHub")
217217

218218
Creates a new `kitsu` instance
219219

@@ -260,7 +260,7 @@ const api = new Kitsu({
260260

261261
#### plural
262262

263-
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
263+
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
264264

265265
- **See: <https://www.npmjs.com/package/pluralize> for documentation
266266
**
@@ -282,7 +282,7 @@ api.plural.plural('paper') //=> 'paper'
282282

283283
#### headers
284284

285-
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
285+
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
286286

287287
Get the current headers or add additional headers
288288

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

314314
#### interceptors
315315

316-
[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
316+
[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
317317

318318
- **See: <https://github.com/axios/axios#interceptors> for documentation
319319
**
@@ -364,7 +364,7 @@ api.interceptors.request.eject(myInterceptor)
364364

365365
#### get
366366

367-
[packages/kitsu/src/index.js:189-208](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu/src/index.js#L189-L208 "Source code on GitHub")
367+
[packages/kitsu/src/index.js:189-208](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L189-L208 "Source code on GitHub")
368368

369369
Fetch resources (alias `fetch`)
370370

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

481481
#### patch
482482

483-
[packages/kitsu/src/index.js:241-261](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu/src/index.js#L241-L261 "Source code on GitHub")
483+
[packages/kitsu/src/index.js:241-261](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L241-L261 "Source code on GitHub")
484484

485485
Update a resource (alias `update`)
486486

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

544544
#### post
545545

546-
[packages/kitsu/src/index.js:289-308](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu/src/index.js#L289-L308 "Source code on GitHub")
546+
[packages/kitsu/src/index.js:289-308](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L289-L308 "Source code on GitHub")
547547

548548
Create a new resource (alias `create`)
549549

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

587587
#### delete
588588

589-
[packages/kitsu/src/index.js:323-352](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu/src/index.js#L323-L352 "Source code on GitHub")
589+
[packages/kitsu/src/index.js:323-352](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L323-L352 "Source code on GitHub")
590590

591591
Remove a resource (alias `remove`)
592592

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

617617
#### self
618618

619-
[packages/kitsu/src/index.js:374-381](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu/src/index.js#L374-L381 "Source code on GitHub")
619+
[packages/kitsu/src/index.js:374-381](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L374-L381 "Source code on GitHub")
620620

621621
Get the authenticated user's data
622622

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

654654
#### request
655655

656-
[packages/kitsu/src/index.js:442-462](https://github.com/wopian/kitsu/blob/211967e91fa32267485c60434789cb09de5412b9/packages/kitsu/src/index.js#L442-L462 "Source code on GitHub")
656+
[packages/kitsu/src/index.js:442-462](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L442-L462 "Source code on GitHub")
657657

658658
Send arbitrary requests
659659

0 commit comments

Comments
 (0)
⚡