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 Aug 11, 2022
1 parent d0a0faa commit 7c3f365
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 23 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 @@ -114,7 +114,7 @@ kitsuCore.camel(...)

### deattribute

[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/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/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")

Hoists attributes to be top-level

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

Deserialises a JSON-API response

Expand Down Expand Up @@ -199,14 +199,14 @@ deserialise({
attributes: { slug: 'wopian' }
}
]
}) // { data: { id: '1', user: { type: 'users', id: '2', slug: 'wopian' } } }
}) // { data: { id: '1', user: { data: { type: 'users', id: '2', slug: 'wopian' } } } }
```

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The deserialised response

### error

[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/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/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/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 @@ -243,7 +243,7 @@ error({

### filterIncludes

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

Filters includes for the specific relationship requested

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

### linkRelationships

[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")

Links relationships to included data

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

### query

[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")

Constructs a URL query string for JSON:API parameters

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

### serialise

[packages/kitsu-core/src/serialise/index.js:249-260](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu-core/src/serialise/index.js#L249-L260 "Source code on GitHub")
[packages/kitsu-core/src/serialise/index.js:249-260](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu-core/src/serialise/index.js#L249-L260 "Source code on GitHub")

Serialises an object into a JSON-API structure

Expand Down Expand Up @@ -394,7 +394,7 @@ Returns **[Object](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/4b56ec348001e80ae4b33479fa728805729511f6/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/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")

Split model name from the model's resource URL

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

### camel

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

Converts kebab-case and snake_case into camelCase

Expand All @@ -462,7 +462,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/4b56ec348001e80ae4b33479fa728805729511f6/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/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")

Converts camelCase into kebab-case

Expand All @@ -480,7 +480,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/4b56ec348001e80ae4b33479fa728805729511f6/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/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")

Converts camelCase into snake_case

Expand Down
2 changes: 1 addition & 1 deletion packages/kitsu-core/types/deserialise/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@
* attributes: { slug: 'wopian' }
* }
* ]
* }) // { data: { id: '1', user: { type: 'users', id: '2', slug: 'wopian' } } }
* }) // { data: { id: '1', user: { data: { type: 'users', id: '2', slug: 'wopian' } } } }
*/
export function deserialise(response: any): any;
20 changes: 10 additions & 10 deletions packages/kitsu/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,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-474](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu/src/index.js#L30-L474 "Source code on GitHub")
[packages/kitsu/src/index.js:30-474](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu/src/index.js#L30-L474 "Source code on GitHub")

Creates a new `kitsu` instance

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

#### plural

[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/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 @@ -273,7 +273,7 @@ api.plural.plural('paper') //=> 'paper'

#### headers

[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")

Get the current headers or add additional headers

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

#### interceptors

[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")

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

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

#### get

[packages/kitsu/src/index.js:198-218](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu/src/index.js#L198-L218 "Source code on GitHub")
[packages/kitsu/src/index.js:198-218](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu/src/index.js#L198-L218 "Source code on GitHub")

Fetch resources (alias `fetch`)

Expand Down Expand Up @@ -472,7 +472,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
#### patch
[packages/kitsu/src/index.js:251-272](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu/src/index.js#L251-L272 "Source code on GitHub")
[packages/kitsu/src/index.js:251-272](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu/src/index.js#L251-L272 "Source code on GitHub")
Update a resource (alias `update`)
Expand Down Expand Up @@ -530,7 +530,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
#### post
[packages/kitsu/src/index.js:300-319](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu/src/index.js#L300-L319 "Source code on GitHub")
[packages/kitsu/src/index.js:300-319](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu/src/index.js#L300-L319 "Source code on GitHub")
Create a new resource (alias `create`)
Expand Down Expand Up @@ -571,7 +571,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
#### delete
[packages/kitsu/src/index.js:334-363](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu/src/index.js#L334-L363 "Source code on GitHub")
[packages/kitsu/src/index.js:334-363](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu/src/index.js#L334-L363 "Source code on GitHub")
Remove a resource (alias `remove`)
Expand Down Expand Up @@ -599,7 +599,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
#### self
[packages/kitsu/src/index.js:385-392](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu/src/index.js#L385-L392 "Source code on GitHub")
[packages/kitsu/src/index.js:385-392](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu/src/index.js#L385-L392 "Source code on GitHub")
Get the authenticated user's data
Expand Down Expand Up @@ -635,7 +635,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
#### request
[packages/kitsu/src/index.js:453-473](https://github.com/wopian/kitsu/blob/4b56ec348001e80ae4b33479fa728805729511f6/packages/kitsu/src/index.js#L453-L473 "Source code on GitHub")
[packages/kitsu/src/index.js:453-473](https://github.com/wopian/kitsu/blob/d0a0faa5db058d5a61d4be1dc10fd64d0d9193db/packages/kitsu/src/index.js#L453-L473 "Source code on GitHub")
Send arbitrary requests
Expand Down

0 comments on commit 7c3f365

Please sign in to comment.