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 May 2, 2020
1 parent 79287d0 commit 5382aad
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
20 changes: 10 additions & 10 deletions packages/kitsu-core/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ kitsuCore.camel(...)

### deattribute

[packages/kitsu-core/src/deattribute/index.js:29-38](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu-core/src/deattribute/index.js#L29-L38 "Source code on GitHub")
[packages/kitsu-core/src/deattribute/index.js:29-38](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu-core/src/deattribute/index.js#L29-L38 "Source code on GitHub")

Hoists attributes to be top-level

Expand Down Expand Up @@ -153,7 +153,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/

### deserialise

[packages/kitsu-core/src/deserialise/index.js:56-72](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu-core/src/deserialise/index.js#L56-L72 "Source code on GitHub")
[packages/kitsu-core/src/deserialise/index.js:56-72](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu-core/src/deserialise/index.js#L56-L72 "Source code on GitHub")

Deserialises a JSON-API response

Expand Down Expand Up @@ -205,7 +205,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G

### error

[packages/kitsu-core/src/error/index.js:7-13](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu-core/src/error/index.js#L7-L13 "Source code on GitHub")
[packages/kitsu-core/src/error/index.js:7-13](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu-core/src/error/index.js#L7-L13 "Source code on GitHub")

Uniform error handling for Axios, JSON:API and internal package errors. Mutated Error object is rethrown to the caller.

Expand All @@ -218,7 +218,7 @@ Uniform error handling for Axios, JSON:API and internal package errors. Mutated

### filterIncludes

[packages/kitsu-core/src/filterIncludes/index.js:12-21](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu-core/src/filterIncludes/index.js#L12-L21 "Source code on GitHub")
[packages/kitsu-core/src/filterIncludes/index.js:12-21](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu-core/src/filterIncludes/index.js#L12-L21 "Source code on GitHub")

Filters includes for the specific relationship

Expand All @@ -233,7 +233,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl

### linkRelationships

[packages/kitsu-core/src/linkRelationships/index.js:55-74](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu-core/src/linkRelationships/index.js#L55-L74 "Source code on GitHub")
[packages/kitsu-core/src/linkRelationships/index.js:55-74](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu-core/src/linkRelationships/index.js#L55-L74 "Source code on GitHub")

Links relationships to included data

Expand All @@ -244,7 +244,7 @@ Links relationships to included data

### query

[packages/kitsu-core/src/query/index.js:21-32](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu-core/src/query/index.js#L21-L32 "Source code on GitHub")
[packages/kitsu-core/src/query/index.js:21-32](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu-core/src/query/index.js#L21-L32 "Source code on GitHub")

Constructs a URL query string for JSON:API parameters

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

### serialise

[packages/kitsu-core/src/serialise/index.js:96-121](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu-core/src/serialise/index.js#L96-L121 "Source code on GitHub")
[packages/kitsu-core/src/serialise/index.js:103-134](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu-core/src/serialise/index.js#L103-L134 "Source code on GitHub")

Serialises an object into a JSON-API structure

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

### camel

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

Converts kebab-case and snake_case into camelCase

Expand Down Expand Up @@ -311,7 +311,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/82b8eb4223c32ee16b3a6aec132ef843bf567493/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/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")

Converts camelCase into kebab-case

Expand All @@ -329,7 +329,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/82b8eb4223c32ee16b3a6aec132ef843bf567493/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/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")

Converts camelCase into snake_case

Expand Down
18 changes: 9 additions & 9 deletions packages/kitsu/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ If you're working with [Kitsu.io]'s API, their [API docs][kitsu.io api docs] lis

### Kitsu

[packages/kitsu/src/index.js:30-324](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu/src/index.js#L30-L324 "Source code on GitHub")
[packages/kitsu/src/index.js:30-324](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu/src/index.js#L30-L324 "Source code on GitHub")

Creates a new `kitsu` instance

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

#### plural

[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")

- **See: <https://www.npmjs.com/package/pluralize> for documentation
**
Expand All @@ -261,7 +261,7 @@ api.plural.plural('paper') //=> 'paper'

#### headers

[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")

Get the current headers or add additional headers

Expand Down Expand Up @@ -292,7 +292,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G

#### interceptors

[packages/kitsu/src/index.js:111-111](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu/src/index.js#L111-L111 "Source code on GitHub")
[packages/kitsu/src/index.js:111-111](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu/src/index.js#L111-L111 "Source code on GitHub")

Axios Interceptors (alias of `axios.interceptors`)

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

#### get

[packages/kitsu/src/index.js:184-203](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu/src/index.js#L184-L203 "Source code on GitHub")
[packages/kitsu/src/index.js:184-203](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu/src/index.js#L184-L203 "Source code on GitHub")

Fetch resources (alias `fetch`)

Expand Down Expand Up @@ -452,7 +452,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G

#### patch

[packages/kitsu/src/index.js:219-233](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu/src/index.js#L219-L233 "Source code on GitHub")
[packages/kitsu/src/index.js:219-233](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu/src/index.js#L219-L233 "Source code on GitHub")

Update a resource (alias `update`)

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

#### post

[packages/kitsu/src/index.js:256-269](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu/src/index.js#L256-L269 "Source code on GitHub")
[packages/kitsu/src/index.js:256-269](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu/src/index.js#L256-L269 "Source code on GitHub")

Create a new resource (alias `create`)

Expand Down Expand Up @@ -511,7 +511,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G

#### delete

[packages/kitsu/src/index.js:282-294](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu/src/index.js#L282-L294 "Source code on GitHub")
[packages/kitsu/src/index.js:282-294](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu/src/index.js#L282-L294 "Source code on GitHub")

Remove a resource (alias `remove`)

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

#### self

[packages/kitsu/src/index.js:316-323](https://github.com/wopian/kitsu/blob/82b8eb4223c32ee16b3a6aec132ef843bf567493/packages/kitsu/src/index.js#L316-L323 "Source code on GitHub")
[packages/kitsu/src/index.js:316-323](https://github.com/wopian/kitsu/blob/79287d0a71d36e540b69c27f86b115e56ed0674d/packages/kitsu/src/index.js#L316-L323 "Source code on GitHub")

Get the authenticated user's data

Expand Down

0 comments on commit 5382aad

Please sign in to comment.