diff --git a/package.json b/package.json index e0e2c7b6..44e4178b 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "release": "yarn updated && yarn release:test && yarn release:commit && yarn release:lerna", "release:test": "jest && yarn lint && yarn docs:release && yarn build", "release:commit": "git commit -am \"chore(release): update documentation\"", - "release:lerna": "lerna publish premajor", + "release:lerna": "lerna publish --preid=alpha", "browserlist": "npx browserslist \"last 2 years, not < 0.05%\"", "size": "lerna exec size-limit" }, diff --git a/packages/kitsu-core/README.md b/packages/kitsu-core/README.md index 8dec129a..b11f637f 100644 --- a/packages/kitsu-core/README.md +++ b/packages/kitsu-core/README.md @@ -115,7 +115,7 @@ kitsuCore.camel(...) ### deattribute -[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/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/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub") Hoists attributes to be top-level @@ -159,7 +159,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/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/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/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub") Deserialises a JSON-API response @@ -211,7 +211,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/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/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/883512b04e20ae6d2dd9761c04e504b226a8c1a5/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. @@ -248,7 +248,7 @@ error({ ### filterIncludes -[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/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/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub") Filters includes for the specific relationship requested @@ -287,7 +287,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/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/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/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub") Links relationships to included data @@ -325,7 +325,7 @@ Returns **any** Parsed data ### query -[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/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/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub") Constructs a URL query string for JSON:API parameters @@ -353,7 +353,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G ### serialise -[packages/kitsu-core/src/serialise/index.js:210-221](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/serialise/index.js#L210-L221 "Source code on GitHub") +[packages/kitsu-core/src/serialise/index.js:210-221](https://github.com/wopian/kitsu/blob/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu-core/src/serialise/index.js#L210-L221 "Source code on GitHub") Serialises an object into a JSON-API structure @@ -399,7 +399,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/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/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/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub") Split model name from the model's resource URL @@ -442,7 +442,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/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/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/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub") Converts kebab-case and snake_case into camelCase @@ -470,7 +470,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/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/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/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub") Converts camelCase into kebab-case @@ -488,7 +488,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/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/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/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub") Converts camelCase into snake_case diff --git a/packages/kitsu/README.md b/packages/kitsu/README.md index 3ddfe173..30ff8bb8 100644 --- a/packages/kitsu/README.md +++ b/packages/kitsu/README.md @@ -210,7 +210,7 @@ If you're working with [Kitsu.io]'s API, their [API docs][kitsu.io api docs] lis ### Kitsu -[packages/kitsu/src/index.js:31-482](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L31-L482 "Source code on GitHub") +[packages/kitsu/src/index.js:31-482](https://github.com/wopian/kitsu/blob/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu/src/index.js#L31-L482 "Source code on GitHub") Creates a new `kitsu` instance @@ -257,7 +257,7 @@ const api = new Kitsu({ #### plural -[packages/kitsu/src/index.js:53-54](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L53-L54 "Source code on GitHub") +[packages/kitsu/src/index.js:53-54](https://github.com/wopian/kitsu/blob/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu/src/index.js#L53-L54 "Source code on GitHub") - **See: for documentation ** @@ -279,7 +279,7 @@ api.plural.plural('paper') //=> 'paper' #### headers -[packages/kitsu/src/index.js:68-68](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L68-L68 "Source code on GitHub") +[packages/kitsu/src/index.js:68-68](https://github.com/wopian/kitsu/blob/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu/src/index.js#L68-L68 "Source code on GitHub") Get the current headers or add additional headers @@ -310,7 +310,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G #### interceptors -[packages/kitsu/src/index.js:113-113](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub") +[packages/kitsu/src/index.js:113-113](https://github.com/wopian/kitsu/blob/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub") - **See: for documentation ** @@ -361,7 +361,7 @@ api.interceptors.request.eject(myInterceptor) #### get -[packages/kitsu/src/index.js:191-211](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L191-L211 "Source code on GitHub") +[packages/kitsu/src/index.js:191-211](https://github.com/wopian/kitsu/blob/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu/src/index.js#L191-L211 "Source code on GitHub") Fetch resources (alias `fetch`) @@ -478,7 +478,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G #### patch -[packages/kitsu/src/index.js:246-273](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L246-L273 "Source code on GitHub") +[packages/kitsu/src/index.js:246-273](https://github.com/wopian/kitsu/blob/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu/src/index.js#L246-L273 "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:303-328](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L303-L328 "Source code on GitHub") +[packages/kitsu/src/index.js:303-328](https://github.com/wopian/kitsu/blob/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu/src/index.js#L303-L328 "Source code on GitHub") Create a new resource (alias `create`) @@ -588,7 +588,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/ #### delete -[packages/kitsu/src/index.js:345-378](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L345-L378 "Source code on GitHub") +[packages/kitsu/src/index.js:345-378](https://github.com/wopian/kitsu/blob/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu/src/index.js#L345-L378 "Source code on GitHub") Remove a resource (alias `remove`) @@ -620,7 +620,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/ #### self -[packages/kitsu/src/index.js:399-408](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L399-L408 "Source code on GitHub") +[packages/kitsu/src/index.js:399-408](https://github.com/wopian/kitsu/blob/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu/src/index.js#L399-L408 "Source code on GitHub") Get the authenticated user's data @@ -656,7 +656,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G #### request -[packages/kitsu/src/index.js:462-481](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L462-L481 "Source code on GitHub") +[packages/kitsu/src/index.js:462-481](https://github.com/wopian/kitsu/blob/883512b04e20ae6d2dd9761c04e504b226a8c1a5/packages/kitsu/src/index.js#L462-L481 "Source code on GitHub") Send arbitrary requests