fix(kitsu): correct jsdoc type definitions of return types

Author: wopian

packages/kitsu/src/index.js

@@ -6,7 +6,7 @@ import pluralise from 'pluralize'
  * Creates a new `kitsu` instance
  *
  * @param {Object} [options] Options
- * @param {string} [options.baseURL=https://kitsu.app/api/edge] Set the API endpoint
+ * @param {string} [options.baseURL='https://kitsu.app/api/edge'] Set the API endpoint
  * @param {Object} [options.headers] Additional headers to send with the requests
  * @param {'traditional'|'modern'|Function} [options.query=traditional] Query serializer function to use. This will impact the way keys are serialized when passing arrays as query parameters. 'modern' is recommended for new projects.
  * @param {boolean} [options.camelCaseTypes=true] If enabled, `type` will be converted to camelCase from kebab-casae or snake_case
@@ -33,7 +33,7 @@ export default class Kitsu {
     const traditional = typeof options.query === 'string' ? options.query === 'traditional' : true
     this.query = typeof options.query === 'function'
       ? options.query
-      : obj => query(obj, null, traditional)
+      : obj => query(obj, undefined, traditional)
 
     if (options.camelCaseTypes === false) this.camel = s => s
     else this.camel = camel
@@ -140,7 +140,7 @@ export default class Kitsu {
    * @param {string} [config.params.page.before] Get the previous page of resources (Cursor-based) - **Note:** Not Supported on kitsu.app
    * @param {string} [config.params.page.after] Get the next page of resources (Cursor-based) - **Note:** Not Supported on kitsu.app
    * @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} JSON-parsed response
+   * @returns {Promise<Object>} JSON-parsed response
    * @example <caption>Getting a resource with JSON:API parameters</caption>
    * api.get('users', {
    *   params: {
@@ -183,7 +183,7 @@ export default class Kitsu {
    *       }
    *     }
    *   }
-   * }
+   * })
    * @example <caption>Handling errors (async/await)</caption>
    * try {
    *   const { data } = await api.get('anime')
@@ -262,7 +262,7 @@ export default class Kitsu {
    * @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
+   * @returns {Promise<Object|Object[]>} JSON-parsed response
    * @example <caption>Update a resource</caption>
    * api.update('posts', {
    *   id: '1',
@@ -332,7 +332,7 @@ export default class Kitsu {
    * @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
+   * @returns {Promise<Object|Object[]>} JSON-parsed response
    * @example <caption>Create a post on a user's profile feed</caption>
    * api.create('posts', {
    *   content: 'Hello World',
@@ -399,7 +399,7 @@ export default class Kitsu {
    * @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
+   * @returns {Promise<Object|Object[]>} JSON-parsed response
    * @example <caption>Remove one or more relationships from a resource</caption>
    * api.delete('posts/1/relationships/uploads', [456, 789])
    * @example <caption>Remove a single resource</caption>
@@ -459,7 +459,7 @@ export default class Kitsu {
    * @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} JSON-parsed response
+   * @returns {Promise<Object>} JSON-parsed response
    * @example <caption>Get the authenticated user's resource</caption>
    * api.self()
    * @example <caption>Using JSON:API parameters</caption>
@@ -488,15 +488,15 @@ export default class Kitsu {
    * **Note** Planned changes to the `get`, `patch`, `post` and `delete` methods in a future major release may make this method redundent. See https://github.com/wopian/kitsu/issues/415 for details.
    *
    * @memberof Kitsu
-   * @param {Object} [config] Request configuration
+   * @param {Object} config Request configuration
    * @param {string} config.url The URL path of the resource
    * @param {string} config.type The resource type
    * @param {Object|Object[]} [config.body] Data to send in the request
    * @param {string} [config.method] Request method - `GET`, `PATCH`, `POST` or `DELETE` (defaults to `GET`, case-insensitive)
    * @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} JSON-parsed response
+   * @returns {Promise<Object>} JSON-parsed response
    * @example <caption>Raw GET request</caption>
    * api.request({
    *   url: 'anime/1/mappings',