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 Mar 4, 2022
1 parent af9d893 commit eaa3d51
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 21 deletions.
22 changes: 11 additions & 11 deletions packages/kitsu-core/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ All code released under [MIT]

### camel

[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/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/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")

Converts kebab-case and snake_case into camelCase

Expand All @@ -161,7 +161,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/a130f763dbc5b721b289d7ec27d780c1dacdb28e/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/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")

Hoists attributes to be top-level

Expand Down Expand Up @@ -203,7 +203,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/a130f763dbc5b721b289d7ec27d780c1dacdb28e/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/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")

Deserialises a JSON-API response

Expand Down Expand Up @@ -253,7 +253,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/a130f763dbc5b721b289d7ec27d780c1dacdb28e/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/af9d8937117abcd678ec45e10815b6e8256a03da/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 @@ -290,7 +290,7 @@ error({

### filterIncludes

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

Filters includes for the specific relationship requested

Expand Down Expand Up @@ -330,7 +330,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/a130f763dbc5b721b289d7ec27d780c1dacdb28e/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/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")

Converts camelCase into kebab-case

Expand All @@ -348,7 +348,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G

### linkRelationships

[packages/kitsu-core/src/linkRelationships/index.js:108-128](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu-core/src/linkRelationships/index.js#L108-L128 "Source code on GitHub")
[packages/kitsu-core/src/linkRelationships/index.js:108-128](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu-core/src/linkRelationships/index.js#L108-L128 "Source code on GitHub")

Links relationships to included data

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

### query

[packages/kitsu-core/src/query/index.js:33-42](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu-core/src/query/index.js#L33-L42 "Source code on GitHub")
[packages/kitsu-core/src/query/index.js:33-42](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu-core/src/query/index.js#L33-L42 "Source code on GitHub")

Constructs a URL query string for JSON:API parameters

Expand Down Expand Up @@ -415,7 +415,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/a130f763dbc5b721b289d7ec27d780c1dacdb28e/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/af9d8937117abcd678ec45e10815b6e8256a03da/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 @@ -460,7 +460,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/a130f763dbc5b721b289d7ec27d780c1dacdb28e/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/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")

Converts camelCase into snake_case

Expand All @@ -478,7 +478,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/a130f763dbc5b721b289d7ec27d780c1dacdb28e/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/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")

Split model name from the model's resource URL

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

### Kitsu

[packages/kitsu/src/index.js:30-523](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu/src/index.js#L30-L523 "Source code on GitHub")
[packages/kitsu/src/index.js:30-523](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu/src/index.js#L30-L523 "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:52-53](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu/src/index.js#L52-L53 "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:67-67](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu/src/index.js#L67-L67 "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:113-113](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub")
[packages/kitsu/src/index.js:113-113](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu/src/index.js#L113-L113 "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:211-240](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu/src/index.js#L211-L240 "Source code on GitHub")
[packages/kitsu/src/index.js:211-240](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu/src/index.js#L211-L240 "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:276-304](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu/src/index.js#L276-L304 "Source code on GitHub")
[packages/kitsu/src/index.js:276-304](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu/src/index.js#L276-L304 "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:334-360](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu/src/index.js#L334-L360 "Source code on GitHub")
[packages/kitsu/src/index.js:334-360](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu/src/index.js#L334-L360 "Source code on GitHub")
Create a new resource (alias `create`)
Expand Down Expand Up @@ -624,7 +624,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
#### delete
[packages/kitsu/src/index.js:378-412](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu/src/index.js#L378-L412 "Source code on GitHub")
[packages/kitsu/src/index.js:378-412](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu/src/index.js#L378-L412 "Source code on GitHub")
Remove a resource (alias `remove`)
Expand Down Expand Up @@ -656,7 +656,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
#### self
[packages/kitsu/src/index.js:436-445](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu/src/index.js#L436-L445 "Source code on GitHub")
[packages/kitsu/src/index.js:436-445](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu/src/index.js#L436-L445 "Source code on GitHub")
Get the authenticated user's data
Expand Down Expand Up @@ -694,7 +694,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
#### request
[packages/kitsu/src/index.js:500-522](https://github.com/wopian/kitsu/blob/a130f763dbc5b721b289d7ec27d780c1dacdb28e/packages/kitsu/src/index.js#L500-L522 "Source code on GitHub")
[packages/kitsu/src/index.js:500-522](https://github.com/wopian/kitsu/blob/af9d8937117abcd678ec45e10815b6e8256a03da/packages/kitsu/src/index.js#L500-L522 "Source code on GitHub")
Send arbitrary requests
Expand Down

0 comments on commit eaa3d51

Please sign in to comment.