chore(release): update documentation

Author: wopian

packages/kitsu-core/README.md

@@ -116,7 +116,7 @@ kitsuCore.camel(...)
 
 ### deattribute
 
-[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
+[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
 
 Hoists attributes to be top-level
 
@@ -160,7 +160,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 ### deserialise
 
-[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
+[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
 
 Deserialises a JSON-API response
 
@@ -212,7 +212,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### error
 
-[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
+[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
 
 Uniform error handling for Axios, JSON:API and internal package errors. Mutated Error object is rethrown to the caller.
 
@@ -249,7 +249,7 @@ error({
 
 ### filterIncludes
 
-[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
+[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
 
 Filters includes for the specific relationship requested
 
@@ -288,7 +288,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl
 
 ### linkRelationships
 
-[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
+[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
 
 Links relationships to included data
 
@@ -326,7 +326,7 @@ Returns **any** Parsed data
 
 ### query
 
-[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
+[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
 
 Constructs a URL query string for JSON:API parameters
 
@@ -354,7 +354,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### serialise
 
-[packages/kitsu-core/src/serialise/index.js:191-202](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu-core/src/serialise/index.js#L191-L202 "Source code on GitHub")
+[packages/kitsu-core/src/serialise/index.js:191-202](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu-core/src/serialise/index.js#L191-L202 "Source code on GitHub")
 
 Serialises an object into a JSON-API structure
 
@@ -400,7 +400,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### splitModel
 
-[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
+[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
 
 Split model name from the model's resource URL
 
@@ -443,7 +443,7 @@ Returns **\[[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference
 
 ### camel
 
-[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
+[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
 
 Converts kebab-case and snake_case into camelCase
 
@@ -471,7 +471,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### kebab
 
-[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
+[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
 
 Converts camelCase into kebab-case
 
@@ -489,7 +489,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### snake
 
-[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
+[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
 
 Converts camelCase into snake_case
 

packages/kitsu/README.md

@@ -213,7 +213,7 @@ If you're working with [Kitsu.io]'s API, their [API docs][kitsu.io api docs] lis
 
 ### Kitsu
 
-[packages/kitsu/src/index.js:30-463](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu/src/index.js#L30-L463 "Source code on GitHub")
+[packages/kitsu/src/index.js:30-463](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu/src/index.js#L30-L463 "Source code on GitHub")
 
 Creates a new `kitsu` instance
 
@@ -222,9 +222,9 @@ Creates a new `kitsu` instance
 -   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options (optional, default `{}`)
     -   `options.baseURL` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Set the API endpoint (optional, default `https://kitsu.io/api/edge`)
     -   `options.headers` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Additional headers to send with the requests
-    -   `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` (optional, default `true`)
-    -   `options.resourceCase` **(`"kebab"` \| `"snake"` \| `"none"`)** `kebab`, `snake` or `none`. If `kebab`, `/libraryEntries` will become `/library-entries`. If `snake`, `/libraryEntries` will become `/library_entries`, If `none`, `/libraryEntries` will be unchanged (optional, default `kebab`)
-    -   `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 (optional, default `true`)
+    -   `options.camelCaseTypes` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If enabled, `type` will be converted to camelCase from kebab-casae or snake_case (optional, default `true`)
+    -   `options.resourceCase` **(`"kebab"` \| `"snake"` \| `"none"`)** Case to convert camelCase to. `kebab` - `/library-entries`; `snake` - /library_entries`;`none`-`/libraryEntries\` (optional, default `kebab`)
+    -   `options.pluralize` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If enabled, `/user` will become `/users` in the URL request and `type` will be pluralized in POST, PATCH and DELETE requests (optional, default `true`)
     -   `options.timeout` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Set the request timeout in milliseconds (optional, default `30000`)
     -   `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)
 
@@ -260,7 +260,7 @@ const api = new Kitsu({
 
 #### plural
 
-[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
+[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
 
 -   **See: <https://www.npmjs.com/package/pluralize> for documentation
     **
@@ -282,7 +282,7 @@ api.plural.plural('paper') //=> 'paper'
 
 #### headers
 
-[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
+[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
 
 Get the current headers or add additional headers
 
@@ -313,7 +313,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 #### interceptors
 
-[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
+[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
 
 -   **See: <https://github.com/axios/axios#interceptors> for documentation
     **
@@ -364,7 +364,7 @@ api.interceptors.request.eject(myInterceptor)
 
 #### get
 
-[packages/kitsu/src/index.js:189-208](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu/src/index.js#L189-L208 "Source code on GitHub")
+[packages/kitsu/src/index.js:189-208](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu/src/index.js#L189-L208 "Source code on GitHub")
 
 Fetch resources (alias `fetch`)
 
@@ -480,7 +480,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 #### patch
 
-[packages/kitsu/src/index.js:241-261](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu/src/index.js#L241-L261 "Source code on GitHub")
+[packages/kitsu/src/index.js:241-261](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu/src/index.js#L241-L261 "Source code on GitHub")
 
 Update a resource (alias `update`)
 
@@ -543,7 +543,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 #### post
 
-[packages/kitsu/src/index.js:289-308](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu/src/index.js#L289-L308 "Source code on GitHub")
+[packages/kitsu/src/index.js:289-308](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu/src/index.js#L289-L308 "Source code on GitHub")
 
 Create a new resource (alias `create`)
 
@@ -586,7 +586,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 #### delete
 
-[packages/kitsu/src/index.js:323-352](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu/src/index.js#L323-L352 "Source code on GitHub")
+[packages/kitsu/src/index.js:323-352](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu/src/index.js#L323-L352 "Source code on GitHub")
 
 Remove a resource (alias `remove`)
 
@@ -616,7 +616,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 #### self
 
-[packages/kitsu/src/index.js:374-381](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu/src/index.js#L374-L381 "Source code on GitHub")
+[packages/kitsu/src/index.js:374-381](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu/src/index.js#L374-L381 "Source code on GitHub")
 
 Get the authenticated user's data
 
@@ -653,7 +653,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 #### request
 
-[packages/kitsu/src/index.js:442-462](https://github.com/wopian/kitsu/blob/e8b37f177be3a94d4700518d0c6d060271653a02/packages/kitsu/src/index.js#L442-L462 "Source code on GitHub")
+[packages/kitsu/src/index.js:442-462](https://github.com/wopian/kitsu/blob/52c1c828aec0eafc07a6c698fdc91664743083a4/packages/kitsu/src/index.js#L442-L462 "Source code on GitHub")
 
 Send arbitrary requests
 

packages/kitsu/types/index.d.ts

@@ -4,9 +4,9 @@
  * @param {Object} [options] Options
  * @param {string} [options.baseURL=https://kitsu.io/api/edge] Set the API endpoint
  * @param {Object} [options.headers] Additional headers to send with the requests
- * @param {boolean} [options.camelCaseTypes=true] If true, the `type` value will be camelCased, e.g `library-entries` and `library_entries` become `libraryEntries`
- * @param {'kebab'|'snake'|'none'} [options.resourceCase=kebab] `kebab`, `snake` or `none`. If `kebab`, `/libraryEntries` will become `/library-entries`. If `snake`, `/libraryEntries` will become `/library_entries`, If `none`, `/libraryEntries` will be unchanged
- * @param {boolean} [options.pluralize=true] If `true`, `/user` will become `/users` in the URL request and `type` will be pluralized in POST, PATCH and DELETE requests
+ * @param {boolean} [options.camelCaseTypes=true] If enabled, `type` will be converted to camelCase from kebab-casae or snake_case
+ * @param {'kebab'|'snake'|'none'} [options.resourceCase=kebab] Case to convert camelCase to. `kebab` - `/library-entries`; `snake` - /library_entries`; `none` - `/libraryEntries`
+ * @param {boolean} [options.pluralize=true] If enabled, `/user` will become `/users` in the URL request and `type` will be pluralized in POST, PATCH and DELETE requests
  * @param {number} [options.timeout=30000] Set the request timeout in milliseconds
  * @param {Object} [options.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
  * @example <caption>Using with Kitsu.io's API</caption>