update typescript def gen

Author: typhonrt

src/functions.js

@@ -3,14 +3,12 @@ import path          from 'path';
 
 import TraversalData from './TraversalData.js';
 
-import { type }      from './typedef.js';  // eslint-disable-line no-unused-vars
-
 /**
  * Get essential info for the given package object consistently formatted.
  *
  * @param {object} packageObj - A loaded `package.json` object.
  *
- * @returns {type.PackageObjFormatted|undefined} The formatted package object or undefined.
+ * @returns {PackageObjFormatted|undefined} The formatted package object or undefined.
  */
 export function formatPackage(packageObj)
 {
@@ -58,7 +56,7 @@ export function formatPackage(packageObj)
    /**
     * Creates the PackageObjFormatted result.
     *
-    * @type {type.PackageObjFormatted}
+    * @type {PackageObjFormatted}
     */
    const packageData = {
       name,
@@ -89,7 +87,7 @@ export function formatPackage(packageObj)
  * Note: If malformed data is presented the result will undefined. Also note that a file may be specified that
  * does not exist and the directory will be resolved. If that directory exists then resolution will continue.
  *
- * @param {type.PackageQueryOptions} options - The package query options.
+ * @param {PackageQueryOptions} options - The package query options.
  *
  * @returns {object|undefined} Loaded `package.json` or undefined if an error has occurred or basepath or root
  *                             directory has been reached.
@@ -105,9 +103,9 @@ export function getPackage(options)
 /**
  * Attempts to find the nearest package.json via `getPackage` then passes the results to `formatPackage`.
  *
- * @param {type.PackageQueryOptions} options - The package query options.
+ * @param {PackageQueryOptions} options - The package query options.
  *
- * @returns {type.PackageObjFormatted|undefined} Formatted package.json or undefined.
+ * @returns {PackageObjFormatted|undefined} Formatted package.json or undefined.
  */
 export function getPackageAndFormat(options)
 {
@@ -121,9 +119,9 @@ export function getPackageAndFormat(options)
  * object / `PackageObjData`. Also note that a file may be specified that does not exist and the directory will be
  * resolved. If that directory exists then resolution will continue.
  *
- * @param {type.PackageQueryOptions} options - The package query options.
+ * @param {PackageQueryOptions} options - The package query options.
  *
- * @returns {type.PackageObjData} Loaded package.json / path or potentially an error.
+ * @returns {PackageObjData} Loaded package.json / path or potentially an error.
  */
 export function getPackageWithPath(options)
 {
@@ -209,7 +207,7 @@ export function getPackageWithPath(options)
  * Traversal stops at the first valid `package.json` file as this is how Node works. If the first found `package.json`
  * does not have a `type` field then `commonjs` is returned.
  *
- * @param {type.PackageQueryOptions} options - The package query options.
+ * @param {PackageQueryOptions} options - The package query options.
  *
  * @returns {string} Type of package - 'module' for ESM otherwise 'commonjs'.
  */

src/typedef.js

@@ -1,7 +1,7 @@
 /**
  * The returned data object from a `getPackageWithPath` query.
  *
- * @typedef {object} type.PackageObjData
+ * @typedef {object} PackageObjData
  *
  * @property {object|undefined}  [packageObj] - Loaded `package.json` object.
  *
@@ -15,7 +15,7 @@
 /**
  * The returned data object from formatting a `package.json` object.
  *
- * @typedef {object} type.PackageObjFormatted
+ * @typedef {object} PackageObjFormatted
  *
  * @property {string}   name - Name property.
  *
@@ -41,25 +41,25 @@
 /**
  * Defines the data object passed to the functions to perform a `package.json` query.
  *
- * @typedef {object} type.PackageQueryOptions
+ * @typedef {object} PackageQueryOptions
  *
  * @property {string|URL}  filepath - Initial file or directory path to search for `package.json`.
  *
  * @property {string|URL}  [basepath] - Base path to stop traversing. Set to the root path of `filepath` if not
  *                                      provided.
  *
- * @property {type.TraversalCallback}  [callback] - A function that evaluates a loaded package.json object and
+ * @property {TraversalCallback}  [callback] - A function that evaluates a loaded package.json object and
  *                                                 associated traversal data returning a truthy value to stops or
  *                                                 continue the traversal.
  */
 
 /**
- * An optional callback function for {@link type.PackageQueryOptions} that evaluates a loaded package.json object and
+ * An optional callback function for {@link PackageQueryOptions} that evaluates a loaded package.json object and
  * associated traversal data returning a truthy value to stop or continue the traversal.
  *
- * @callback type.TraversalCallback
+ * @callback TraversalCallback
  *
- * @param {type.TraversalDataObj} data - The traversal data object.
+ * @param {TraversalDataObj} data - The traversal data object.
  *
  * @returns {boolean} True to stop traversal / false to continue.
  */
@@ -68,7 +68,7 @@
  * Defines the data object passed to any traversal callback function. All paths are converted to Unix style paths,
  * so for instance on Windows `\` and `\\` are replaced with `/`.
  *
- * @typedef {object} type.TraversalDataObj
+ * @typedef {object} TraversalDataObj
  *
  * @property {string}   baseDir - Stores the `basepath` directory as a Unix styled path.
  *
@@ -84,5 +84,3 @@
  *
  * @property {string}   rootPath - The root path to stop traversal as a Unix styled path.
  */
-
-export const type = {};