Skip to content

Commit b678290

Browse files
committed
docs(kitsu): link to axios docs for axiosOptions and interceptors
1 parent ae3c359 commit b678290

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

packages/kitsu/src/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ import { camel, deserialise, error, kebab, query, serialise, snake, splitModel }
1010
* @param {Object} options.headers Additional headers to send with requests
1111
* @param {boolean} options.camelCaseTypes If true, the `type` value will be camelCased, e.g `library-entries` and `library_entries` become `libraryEntries` (default `true`)
1212
* @param {string} options.resourceCase `kebab`, `snake` or `none`. If `kebab`, `/libraryEntries` will become `/library-entries`. If `snake`, `/libraryEntries` will become `/library_entries`, If `none`, `/libraryEntries` will be unchanged (default `kebab`)
13-
* @param {boolean} options.pluralize If `true`, `/user` will become `/users` in the URL request and `type` will be pluralized in post, patch and delete requests - `user` -> `users` (default `true`)
13+
* @param {boolean} options.pluralize If `true`, `/user` will become `/users` in the URL request and `type` will be pluralized in POST, PATCH and DELETE requests (default `true`)
1414
* @param {number} options.timeout Set the request timeout in milliseconds (default `30000`)
15-
* @param {Object} options.axiosOptions Additional options for the axios instance
15+
* @param {Object} options.axiosOptions Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
1616
* @example <caption>Using with Kitsu.io's API</caption>
1717
* const api = new Kitsu()
1818
* @example <caption>Using another API server</caption>
@@ -81,7 +81,7 @@ export default class Kitsu {
8181
/**
8282
* Axios Interceptors (alias of `axios.interceptors`)
8383
*
84-
* You can intercept responses before they are handled by `get`, `post`, `patch` and `delete` and before requests are sent to the API server.
84+
* You can intercept responses before they are handled by `get`, `post`, `patch` and `delete` and before requests are sent to the API server. See [axios/axios#interceptors](https://github.com/axios/axios#interceptors) for details.
8585
*
8686
* @memberof Kitsu
8787
* @example <caption>Request Interceptor</caption>

0 commit comments

Comments
 (0)