From 9d5a256ef8714c2e484700f7fbd7d37e5c0016d7 Mon Sep 17 00:00:00 2001 From: wopian Date: Sun, 30 Oct 2022 17:49:43 +0000 Subject: [PATCH] chore(release): update documentation --- packages/kitsu-core/README.md | 24 ++++++++++++------------ packages/kitsu/README.md | 20 ++++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/packages/kitsu-core/README.md b/packages/kitsu-core/README.md index 94115c3f..458d26de 100644 --- a/packages/kitsu-core/README.md +++ b/packages/kitsu-core/README.md @@ -137,7 +137,7 @@ All code released under [MIT] ### camel -[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/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/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub") Converts kebab-case and snake\_case into camelCase @@ -163,7 +163,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G ### deattribute -[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/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/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub") Hoists attributes to be top-level @@ -205,7 +205,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/ ### deserialise -[packages/kitsu-core/src/deserialise/index.js:62-77](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu-core/src/deserialise/index.js#L62-L77 "Source code on GitHub") +[packages/kitsu-core/src/deserialise/index.js:62-77](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/deserialise/index.js#L62-L77 "Source code on GitHub") Deserialises a JSON-API response @@ -255,7 +255,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/f6e53cb3d654f12335370fb083969b12ee59ff94/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/55f31c666be1b67ae2eb7d5d16fecd181c0028db/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. @@ -292,7 +292,7 @@ error({ ### filterIncludes -[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/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/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub") Filters includes for the specific relationship requested @@ -332,7 +332,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl ### kebab -[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/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/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub") Converts camelCase into kebab-case @@ -350,7 +350,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G ### linkRelationships -[packages/kitsu-core/src/linkRelationships/index.js:144-164](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu-core/src/linkRelationships/index.js#L144-L164 "Source code on GitHub") +[packages/kitsu-core/src/linkRelationships/index.js:144-164](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/linkRelationships/index.js#L144-L164 "Source code on GitHub") Links relationships to included data @@ -390,7 +390,7 @@ Returns **any** Parsed data ### isDeepEqual -[packages/kitsu-core/src/deepEqual/index.js:18-42](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu-core/src/deepEqual/index.js#L18-L42 "Source code on GitHub") +[packages/kitsu-core/src/deepEqual/index.js:18-42](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/deepEqual/index.js#L18-L42 "Source code on GitHub") Compare two objects equality @@ -419,7 +419,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/ ### query -[packages/kitsu-core/src/query/index.js:34-43](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu-core/src/query/index.js#L34-L43 "Source code on GitHub") +[packages/kitsu-core/src/query/index.js:34-43](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/query/index.js#L34-L43 "Source code on GitHub") Constructs a URL query string for JSON:API parameters @@ -447,7 +447,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G ### serialise -[packages/kitsu-core/src/serialise/index.js:213-224](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu-core/src/serialise/index.js#L213-L224 "Source code on GitHub") +[packages/kitsu-core/src/serialise/index.js:213-224](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/serialise/index.js#L213-L224 "Source code on GitHub") Serialises an object into a JSON-API structure @@ -492,7 +492,7 @@ Returns **[Object](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/f6e53cb3d654f12335370fb083969b12ee59ff94/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/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub") Converts camelCase into snake\_case @@ -510,7 +510,7 @@ Returns **[string](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/f6e53cb3d654f12335370fb083969b12ee59ff94/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/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub") Split model name from the model's resource URL diff --git a/packages/kitsu/README.md b/packages/kitsu/README.md index e35428cb..dc11634c 100644 --- a/packages/kitsu/README.md +++ b/packages/kitsu/README.md @@ -241,7 +241,7 @@ All code released under [MIT] ### Kitsu -[packages/kitsu/src/index.js:30-529](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu/src/index.js#L30-L529 "Source code on GitHub") +[packages/kitsu/src/index.js:30-529](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu/src/index.js#L30-L529 "Source code on GitHub") Creates a new `kitsu` instance @@ -286,7 +286,7 @@ const api = new Kitsu({ #### plural -[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub") +[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub") * **See**: for documentation * **See**: [Kitsu](#kitsu) constructor options for disabling pluralization @@ -305,7 +305,7 @@ api.plural.plural('paper') //=> 'paper' #### headers -[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub") +[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub") Get the current headers or add additional headers @@ -333,7 +333,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/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub") +[packages/kitsu/src/index.js:113-113](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub") * **See**: for documentation @@ -380,7 +380,7 @@ api.interceptors.request.eject(myInterceptor) #### get -[packages/kitsu/src/index.js:211-240](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu/src/index.js#L211-L240 "Source code on GitHub") +[packages/kitsu/src/index.js:211-240](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu/src/index.js#L211-L240 "Source code on GitHub") Fetch resources (alias `fetch`) @@ -517,7 +517,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G #### patch -[packages/kitsu/src/index.js:276-304](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu/src/index.js#L276-L304 "Source code on GitHub") +[packages/kitsu/src/index.js:276-304](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu/src/index.js#L276-L304 "Source code on GitHub") Update a resource (alias `update`) @@ -579,7 +579,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/ #### post -[packages/kitsu/src/index.js:338-364](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu/src/index.js#L338-L364 "Source code on GitHub") +[packages/kitsu/src/index.js:338-364](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu/src/index.js#L338-L364 "Source code on GitHub") Create a new resource (alias `create`) @@ -627,7 +627,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/ #### delete -[packages/kitsu/src/index.js:384-418](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu/src/index.js#L384-L418 "Source code on GitHub") +[packages/kitsu/src/index.js:384-418](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu/src/index.js#L384-L418 "Source code on GitHub") Remove a resource (alias `remove`) @@ -665,7 +665,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/ #### self -[packages/kitsu/src/index.js:442-451](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu/src/index.js#L442-L451 "Source code on GitHub") +[packages/kitsu/src/index.js:442-451](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu/src/index.js#L442-L451 "Source code on GitHub") Get the authenticated user's data @@ -703,7 +703,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G #### request -[packages/kitsu/src/index.js:506-528](https://github.com/wopian/kitsu/blob/f6e53cb3d654f12335370fb083969b12ee59ff94/packages/kitsu/src/index.js#L506-L528 "Source code on GitHub") +[packages/kitsu/src/index.js:506-528](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu/src/index.js#L506-L528 "Source code on GitHub") Send arbitrary requests