refactor: nits

Author: araujogui

src/generators/metadata/index.mjs

@@ -5,9 +5,9 @@ import { parseApiDoc } from './utils/parse.mjs';
 /**
  * This generator generates a flattened list of metadata entries from a API doc
  *
- * @typedef {ParserOutput<import('mdast').Root>[]} Input
+ * @typedef {Array<ParserOutput<import('mdast').Root>>} Input
  *
- * @type {GeneratorMetadata<Input, ApiDocMetadataEntry[]>}
+ * @type {GeneratorMetadata<Input, Array<ApiDocMetadataEntry>>}
  */
 export default {
   name: 'metadata',
@@ -20,7 +20,7 @@ export default {
 
   /**
    * @param {Input} inputs
-   * @returns {Promise<ApiDocMetadataEntry[]>}
+   * @returns {Promise<Array<ApiDocMetadataEntry>>}
    */
   async generate(inputs) {
     return inputs.flatMap(input => parseApiDoc(input));

src/generators/metadata/utils/parse.mjs

@@ -15,7 +15,7 @@ import createMetadata from '../../../metadata.mjs';
  * This generator generates a flattened list of metadata entries from a API doc
  *
  * @param {ParserOutput<import('mdast').Root>} input
- * @returns {Promise<ApiDocMetadataEntry[]>}
+ * @returns {Promise<Array<ApiDocMetadataEntry>>}
  */
 export const parseApiDoc = ({ file, tree }) => {
   /**

src/loaders/markdown.mjs

@@ -15,8 +15,8 @@ const createLoader = () => {
   /**
    * Loads API Doc files and transforms it into VFiles
    *
-   * @param {string[]} searchPath A glob/path for API docs to be loaded
-   * @param {string[] | undefined} ignorePath A glob/path of files to ignore
+   * @param {Array<string>} searchPath A glob/path for API docs to be loaded
+   * @param {Array<string> | undefined} [ignorePath] A glob/path of files to ignore
    * The input string can be a simple path (relative or absolute)
    * The input string can also be any allowed glob string
    *

src/parsers/markdown.mjs

@@ -47,7 +47,7 @@ const createParser = linter => {
    * and it simply wraps parseApiDoc with the given API docs
    *
    * @param {Array<import('vfile').VFile | Promise<import('vfile').VFile>>} apiDocs List of API doc files to be parsed
-   * @returns {Promise<ParserOutput<import('mdast').Root>[]>}
+   * @returns {Promise<Array<ParserOutput<import('mdast').Root>>>}
    */
   const parseApiDocs = async apiDocs => {
     // We do a Promise.all, to ensure that each API doc is resolved asynchronously