docs: update JSDoc Array syntax for better TypeScript usability

Author: wopian

packages/kitsu-core/src/deattribute/index.js

@@ -1,8 +1,8 @@
 /**
  * Hoists attributes to be top-level
  *
- * @param {Object|Array} data Resource data
- * @returns {Object|Array} Deattributed resource data
+ * @param {Object|Object[]} data Resource data
+ * @returns {Object|Object[]} Deattributed resource data
  *
  * @example <caption>Deattribute an array of resources</caption>
  * // JSON:API 'data' field

packages/kitsu-core/src/filterIncludes/index.js

@@ -7,7 +7,7 @@ import { error } from '../error'
  * @param {Object} relationship
  * @param {string} relationship.id The relationship ID
  * @param {string} relationship.type The relationship type
- * @returns {Array<Object>} The matched includes
+ * @returns {Object[]} The matched includes
  *
  * @example
  * const includes = [

packages/kitsu-core/src/serialise/index.js

@@ -106,7 +106,7 @@ function hasID (node) {
  * Handles the Bulk Extension support. See `serialise` for examples.
  *
  * @param {string} type Resource type
- * @param {Array<Object>} payload The data
+ * @param {Object[]} payload The data
  * @param {string} method Request type (PATCH, POST, DELETE)
  * @param {Object} options Optional configuration for camelCase and pluralisation handling
  * @param {Function} options.camelCaseTypes Convert library-entries and library_entries to libraryEntries (default no conversion). To use parameter, import camel from kitsu-core
@@ -164,7 +164,7 @@ function serialiseRootObject (type, payload, method, options) {
  * Serialises an object into a JSON-API structure
  *
  * @param {string} type Resource type
- * @param {Object|Array<Object>} data The data
+ * @param {Object|Object[]} data The data
  * @param {string} method Request type (PATCH, POST, DELETE)
  * @param {Object} options Optional configuration for camelCase and pluralisation handling
  * @param {Function} options.camelCaseTypes Convert library-entries and library_entries to libraryEntries (default no conversion). To use parameter, import camel from kitsu-core

packages/kitsu-core/src/splitModel/index.js

@@ -7,7 +7,7 @@
  * @param {Object} options
  * @param {Function} options.resourceCase Convert libraryEntries to library-entries or library_entries (default no conversion). To use parameter, import kebab or snake from kitsu-core
  * @param {Function} options.pluralModel Pluralise models (default no pluralisation). To use parameter, import pluralize (or another pluralisation npm package)
- * @returns {Array<string, string>} Array containing the model name and the resource URL with pluralisation applied
+ * @returns {[string, string]}} Array containing the model name and the resource URL with pluralisation applied
  *
  * @example
  * splitModel('posts/1/comments')

packages/kitsu-core/types/deattribute/index.d.ts

@@ -1,8 +1,8 @@
 /**
  * Hoists attributes to be top-level
  *
- * @param {Object|Array} data Resource data
- * @returns {Object|Array} Deattributed resource data
+ * @param {Object|Object[]} data Resource data
+ * @returns {Object|Object[]} Deattributed resource data
  *
  * @example <caption>Deattribute an array of resources</caption>
  * // JSON:API 'data' field
@@ -26,4 +26,4 @@
  *
  * const output = deattribute(data) // { id: '1', type: 'users', slug: 'wopian' }
  */
-export function deattribute(data: any | Array): any | Array;
+export function deattribute(data: any | any[]): any | any[];

packages/kitsu-core/types/filterIncludes/index.d.ts

@@ -5,7 +5,7 @@
  * @param {Object} relationship
  * @param {string} relationship.id The relationship ID
  * @param {string} relationship.type The relationship type
- * @returns {Array<Object>} The matched includes
+ * @returns {Object[]} The matched includes
  *
  * @example
  * const includes = [
@@ -31,4 +31,4 @@
 export function filterIncludes(included: any, { id, type }: {
     id: string;
     type: string;
-}): Array<any>;
+}): any[];

packages/kitsu-core/types/serialise/index.d.ts

@@ -2,7 +2,7 @@
  * Serialises an object into a JSON-API structure
  *
  * @param {string} type Resource type
- * @param {Object|Array<Object>} data The data
+ * @param {Object|Object[]} data The data
  * @param {string} method Request type (PATCH, POST, DELETE)
  * @param {Object} options Optional configuration for camelCase and pluralisation handling
  * @param {Function} options.camelCaseTypes Convert library-entries and library_entries to libraryEntries (default no conversion). To use parameter, import camel from kitsu-core
@@ -28,7 +28,7 @@
  * // { data: { id: '1', type: 'anime', attributes: { slug: 'shirobako' } } }
  * const output = serialise(model, obj, 'PATCH')
  */
-export function serialise(type: string, data?: any | Array<any>, method?: string, options?: {
+export function serialise(type: string, data?: any | any[], method?: string, options?: {
     camelCaseTypes: Function;
     pluralTypes: Function;
 }): any;

packages/kitsu-core/types/splitModel/index.d.ts

@@ -6,7 +6,7 @@
  * @param {Object} options
  * @param {Function} options.resourceCase Convert libraryEntries to library-entries or library_entries (default no conversion). To use parameter, import kebab or snake from kitsu-core
  * @param {Function} options.pluralModel Pluralise models (default no pluralisation). To use parameter, import pluralize (or another pluralisation npm package)
- * @returns {Array<string, string>} Array containing the model name and the resource URL with pluralisation applied
+ * @returns {[string, string]}} Array containing the model name and the resource URL with pluralisation applied
  *
  * @example
  * splitModel('posts/1/comments')
@@ -28,4 +28,4 @@
 export function splitModel(url: string, options?: {
     resourceCase: Function;
     pluralModel: Function;
-}): Array<string, string>;
+}): [string, string];

packages/kitsu/src/index.js

@@ -295,7 +295,7 @@ export default class Kitsu {
    *
    * @memberof Kitsu
    * @param {string} model Model to remove data from
-   * @param {string|number|Array} id Resource ID to remove. Pass an array of IDs to delete multiple resources (Bulk Extension)
+   * @param {string|number|number[]} id Resource ID to remove. Pass an array of IDs to delete multiple resources (Bulk Extension)
    * @param {Object} headers Additional headers to send with the request
    * @returns {Object} JSON-parsed response
    * @example <caption>Remove a single resource</caption>
@@ -370,7 +370,7 @@ export default class Kitsu {
    *
    * @memberof Kitsu
    * @param {Object} config Request configuration
-   * @param {Object|Array} config.body Data to send in the request
+   * @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
    * @param {Object} config.params.page [JSON:API Pagination](http://jsonapi.org/format/#fetching-pagination)

packages/kitsu/types/index.d.ts

@@ -25,8 +25,8 @@
  */
 export default class Kitsu {
     constructor(options?: {});
-    camel: any;
-    resCase: any;
+    camel: (s: any) => any;
+    resCase: (s: any) => any;
     plural: any;
     /**
      * Get the current headers or add additional headers
@@ -54,7 +54,7 @@ export default class Kitsu {
     }, headers?: any) => any;
     update: (model: string, body: any, headers?: any) => any;
     create: (model: string, body: any, headers?: any) => any;
-    remove: (model: string, id: string | number | Array, headers?: any) => any;
+    remove: (model: string, id: string | number | number[], headers?: any) => any;
     /**
      * Axios Interceptors (alias of `axios.interceptors`)
      *
@@ -221,15 +221,15 @@ export default class Kitsu {
      *
      * @memberof Kitsu
      * @param {string} model Model to remove data from
-     * @param {string|number|Array} id Resource ID to remove. Pass an array of IDs to delete multiple resources (Bulk Extension)
+     * @param {string|number|number[]} id Resource ID to remove. Pass an array of IDs to delete multiple resources (Bulk Extension)
      * @param {Object} headers Additional headers to send with the request
      * @returns {Object} JSON-parsed response
      * @example <caption>Remove a single resource</caption>
      * api.delete('posts', 123)
      * @example <caption>Remove multiple resources (API must support the Bulk Extension)</caption>
      * api.delete('posts', [ 1, 2 ])
      */
-    delete(model: string, id: string | number | Array, headers?: any): any;
+    delete(model: string, id: string | number | number[], headers?: any): any;
     /**
      * Get the authenticated user's data
      *
@@ -261,7 +261,7 @@ export default class Kitsu {
      *
      * @memberof Kitsu
      * @param {Object} config Request configuration
-     * @param {Object|Array} config.body Data to send in the request
+     * @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
      * @param {Object} config.params.page [JSON:API Pagination](http://jsonapi.org/format/#fetching-pagination)
@@ -314,7 +314,7 @@ export default class Kitsu {
      * })
      */
     request({ body, method, params, type, url }: {
-        body: any | Array;
+        body: any | any[];
         method: string;
         params: {
             page: {