From 1003175d2f019babbb6980ce83916daebb369f88 Mon Sep 17 00:00:00 2001 From: wopian Date: Thu, 14 Mar 2024 20:58:12 +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 22d46ec9..0c94af30 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/b1f15bfb16d62669a319e7bdea40df272917ebae/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/81ff55cf5df30778492849d174740884b6cd6e58/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/b1f15bfb16d62669a319e7bdea40df272917ebae/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/81ff55cf5df30778492849d174740884b6cd6e58/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/b1f15bfb16d62669a319e7bdea40df272917ebae/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/81ff55cf5df30778492849d174740884b6cd6e58/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/b1f15bfb16d62669a319e7bdea40df272917ebae/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/81ff55cf5df30778492849d174740884b6cd6e58/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/b1f15bfb16d62669a319e7bdea40df272917ebae/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/81ff55cf5df30778492849d174740884b6cd6e58/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/b1f15bfb16d62669a319e7bdea40df272917ebae/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/81ff55cf5df30778492849d174740884b6cd6e58/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:145-165](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu-core/src/linkRelationships/index.js#L145-L165 "Source code on GitHub") +[packages/kitsu-core/src/linkRelationships/index.js:145-165](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu-core/src/linkRelationships/index.js#L145-L165 "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/b1f15bfb16d62669a319e7bdea40df272917ebae/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/81ff55cf5df30778492849d174740884b6cd6e58/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:55-64](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu-core/src/query/index.js#L55-L64 "Source code on GitHub") +[packages/kitsu-core/src/query/index.js:55-64](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu-core/src/query/index.js#L55-L64 "Source code on GitHub") Constructs a URL query string for JSON:API parameters @@ -448,7 +448,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/b1f15bfb16d62669a319e7bdea40df272917ebae/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/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu-core/src/serialise/index.js#L213-L224 "Source code on GitHub") Serialises an object into a JSON-API structure @@ -493,7 +493,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/b1f15bfb16d62669a319e7bdea40df272917ebae/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/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub") Converts camelCase into snake\_case @@ -511,7 +511,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/b1f15bfb16d62669a319e7bdea40df272917ebae/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/81ff55cf5df30778492849d174740884b6cd6e58/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 fef1098b..6ee5ba90 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:31-536](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu/src/index.js#L31-L536 "Source code on GitHub") +[packages/kitsu/src/index.js:31-536](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu/src/index.js#L31-L536 "Source code on GitHub") Creates a new `kitsu` instance @@ -287,7 +287,7 @@ const api = new Kitsu({ #### plural -[packages/kitsu/src/index.js:58-59](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu/src/index.js#L58-L59 "Source code on GitHub") +[packages/kitsu/src/index.js:58-59](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu/src/index.js#L58-L59 "Source code on GitHub") * **See**: for documentation * **See**: [Kitsu](#kitsu) constructor options for disabling pluralization @@ -306,7 +306,7 @@ api.plural.plural('paper') //=> 'paper' #### headers -[packages/kitsu/src/index.js:73-73](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu/src/index.js#L73-L73 "Source code on GitHub") +[packages/kitsu/src/index.js:73-73](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu/src/index.js#L73-L73 "Source code on GitHub") Get the current headers or add additional headers @@ -334,7 +334,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G #### interceptors -[packages/kitsu/src/index.js:119-119](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu/src/index.js#L119-L119 "Source code on GitHub") +[packages/kitsu/src/index.js:119-119](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu/src/index.js#L119-L119 "Source code on GitHub") * **See**: for documentation @@ -381,7 +381,7 @@ api.interceptors.request.eject(myInterceptor) #### get -[packages/kitsu/src/index.js:217-246](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu/src/index.js#L217-L246 "Source code on GitHub") +[packages/kitsu/src/index.js:217-246](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu/src/index.js#L217-L246 "Source code on GitHub") Fetch resources (alias `fetch`) @@ -518,7 +518,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G #### patch -[packages/kitsu/src/index.js:282-310](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu/src/index.js#L282-L310 "Source code on GitHub") +[packages/kitsu/src/index.js:282-310](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu/src/index.js#L282-L310 "Source code on GitHub") Update a resource (alias `update`) @@ -580,7 +580,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/ #### post -[packages/kitsu/src/index.js:345-371](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu/src/index.js#L345-L371 "Source code on GitHub") +[packages/kitsu/src/index.js:345-371](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu/src/index.js#L345-L371 "Source code on GitHub") Create a new resource (alias `create`) @@ -629,7 +629,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/ #### delete -[packages/kitsu/src/index.js:391-425](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu/src/index.js#L391-L425 "Source code on GitHub") +[packages/kitsu/src/index.js:391-425](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu/src/index.js#L391-L425 "Source code on GitHub") Remove a resource (alias `remove`) @@ -667,7 +667,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/ #### self -[packages/kitsu/src/index.js:449-458](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu/src/index.js#L449-L458 "Source code on GitHub") +[packages/kitsu/src/index.js:449-458](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu/src/index.js#L449-L458 "Source code on GitHub") Get the authenticated user's data @@ -705,7 +705,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G #### request -[packages/kitsu/src/index.js:513-535](https://github.com/wopian/kitsu/blob/b1f15bfb16d62669a319e7bdea40df272917ebae/packages/kitsu/src/index.js#L513-L535 "Source code on GitHub") +[packages/kitsu/src/index.js:513-535](https://github.com/wopian/kitsu/blob/81ff55cf5df30778492849d174740884b6cd6e58/packages/kitsu/src/index.js#L513-L535 "Source code on GitHub") Send arbitrary requests