Skip to content

Commit 523553e

Browse files
committed
chore(release): update documentation
1 parent b678290 commit 523553e

3 files changed

Lines changed: 30 additions & 30 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<h1 align=center>Kitsu</h1>
22

33
<p align=center>
4-
<a href=https://travis-ci.org/wopian/kitsu><img alt=travis src=https://flat.badgen.net/travis/wopian/kitsu></a>
4+
<a href=https://travis-ci.com/wopian/kitsu><img alt=travis src=https://flat.badgen.net/travis/wopian/kitsu></a>
55
<a href="https://david-dm.org/wopian/kitsu?type=dev"><img alt=devDeps src=https://flat.badgen.net/david/dev/wopian/kitsu></a>
66
<a href=https://github.com/wopian/kitsu/graphs/contributors><img alt=contributors src=https://flat.badgen.net/github/contributors/wopian/kitsu></a>
77
</p>

packages/kitsu-core/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
</p>
99

1010
<p align=center>
11-
<a href=https://travis-ci.org/wopian/kitsu><img alt=travis src=https://flat.badgen.net/travis/wopian/kitsu></a>
11+
<a href=https://travis-ci.com/wopian/kitsu><img alt=travis src=https://flat.badgen.net/travis/wopian/kitsu></a>
1212
<a href="https://packagephobia.now.sh/result?p=kitsu-core"><img alt=packagephobia src=https://flat.badgen.net/packagephobia/install/kitsu-core></a>
1313
<a href=https://github.com/wopian/kitsu/graphs/contributors><img alt=contributors src=https://flat.badgen.net/github/contributors/wopian/kitsu></a>
1414
</p>
@@ -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 and previous major releases</p>
3030

31-
#
31+
#
3232

3333
## Features
3434

@@ -116,7 +116,7 @@ kitsuCore.camel(...)
116116

117117
### deattribute
118118

119-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
119+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
120120

121121
Hoists attributes to be top-level
122122

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

161161
### deserialise
162162

163-
[packages/kitsu-core/src/deserialise/index.js:57-74](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/deserialise/index.js#L57-L74 "Source code on GitHub")
163+
[packages/kitsu-core/src/deserialise/index.js:57-74](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu-core/src/deserialise/index.js#L57-L74 "Source code on GitHub")
164164

165165
Deserialises a JSON-API response
166166

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

213213
### error
214214

215-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
215+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
216216

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

@@ -249,14 +249,14 @@ error({
249249

250250
### filterIncludes
251251

252-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
252+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
253253

254254
Filters includes for the specific relationship requested
255255

256256
#### Parameters
257257

258258
- `included` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The response included object
259-
- `relationship` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
259+
- `relationship` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
260260
- `relationship.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship ID
261261
- `relationship.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship type
262262

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

289289
### linkRelationships
290290

291-
[packages/kitsu-core/src/linkRelationships/index.js:98-118](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/linkRelationships/index.js#L98-L118 "Source code on GitHub")
291+
[packages/kitsu-core/src/linkRelationships/index.js:98-118](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu-core/src/linkRelationships/index.js#L98-L118 "Source code on GitHub")
292292

293293
Links relationships to included data
294294

@@ -326,7 +326,7 @@ Returns **any** Parsed data
326326

327327
### query
328328

329-
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
329+
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
330330

331331
Constructs a URL query string for JSON:API parameters
332332

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

355355
### serialise
356356

357-
[packages/kitsu-core/src/serialise/index.js:119-152](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/serialise/index.js#L119-L152 "Source code on GitHub")
357+
[packages/kitsu-core/src/serialise/index.js:119-152](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu-core/src/serialise/index.js#L119-L152 "Source code on GitHub")
358358

359359
Serialises an object into a JSON-API structure
360360

@@ -400,14 +400,14 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
400400

401401
### splitModel
402402

403-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
403+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
404404

405405
Split model name from the model's resource URL
406406

407407
#### Parameters
408408

409409
- `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** URL path for the model
410-
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
410+
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
411411
- `options.resourceCase` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Convert libraryEntries to library-entries or library_entries (default no conversion). To use parameter, import kebab or snake from kitsu-core
412412
- `options.pluralModel` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Pluralise models (default no pluralisation). To use parameter, import pluralize (or another pluralisation npm package)
413413

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

444444
### camel
445445

446-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
446+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
447447

448448
Converts kebab-case and snake_case into camelCase
449449

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

472472
### kebab
473473

474-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
474+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
475475

476476
Converts camelCase into kebab-case
477477

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

490490
### snake
491491

492-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
492+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
493493

494494
Converts camelCase into snake_case
495495

packages/kitsu/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
</p>
99

1010
<p align=center>
11-
<a href=https://travis-ci.org/wopian/kitsu><img alt=travis src=https://flat.badgen.net/travis/wopian/kitsu></a>
11+
<a href=https://travis-ci.com/wopian/kitsu><img alt=travis src=https://flat.badgen.net/travis/wopian/kitsu></a>
1212
<a href="https://packagephobia.now.sh/result?p=kitsu"><img alt=packagephobia src=https://flat.badgen.net/packagephobia/install/kitsu></a>
1313
<a href=https://github.com/wopian/kitsu/graphs/contributors><img alt=contributors src=https://flat.badgen.net/github/contributors/wopian/kitsu></a>
1414
</p>
@@ -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 and previous major releases</p>
3030

31-
#
31+
#
3232

3333
## Features
3434

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

212212
### Kitsu
213213

214-
[packages/kitsu/src/index.js:30-342](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu/src/index.js#L30-L342 "Source code on GitHub")
214+
[packages/kitsu/src/index.js:30-342](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu/src/index.js#L30-L342 "Source code on GitHub")
215215

216216
Creates a new `kitsu` instance
217217

@@ -222,9 +222,9 @@ Creates a new `kitsu` instance
222222
- `options.headers` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Additional headers to send with requests
223223
- `options.camelCaseTypes` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If true, the `type` value will be camelCased, e.g `library-entries` and `library_entries` become `libraryEntries` (default `true`)
224224
- `options.resourceCase` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** `kebab`, `snake` or `none`. If `kebab`, `/libraryEntries` will become `/library-entries`. If `snake`, `/libraryEntries` will become `/library_entries`, If `none`, `/libraryEntries` will be unchanged (default `kebab`)
225-
- `options.pluralize` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If `true`, `/user` will become `/users` in the URL request and `type` will be pluralized in post, patch and delete requests - `user` -> `users` (default `true`)
225+
- `options.pluralize` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If `true`, `/user` will become `/users` in the URL request and `type` will be pluralized in POST, PATCH and DELETE requests (default `true`)
226226
- `options.timeout` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Set the request timeout in milliseconds (default `30000`)
227-
- `options.axiosOptions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Additional options for the axios instance
227+
- `options.axiosOptions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
228228

229229
#### Examples
230230

@@ -258,7 +258,7 @@ const api = new Kitsu({
258258

259259
#### plural
260260

261-
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
261+
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
262262

263263
- **See: <https://www.npmjs.com/package/pluralize> for documentation
264264
**
@@ -280,7 +280,7 @@ api.plural.plural('paper') //=> 'paper'
280280

281281
#### headers
282282

283-
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
283+
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
284284

285285
Get the current headers or add additional headers
286286

@@ -311,11 +311,11 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
311311

312312
#### interceptors
313313

314-
[packages/kitsu/src/index.js:111-111](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu/src/index.js#L111-L111 "Source code on GitHub")
314+
[packages/kitsu/src/index.js:111-111](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu/src/index.js#L111-L111 "Source code on GitHub")
315315

316316
Axios Interceptors (alias of `axios.interceptors`)
317317

318-
You can intercept responses before they are handled by `get`, `post`, `patch` and `delete` and before requests are sent to the API server.
318+
You can intercept responses before they are handled by `get`, `post`, `patch` and `delete` and before requests are sent to the API server. See [axios/axios#interceptors](https://github.com/axios/axios#interceptors) for details.
319319

320320
##### Examples
321321

@@ -359,7 +359,7 @@ api.interceptors.request.eject(myInterceptor)
359359

360360
#### get
361361

362-
[packages/kitsu/src/index.js:184-203](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu/src/index.js#L184-L203 "Source code on GitHub")
362+
[packages/kitsu/src/index.js:184-203](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu/src/index.js#L184-L203 "Source code on GitHub")
363363

364364
Fetch resources (alias `fetch`)
365365

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

472472
#### patch
473473

474-
[packages/kitsu/src/index.js:219-239](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu/src/index.js#L219-L239 "Source code on GitHub")
474+
[packages/kitsu/src/index.js:219-239](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu/src/index.js#L219-L239 "Source code on GitHub")
475475

476476
Update a resource (alias `update`)
477477

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

498498
#### post
499499

500-
[packages/kitsu/src/index.js:262-281](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu/src/index.js#L262-L281 "Source code on GitHub")
500+
[packages/kitsu/src/index.js:262-281](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu/src/index.js#L262-L281 "Source code on GitHub")
501501

502502
Create a new resource (alias `create`)
503503

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

531531
#### delete
532532

533-
[packages/kitsu/src/index.js:294-312](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu/src/index.js#L294-L312 "Source code on GitHub")
533+
[packages/kitsu/src/index.js:294-312](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu/src/index.js#L294-L312 "Source code on GitHub")
534534

535535
Remove a resource (alias `remove`)
536536

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

554554
#### self
555555

556-
[packages/kitsu/src/index.js:334-341](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu/src/index.js#L334-L341 "Source code on GitHub")
556+
[packages/kitsu/src/index.js:334-341](https://github.com/wopian/kitsu/blob/b67829002325934b88c342ed3344f48113ce843e/packages/kitsu/src/index.js#L334-L341 "Source code on GitHub")
557557

558558
Get the authenticated user's data
559559

0 commit comments

Comments
 (0)