Try publishing the types

Author: bcomnes

README.md

@@ -44,15 +44,15 @@ Return an async generator that will iterate over all of files inside of a direct
 You can iterate over each file and directory individually using a `for-await...of` loop.  Note, you must be inside an [async function statement](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function).
 
 ```js
-const { asyncFolderWalker } = require('async-folder-walker');
+const { asyncFolderWalker } = require('async-folder-walker')
 async function iterateFiles () {
-  const walker = asyncFolderWalker(['.git', 'node_modules']);
+  const walker = asyncFolderWalker(['.git', 'node_modules'])
   for await (const file of walker) {
-    console.log(file); // logs the file path!
+    console.log(file) // logs the file path!
   }
 }
 
-iterateFiles();
+iterateFiles()
 ```
 
 Opts include:

declaration.tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig",
+  "exclude": [
+    "test.js"
+  ],
+  "compilerOptions": {
+    "declaration": true,
+    "noEmit": false,
+    "emitDeclarationOnly": true
+  }
+}

index.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Options object
+ */
+export type Opts = {
+    /**
+     * - A pathFilter cb.
+     */
+    pathFilter?: pathFilter | undefined;
+    /**
+     * - A statFilter cb.
+     */
+    statFilter?: statFilter | undefined;
+    /**
+     * - The maximum number of folders to walk down into.
+     */
+    maxDepth?: number | undefined;
+    /**
+     * - A shaper cb.
+     */
+    shaper?: shaper | undefined;
+};
+/**
+ * pathFilter lets you filter files based on a resolved `filepath`.
+ */
+export type pathFilter = (filepath: string) => boolean;
+/**
+ * statFilter lets you filter files based on a lstat object.
+ */
+export type statFilter = (st: Object) => boolean;
+/**
+ * FWStats is the object that the okdistribute/folder-walker module returns by default.
+ */
+export type FWStats = {
+    /**
+     * - The filepath of the directory where the walk started.
+     */
+    root: string;
+    /**
+     * - The resolved filepath.
+     */
+    filepath: string;
+    /**
+     * - A fs.Stats instance.
+     */
+    stat: Object;
+    /**
+     * - The relative path to `root`.
+     */
+    relname: string;
+    /**
+     * - The resolved filepath of the files containing directory.
+     */
+    basename: string;
+};
+/**
+ * shaper lets you change the shape of the returned file data from walk-time stats.
+ */
+export type shaper = (fwStats: FWStats) => any;
+/**
+ * Options object
+ *
+ * @typedef Opts
+ * @property {pathFilter} [pathFilter] - A pathFilter cb.
+ * @property {statFilter} [statFilter] - A statFilter cb.
+ * @property {Number} [maxDepth=Infinity] - The maximum number of folders to walk down into.
+ * @property {shaper} [shaper] - A shaper cb.
+ */
+/**
+ * Create an async generator that iterates over all folders and directories inside of `dirs`.
+ *
+ * @async
+ * @generator
+ * @function
+ * @public
+ * @param {String|String[]} dirs - The path of the directory to walk, or an array of directory paths.
+ * @param {?(Opts)} opts - Options used for the directory walk.
+ *
+ * @yields {Promise<String|any>} - An async iterator that returns anything.
+ */
+export function asyncFolderWalker(dirs: string | string[], opts: (Opts) | null): AsyncGenerator<any, void, unknown>;
+/**
+ * allFiles gives you all files from the directory walk as an array.
+ *
+ * @async
+ * @function
+ * @public
+ * @param {String|String[]} dirs - The path of the directory to walk, or an array of directory paths.
+ * @param {?(Opts)} opts - Options used for the directory walk.
+ *
+ * @returns {Promise<String[]|any>} - An async iterator that returns anything.
+ */
+export function allFiles(dirs: string | string[], opts: (Opts) | null): Promise<string[] | any>;
+/**
+ * Async iterable collector
+ *
+ * @async
+ * @function
+ * @private
+ * @param {AsyncIterator} iterator - The iterator to collect into an array
+ */
+export function all(iterator: AsyncIterator<any, any, undefined>): Promise<any[]>;

index.js

@@ -1,3 +1,7 @@
+// @ts-check
+
+'use strict'
+
 const fs = require('fs')
 const path = require('path')
 const ignore = require('ignore')
@@ -74,6 +78,7 @@ async function * asyncFolderWalker (dirs, opts) {
     shaper
   }, opts)
 
+  // @ts-ignore
   const ig = ignore().add(opts.ignore)
 
   const roots = [dirs].flat().filter(opts.pathFilter)
@@ -155,10 +160,12 @@ function depthLimiter (filePath, relativeTo, maxDepth) {
  * @async
  * @function
  * @private
+ * @param {AsyncIterator} iterator - The iterator to collect into an array
  */
 async function all (iterator) {
   const collect = []
 
+  // @ts-ignore
   for await (const result of iterator) {
     collect.push(result)
   }
@@ -177,8 +184,8 @@ async function all (iterator) {
  *
  * @returns {Promise<String[]|any>} - An async iterator that returns anything.
  */
-async function allFiles (...args) {
-  return all(asyncFolderWalker(...args))
+async function allFiles (dirs, opts) {
+  return all(asyncFolderWalker(dirs, opts))
 }
 
 module.exports = {

package.json

@@ -11,13 +11,15 @@
     "ignore": "^5.1.8"
   },
   "devDependencies": {
+    "auto-changelog": "^2.2.0",
     "dependency-check": "^4.1.0",
+    "gh-release": "^6.0.0",
     "npm-run-all2": "^5.0.0",
     "p-temporary-directory": "^1.1.1",
-    "gh-release": "^6.0.0",
     "standard": "^16.0.3",
     "tap": "^16.0.0",
-    "auto-changelog": "^2.2.0"
+    "typescript": "^4.6.2",
+    "@voxpelli/tsconfig": "^2.0.0"
   },
   "homepage": "https://github.com/bcomnes/async-folder-walker",
   "keywords": [],
@@ -33,7 +35,8 @@
     "test:standard": "standard",
     "test:tap": "tap",
     "debug": "node --nolazy --inspect-brk=9229 -r esm test.js",
-    "version": "auto-changelog -p --template keepachangelog auto-changelog --breaking-pattern 'BREAKING CHANGE:' && git add CHANGELOG.md"
+    "build": "rm -f index.d.ts && tsc -p declaration.tsconfig.json",
+    "version": "git diff --exit-code -- index.d.ts && auto-changelog -p --template keepachangelog auto-changelog --breaking-pattern 'BREAKING CHANGE:' && git add CHANGELOG.md"
   },
   "standard": {
     "ignore": [

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@voxpelli/tsconfig/node16.json",
+  "files": [
+    "index.js"
+  ],
+  "include": [
+    "test.js"
+  ]
+}