Skip to content

Commit

Permalink
chore(release): update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@wopian
wopian committed Jun 20, 2023
1 parent c741e0a commit b61d79f
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 22 deletions.
24 changes: 12 additions & 12 deletions packages/kitsu-core/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")

Converts kebab-case and snake\_case into camelCase

Expand All @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")

Hoists attributes to be top-level

Expand Down Expand Up @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu-core/src/deserialise/index.js#L62-L77 "Source code on GitHub")

Deserialises a JSON-API response

Expand Down Expand Up @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/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.

Expand Down Expand Up @@ -292,7 +292,7 @@ error({

### filterIncludes

[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")

Filters includes for the specific relationship requested

Expand Down Expand Up @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")

Converts camelCase into kebab-case

Expand All @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu-core/src/linkRelationships/index.js#L145-L165 "Source code on GitHub")

Links relationships to included data

Expand Down Expand Up @@ -390,7 +390,7 @@ Returns **any** Parsed data

### isDeepEqual

[packages/kitsu-core/src/deepEqual/index.js:18-42](https://github.com/wopian/kitsu/blob/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu-core/src/deepEqual/index.js#L18-L42 "Source code on GitHub")

Compare two objects equality

Expand Down Expand Up @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu-core/src/query/index.js#L55-L64 "Source code on GitHub")

Constructs a URL query string for JSON:API parameters

Expand Down Expand Up @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu-core/src/serialise/index.js#L213-L224 "Source code on GitHub")

Serialises an object into a JSON-API structure

Expand Down Expand Up @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")

Converts camelCase into snake\_case

Expand All @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/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/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")

Split model name from the model's resource URL

Expand Down
21 changes: 11 additions & 10 deletions packages/kitsu/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ All code released under [MIT]

### Kitsu

[packages/kitsu/src/index.js:31-535](https://github.com/wopian/kitsu/blob/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/packages/kitsu/src/index.js#L31-L535 "Source code on GitHub")
[packages/kitsu/src/index.js:31-536](https://github.com/wopian/kitsu/blob/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu/src/index.js#L31-L536 "Source code on GitHub")

Creates a new `kitsu` instance

Expand Down Expand Up @@ -287,7 +287,7 @@ const api = new Kitsu({

#### plural

[packages/kitsu/src/index.js:58-59](https://github.com/wopian/kitsu/blob/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/packages/kitsu/src/index.js#L58-L59 "Source code on GitHub")
[packages/kitsu/src/index.js:58-59](https://github.com/wopian/kitsu/blob/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu/src/index.js#L58-L59 "Source code on GitHub")

* **See**: <https://www.npmjs.com/package/pluralize> for documentation
* **See**: [Kitsu](#kitsu) constructor options for disabling pluralization
Expand All @@ -306,7 +306,7 @@ api.plural.plural('paper') //=> 'paper'

#### headers

[packages/kitsu/src/index.js:73-73](https://github.com/wopian/kitsu/blob/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/packages/kitsu/src/index.js#L73-L73 "Source code on GitHub")
[packages/kitsu/src/index.js:73-73](https://github.com/wopian/kitsu/blob/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu/src/index.js#L73-L73 "Source code on GitHub")

Get the current headers or add additional headers

Expand Down Expand Up @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/packages/kitsu/src/index.js#L119-L119 "Source code on GitHub")
[packages/kitsu/src/index.js:119-119](https://github.com/wopian/kitsu/blob/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu/src/index.js#L119-L119 "Source code on GitHub")

* **See**: <https://github.com/axios/axios#interceptors> for documentation

Expand Down Expand Up @@ -381,7 +381,7 @@ api.interceptors.request.eject(myInterceptor)

#### get

[packages/kitsu/src/index.js:217-246](https://github.com/wopian/kitsu/blob/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/packages/kitsu/src/index.js#L217-L246 "Source code on GitHub")
[packages/kitsu/src/index.js:217-246](https://github.com/wopian/kitsu/blob/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu/src/index.js#L217-L246 "Source code on GitHub")

Fetch resources (alias `fetch`)

Expand Down Expand Up @@ -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/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/packages/kitsu/src/index.js#L282-L310 "Source code on GitHub")
[packages/kitsu/src/index.js:282-310](https://github.com/wopian/kitsu/blob/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu/src/index.js#L282-L310 "Source code on GitHub")
Update a resource (alias `update`)
Expand Down Expand Up @@ -580,7 +580,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
#### post
[packages/kitsu/src/index.js:344-370](https://github.com/wopian/kitsu/blob/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/packages/kitsu/src/index.js#L344-L370 "Source code on GitHub")
[packages/kitsu/src/index.js:345-371](https://github.com/wopian/kitsu/blob/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu/src/index.js#L345-L371 "Source code on GitHub")
Create a new resource (alias `create`)
Expand All @@ -592,6 +592,7 @@ Create a new resource (alias `create`)
* `config.params` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** JSON:API request queries. See [#get](#get) for documentation
* `config.headers` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Additional headers to send with the request
* `config.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)
##### Examples
Expand Down Expand Up @@ -628,7 +629,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
#### delete
[packages/kitsu/src/index.js:390-424](https://github.com/wopian/kitsu/blob/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/packages/kitsu/src/index.js#L390-L424 "Source code on GitHub")
[packages/kitsu/src/index.js:391-425](https://github.com/wopian/kitsu/blob/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu/src/index.js#L391-L425 "Source code on GitHub")
Remove a resource (alias `remove`)
Expand Down Expand Up @@ -666,7 +667,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
#### self
[packages/kitsu/src/index.js:448-457](https://github.com/wopian/kitsu/blob/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/packages/kitsu/src/index.js#L448-L457 "Source code on GitHub")
[packages/kitsu/src/index.js:449-458](https://github.com/wopian/kitsu/blob/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu/src/index.js#L449-L458 "Source code on GitHub")
Get the authenticated user's data
Expand Down Expand Up @@ -704,7 +705,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
#### request
[packages/kitsu/src/index.js:512-534](https://github.com/wopian/kitsu/blob/474d91bfbe1671855ff026cba5e9e71d5a6b1e62/packages/kitsu/src/index.js#L512-L534 "Source code on GitHub")
[packages/kitsu/src/index.js:513-535](https://github.com/wopian/kitsu/blob/c741e0ac26d4c215c11dbbeefd55e28ba34a9498/packages/kitsu/src/index.js#L513-L535 "Source code on GitHub")
Send arbitrary requests
Expand Down
3 changes: 3 additions & 0 deletions packages/kitsu/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ export default class Kitsu {
create: (model: string, body: any | any[], config?: {
params?: any;
headers?: any;
axiosOptions?: any;
}) => any | any[];
remove: (model: string, id: string | number | number[], config?: {
params?: any;
Expand Down Expand Up @@ -272,6 +273,7 @@ export default class Kitsu {
* @param {Object} [config] Additional configuration
* @param {Object} [config.params] JSON:API request queries. See [#get](#get) for documentation
* @param {Object} [config.headers] Additional headers to send with the request
* @param {Object} [config.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
* @returns {Object|Object[]} JSON-parsed response
* @example <caption>Create a post on a user's profile feed</caption>
* api.create('posts', {
Expand All @@ -298,6 +300,7 @@ export default class Kitsu {
post(model: string, body: any | any[], config?: {
params?: any;
headers?: any;
axiosOptions?: any;
}): any | any[];
/**
* Remove a resource (alias `remove`)
Expand Down

0 comments on commit b61d79f

Please sign in to comment.