You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<palign=center><ahref=https://github.com/wopian/kitsu/blob/master/packages/kitsu-core/MIGRATING.md>Migration guide</a> for v9 and previous major releases</p>
30
30
31
-
#
31
+
#
32
32
33
33
## Features
34
34
@@ -116,7 +116,7 @@ kitsuCore.camel(...)
116
116
117
117
### deattribute
118
118
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")
[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")
[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")
216
216
217
217
Uniform error handling for Axios, JSON:API and internal package errors. Mutated Error object is rethrown to the caller.
218
218
@@ -249,14 +249,14 @@ error({
249
249
250
250
### filterIncludes
251
251
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")
253
253
254
254
Filters includes for the specific relationship requested
255
255
256
256
#### Parameters
257
257
258
258
-`included`**[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The response included object
[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")
292
292
293
293
Links relationships to included data
294
294
@@ -326,7 +326,7 @@ Returns **any** Parsed data
326
326
327
327
### query
328
328
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")
330
330
331
331
Constructs a URL query string for JSON:API parameters
[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")
[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")
404
404
405
405
Split model name from the model's resource URL
406
406
407
407
#### Parameters
408
408
409
409
-`url`**[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** URL path for the model
-`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
412
412
-`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)
[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")
[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")
[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")
<palign=center><ahref=https://github.com/wopian/kitsu/blob/master/packages/kitsu/MIGRATING.md>Migration guide</a> for v9 and previous major releases</p>
30
30
31
-
#
31
+
#
32
32
33
33
## Features
34
34
@@ -211,7 +211,7 @@ If you're working with [Kitsu.io]'s API, their [API docs][kitsu.io api docs] lis
211
211
212
212
### Kitsu
213
213
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")
215
215
216
216
Creates a new `kitsu` instance
217
217
@@ -222,9 +222,9 @@ Creates a new `kitsu` instance
222
222
-`options.headers`**[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Additional headers to send with requests
223
223
-`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`)
224
224
-`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`)
226
226
-`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)
228
228
229
229
#### Examples
230
230
@@ -258,7 +258,7 @@ const api = new Kitsu({
258
258
259
259
#### plural
260
260
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")
262
262
263
263
-**See: <https://www.npmjs.com/package/pluralize> for documentation
[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")
[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")
315
315
316
316
Axios Interceptors (alias of `axios.interceptors`)
317
317
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.
[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")
[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")
[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")
[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")
[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")
0 commit comments