@iconify/tools 2.2.6 → 3.0.0-beta.2

package/lib/import/directory.cjs

@@ -35,45 +35,118 @@ require('../optimise/svgo.cjs');
 require('svgo');
 require('@iconify/utils/lib/svg/id');
 
-async function importDirectory(path, options = {}) {
-  const files = await misc_scan.scanDirectory(path, (ext, file, subdir, path2) => {
-    if (ext.toLowerCase() === ".svg") {
+function importDir(iconSet, options, getKeyword, files, readFile, done) {
+  let i = 0;
+  const next = () => {
+    if (i >= files.length) {
+      return done(iconSet);
+    }
+    const file = files[i];
+    i++;
+    const defaultKeyword = misc_keyword.cleanupIconKeyword(file.file);
+    getKeyword([file, defaultKeyword, iconSet], (keyword) => {
+      if (typeof keyword !== "string" || !keyword.length) {
+        return next();
+      }
+      readFile(
+        file.path + file.subdir + file.file + file.ext,
+        (content) => {
+          try {
+            const svg = new svg_index.SVG(content);
+            svg_cleanup.cleanupSVG(svg);
+            iconSet.fromSVG(keyword, svg);
+          } catch (err) {
+            if (options.ignoreImportErrors !== false) {
+              throw err;
+            }
+          }
+          next();
+        }
+      );
+    });
+  };
+  next();
+}
+function isValidFile(item) {
+  return item.ext.toLowerCase() === ".svg";
+}
+function importDirectory(path, options = {}) {
+  return new Promise((fulfill, reject) => {
+    misc_scan.scanDirectory(path, (ext, file, subdir, path2) => {
       const result = {
         file,
         ext,
         subdir,
         path: path2
       };
-      return result;
-    }
-    return false;
+      return isValidFile(result) ? result : false;
+    }).then((files) => {
+      const iconSet = iconSet_index.blankIconSet(options.prefix || "");
+      try {
+        importDir(
+          iconSet,
+          options,
+          (params, done) => {
+            if (options.keyword) {
+              const result = options.keyword(...params);
+              if (result instanceof Promise) {
+                result.then(done).catch(reject);
+              } else {
+                done(result);
+              }
+            } else {
+              done(params[1]);
+            }
+          },
+          files,
+          (filename, done) => {
+            fs.promises.readFile(filename, "utf8").then(done).catch(reject);
+          },
+          fulfill
+        );
+      } catch (err) {
+        reject(err);
+      }
+    }).catch(reject);
+  });
+}
+function importDirectorySync(path, options = {}) {
+  const files = misc_scan.scanDirectorySync(path, (ext, file, subdir, path2) => {
+    const result = {
+      file,
+      ext,
+      subdir,
+      path: path2
+    };
+    return isValidFile(result) ? result : false;
   });
   const iconSet = iconSet_index.blankIconSet(options.prefix || "");
-  for (let i = 0; i < files.length; i++) {
-    const file = files[i];
-    const defaultKeyword = misc_keyword.cleanupIconKeyword(file.file);
-    let keyword = options.keyword ? options.keyword(file, defaultKeyword, iconSet) : defaultKeyword;
-    if (keyword instanceof Promise) {
-      keyword = await keyword;
-    }
-    if (typeof keyword !== "string" || !keyword.length) {
-      continue;
-    }
-    try {
-      const content = await fs.promises.readFile(
-        file.path + file.subdir + file.file + file.ext,
-        "utf8"
-      );
-      const svg = new svg_index.SVG(content);
-      await svg_cleanup.cleanupSVG(svg);
-      iconSet.fromSVG(keyword, svg);
-    } catch (err) {
-      if (options.ignoreImportErrors !== false) {
-        throw err;
+  let isSync = true;
+  importDir(
+    iconSet,
+    options,
+    (params, done) => {
+      if (options.keyword) {
+        done(options.keyword(...params));
+      } else {
+        done(params[1]);
+      }
+    },
+    files,
+    (filename, done) => {
+      done(fs.readFileSync(filename, "utf8"));
+    },
+    () => {
+      if (!isSync) {
+        throw new Error(
+          "importDirectorySync supposed to be synchronous"
+        );
       }
     }
-  }
+  );
+  isSync = false;
   return iconSet;
 }
 
 exports.importDirectory = importDirectory;
+exports.importDirectorySync = importDirectorySync;

package/lib/import/directory.d.ts

@@ -24,19 +24,26 @@ interface ImportDirectoryFileEntry {
  * Callback can be asynchronous
  */
 type ImportDirectoryKeywordCallbackResult = string | undefined;
-type ImportDirectoryKeywordCallback = (file: ImportDirectoryFileEntry, defaultKeyword: string, iconSet: IconSet) => ImportDirectoryKeywordCallbackResult | Promise<ImportDirectoryKeywordCallbackResult>;
+type Callback<T> = (file: ImportDirectoryFileEntry, defaultKeyword: string, iconSet: IconSet) => T;
+type AsyncCallback<T> = Callback<T | Promise<T>>;
+type ImportDirectoryKeywordCallback = AsyncCallback<ImportDirectoryKeywordCallbackResult>;
+type ImportDirectoryKeywordSyncCallback = Callback<ImportDirectoryKeywordCallbackResult>;
 /**
  * Options
  */
-interface ImportDirectoryOptions {
+interface ImportDirectoryOptions<K> {
     prefix?: string;
     includeSubDirs?: boolean;
-    keyword?: ImportDirectoryKeywordCallback;
+    keyword?: K;
     ignoreImportErrors?: boolean;
 }
 /**
  * Import all icons from directory
  */
-declare function importDirectory(path: string, options?: ImportDirectoryOptions): Promise<IconSet>;
+declare function importDirectory(path: string, options?: ImportDirectoryOptions<ImportDirectoryKeywordCallback>): Promise<IconSet>;
+/**
+ * Import all icons from directory synchronously
+ */
+declare function importDirectorySync(path: string, options?: ImportDirectoryOptions<ImportDirectoryKeywordSyncCallback>): IconSet;
 
-export { ImportDirectoryFileEntry, ImportDirectoryKeywordCallback, importDirectory };
+export { ImportDirectoryFileEntry, ImportDirectoryKeywordCallback, ImportDirectoryKeywordSyncCallback, importDirectory, importDirectorySync };

package/lib/import/directory.mjs

@@ -1,7 +1,7 @@
-import { promises } from 'fs';
+import { promises, readFileSync } from 'fs';
 import { blankIconSet } from '../icon-set/index.mjs';
 import { cleanupIconKeyword } from '../misc/keyword.mjs';
-import { scanDirectory } from '../misc/scan.mjs';
+import { scanDirectory, scanDirectorySync } from '../misc/scan.mjs';
 import { SVG } from '../svg/index.mjs';
 import { cleanupSVG } from '../svg/cleanup.mjs';
 import '@iconify/utils/lib/icon/defaults';
@@ -33,45 +33,117 @@ import '../optimise/svgo.mjs';
 import 'svgo';
 import '@iconify/utils/lib/svg/id';
 
-async function importDirectory(path, options = {}) {
-  const files = await scanDirectory(path, (ext, file, subdir, path2) => {
-    if (ext.toLowerCase() === ".svg") {
+function importDir(iconSet, options, getKeyword, files, readFile, done) {
+  let i = 0;
+  const next = () => {
+    if (i >= files.length) {
+      return done(iconSet);
+    }
+    const file = files[i];
+    i++;
+    const defaultKeyword = cleanupIconKeyword(file.file);
+    getKeyword([file, defaultKeyword, iconSet], (keyword) => {
+      if (typeof keyword !== "string" || !keyword.length) {
+        return next();
+      }
+      readFile(
+        file.path + file.subdir + file.file + file.ext,
+        (content) => {
+          try {
+            const svg = new SVG(content);
+            cleanupSVG(svg);
+            iconSet.fromSVG(keyword, svg);
+          } catch (err) {
+            if (options.ignoreImportErrors !== false) {
+              throw err;
+            }
+          }
+          next();
+        }
+      );
+    });
+  };
+  next();
+}
+function isValidFile(item) {
+  return item.ext.toLowerCase() === ".svg";
+}
+function importDirectory(path, options = {}) {
+  return new Promise((fulfill, reject) => {
+    scanDirectory(path, (ext, file, subdir, path2) => {
       const result = {
         file,
         ext,
         subdir,
         path: path2
       };
-      return result;
-    }
-    return false;
+      return isValidFile(result) ? result : false;
+    }).then((files) => {
+      const iconSet = blankIconSet(options.prefix || "");
+      try {
+        importDir(
+          iconSet,
+          options,
+          (params, done) => {
+            if (options.keyword) {
+              const result = options.keyword(...params);
+              if (result instanceof Promise) {
+                result.then(done).catch(reject);
+              } else {
+                done(result);
+              }
+            } else {
+              done(params[1]);
+            }
+          },
+          files,
+          (filename, done) => {
+            promises.readFile(filename, "utf8").then(done).catch(reject);
+          },
+          fulfill
+        );
+      } catch (err) {
+        reject(err);
+      }
+    }).catch(reject);
+  });
+}
+function importDirectorySync(path, options = {}) {
+  const files = scanDirectorySync(path, (ext, file, subdir, path2) => {
+    const result = {
+      file,
+      ext,
+      subdir,
+      path: path2
+    };
+    return isValidFile(result) ? result : false;
   });
   const iconSet = blankIconSet(options.prefix || "");
-  for (let i = 0; i < files.length; i++) {
-    const file = files[i];
-    const defaultKeyword = cleanupIconKeyword(file.file);
-    let keyword = options.keyword ? options.keyword(file, defaultKeyword, iconSet) : defaultKeyword;
-    if (keyword instanceof Promise) {
-      keyword = await keyword;
-    }
-    if (typeof keyword !== "string" || !keyword.length) {
-      continue;
-    }
-    try {
-      const content = await promises.readFile(
-        file.path + file.subdir + file.file + file.ext,
-        "utf8"
-      );
-      const svg = new SVG(content);
-      await cleanupSVG(svg);
-      iconSet.fromSVG(keyword, svg);
-    } catch (err) {
-      if (options.ignoreImportErrors !== false) {
-        throw err;
+  let isSync = true;
+  importDir(
+    iconSet,
+    options,
+    (params, done) => {
+      if (options.keyword) {
+        done(options.keyword(...params));
+      } else {
+        done(params[1]);
+      }
+    },
+    files,
+    (filename, done) => {
+      done(readFileSync(filename, "utf8"));
+    },
+    () => {
+      if (!isSync) {
+        throw new Error(
+          "importDirectorySync supposed to be synchronous"
+        );
       }
     }
-  }
+  );
+  isSync = false;
   return iconSet;
 }
 
-export { importDirectory };
+export { importDirectory, importDirectorySync };

package/lib/import/figma/index.cjs

@@ -34,7 +34,6 @@ require('../../optimise/svgo.cjs');
 require('svgo');
 require('@iconify/utils/lib/svg/id');
 require('../../download/api/index.cjs');
-require('node-fetch');
 require('../../download/api/cache.cjs');
 require('fs');
 require('crypto');
@@ -81,7 +80,7 @@ async function importFromFigma(options) {
     }
     try {
       const svg = new svg_index.SVG(item.content);
-      await svg_cleanup.cleanupSVG(svg);
+      svg_cleanup.cleanupSVG(svg);
       iconSet.fromSVG(item.keyword, svg);
     } catch (err) {
       missing.push(item);

package/lib/import/figma/index.mjs

@@ -32,7 +32,6 @@ import '../../optimise/svgo.mjs';
 import 'svgo';
 import '@iconify/utils/lib/svg/id';
 import '../../download/api/index.mjs';
-import 'node-fetch';
 import '../../download/api/cache.mjs';
 import 'fs';
 import 'crypto';
@@ -79,7 +78,7 @@ async function importFromFigma(options) {
     }
     try {
       const svg = new SVG(item.content);
-      await cleanupSVG(svg);
+      cleanupSVG(svg);
       iconSet.fromSVG(item.keyword, svg);
     } catch (err) {
       missing.push(item);

package/lib/import/figma/query.cjs

@@ -2,7 +2,6 @@
 
 const download_api_index = require('../../download/api/index.cjs');
 const download_api_cache = require('../../download/api/cache.cjs');
-require('node-fetch');
 require('fs');
 require('crypto');
 require('../../misc/scan.cjs');

package/lib/import/figma/query.mjs

@@ -1,6 +1,5 @@
 import { sendAPIQuery } from '../../download/api/index.mjs';
 import { apiCacheKey, getAPICache, clearAPICache } from '../../download/api/cache.mjs';
-import 'node-fetch';
 import 'fs';
 import 'crypto';
 import '../../misc/scan.mjs';

package/lib/index.cjs

@@ -78,11 +78,11 @@ require('./import/figma/query.cjs');
 require('./download/api/cache.cjs');
 require('fs');
 require('crypto');
-require('node-fetch');
 require('pathe');
 require('child_process');
 require('util');
 require('stream');
+require('fs/promises');
 require('extract-zip');
 require('tar');
 require('./download/gitlab/types.cjs');
@@ -92,7 +92,9 @@ require('./export/helpers/custom-files.cjs');
 
 exports.SVG = svg_index.SVG;
 exports.parseSVG = svg_parse.parseSVG;
+exports.parseSVGSync = svg_parse.parseSVGSync;
 exports.parseSVGStyle = svg_parseStyle.parseSVGStyle;
+exports.parseSVGStyleSync = svg_parseStyle.parseSVGStyleSync;
 exports.analyseSVGStructure = svg_analyse.analyseSVGStructure;
 exports.cleanupSVG = svg_cleanup.cleanupSVG;
 exports.removeBadAttributes = svg_cleanup_attribs.removeBadAttributes;
@@ -107,6 +109,7 @@ exports.mergeIconSets = iconSet_merge.mergeIconSets;
 exports.addTagsToIconSet = iconSet_tags.addTagsToIconSet;
 exports.importFromFigma = import_figma_index.importFromFigma;
 exports.importDirectory = import_directory.importDirectory;
+exports.importDirectorySync = import_directory.importDirectorySync;
 exports.downloadGitRepo = download_git_index.downloadGitRepo;
 exports.getGitRepoHash = download_git_hash.getGitRepoHash;
 exports.getGitRepoBranch = download_git_branch.getGitRepoBranch;
@@ -122,7 +125,9 @@ exports.downloadPackage = download_index.downloadPackage;
 exports.downloadFile = download_api_download.downloadFile;
 exports.isEmptyColor = colors_parse.isEmptyColor;
 exports.parseColors = colors_parse.parseColors;
+exports.parseColorsSync = colors_parse.parseColorsSync;
 exports.validateColors = colors_validate.validateColors;
+exports.validateColorsSync = colors_validate.validateColorsSync;
 exports.detectIconSetPalette = colors_detect.detectIconSetPalette;
 exports.runSVGO = optimise_svgo.runSVGO;
 exports.deOptimisePaths = optimise_flags.deOptimisePaths;
@@ -135,6 +140,7 @@ exports.exportJSONPackage = export_jsonPackage.exportJSONPackage;
 exports.writeJSONFile = misc_writeJson.writeJSONFile;
 exports.prepareDirectoryForExport = export_helpers_prepare.prepareDirectoryForExport;
 exports.scanDirectory = misc_scan.scanDirectory;
+exports.scanDirectorySync = misc_scan.scanDirectorySync;
 exports.compareDirectories = misc_compareDirs.compareDirectories;
 exports.unzip = download_helpers_unzip.unzip;
 exports.untar = download_helpers_untar.untar;

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 export { SVG } from './svg/index.js';
-export { parseSVG } from './svg/parse.js';
-export { parseSVGStyle } from './svg/parse-style.js';
+export { parseSVG, parseSVGSync } from './svg/parse.js';
+export { parseSVGStyle, parseSVGStyleSync } from './svg/parse-style.js';
 export { analyseSVGStructure } from './svg/analyse.js';
 export { cleanupSVG } from './svg/cleanup.js';
 export { removeBadAttributes } from './svg/cleanup/attribs.js';
@@ -13,7 +13,7 @@ export { IconSet, blankIconSet } from './icon-set/index.js';
 export { mergeIconSets } from './icon-set/merge.js';
 export { addTagsToIconSet } from './icon-set/tags.js';
 export { importFromFigma } from './import/figma/index.js';
-export { importDirectory } from './import/directory.js';
+export { importDirectory, importDirectorySync } from './import/directory.js';
 export { downloadGitRepo } from './download/git/index.js';
 export { getGitRepoHash } from './download/git/hash.js';
 export { getGitRepoBranch } from './download/git/branch.js';
@@ -26,8 +26,8 @@ export { downloadNPMPackage } from './download/npm/index.js';
 export { getNPMVersion, getPackageVersion } from './download/npm/version.js';
 export { downloadPackage } from './download/index.js';
 export { downloadFile } from './download/api/download.js';
-export { isEmptyColor, parseColors } from './colors/parse.js';
-export { validateColors } from './colors/validate.js';
+export { isEmptyColor, parseColors, parseColorsSync } from './colors/parse.js';
+export { validateColors, validateColorsSync } from './colors/validate.js';
 export { detectIconSetPalette } from './colors/detect.js';
 export { runSVGO } from './optimise/svgo.js';
 export { deOptimisePaths } from './optimise/flags.js';
@@ -39,7 +39,7 @@ export { exportIconPackage } from './export/icon-package.js';
 export { exportJSONPackage } from './export/json-package.js';
 export { writeJSONFile } from './misc/write-json.js';
 export { prepareDirectoryForExport } from './export/helpers/prepare.js';
-export { scanDirectory } from './misc/scan.js';
+export { scanDirectory, scanDirectorySync } from './misc/scan.js';
 export { compareDirectories } from './misc/compare-dirs.js';
 export { unzip } from './download/helpers/unzip.js';
 export { untar } from './download/helpers/untar.js';

package/lib/index.mjs

@@ -1,6 +1,6 @@
 export { SVG } from './svg/index.mjs';
-export { parseSVG } from './svg/parse.mjs';
-export { parseSVGStyle } from './svg/parse-style.mjs';
+export { parseSVG, parseSVGSync } from './svg/parse.mjs';
+export { parseSVGStyle, parseSVGStyleSync } from './svg/parse-style.mjs';
 export { analyseSVGStructure } from './svg/analyse.mjs';
 export { cleanupSVG } from './svg/cleanup.mjs';
 export { removeBadAttributes } from './svg/cleanup/attribs.mjs';
@@ -13,7 +13,7 @@ export { IconSet, blankIconSet } from './icon-set/index.mjs';
 export { mergeIconSets } from './icon-set/merge.mjs';
 export { addTagsToIconSet } from './icon-set/tags.mjs';
 export { importFromFigma } from './import/figma/index.mjs';
-export { importDirectory } from './import/directory.mjs';
+export { importDirectory, importDirectorySync } from './import/directory.mjs';
 export { downloadGitRepo } from './download/git/index.mjs';
 export { getGitRepoHash } from './download/git/hash.mjs';
 export { getGitRepoBranch } from './download/git/branch.mjs';
@@ -26,8 +26,8 @@ export { downloadNPMPackage } from './download/npm/index.mjs';
 export { getNPMVersion, getPackageVersion } from './download/npm/version.mjs';
 export { downloadPackage } from './download/index.mjs';
 export { downloadFile } from './download/api/download.mjs';
-export { isEmptyColor, parseColors } from './colors/parse.mjs';
-export { validateColors } from './colors/validate.mjs';
+export { isEmptyColor, parseColors, parseColorsSync } from './colors/parse.mjs';
+export { validateColors, validateColorsSync } from './colors/validate.mjs';
 export { detectIconSetPalette } from './colors/detect.mjs';
 export { runSVGO } from './optimise/svgo.mjs';
 export { deOptimisePaths } from './optimise/flags.mjs';
@@ -39,7 +39,7 @@ export { exportIconPackage } from './export/icon-package.mjs';
 export { exportJSONPackage } from './export/json-package.mjs';
 export { writeJSONFile } from './misc/write-json.mjs';
 export { prepareDirectoryForExport } from './export/helpers/prepare.mjs';
-export { scanDirectory } from './misc/scan.mjs';
+export { scanDirectory, scanDirectorySync } from './misc/scan.mjs';
 export { compareDirectories } from './misc/compare-dirs.mjs';
 export { unzip } from './download/helpers/unzip.mjs';
 export { untar } from './download/helpers/untar.mjs';
@@ -76,11 +76,11 @@ import './import/figma/query.mjs';
 import './download/api/cache.mjs';
 import 'fs';
 import 'crypto';
-import 'node-fetch';
 import 'pathe';
 import 'child_process';
 import 'util';
 import 'stream';
+import 'fs/promises';
 import 'extract-zip';
 import 'tar';
 import './download/gitlab/types.mjs';

package/lib/misc/scan.cjs

@@ -2,16 +2,32 @@
 
 const fs = require('fs');
 
-async function scanDirectory(path, callback, subdirs = true) {
-  const results = [];
+function cleanPath(path) {
   if (path.length && path.slice(-1) !== "/") {
-    path += "/";
+    return path + "/";
   }
+  return path;
+}
+function isHidden(filename) {
+  return filename.slice(0, 1) === ".";
+}
+function split(filename) {
+  const parts = filename.split(".");
+  const ext = parts.length > 1 ? "." + parts.pop() : "";
+  const file = parts.join(".");
+  return { ext, file };
+}
+function isIgnoredResult(result) {
+  return result === void 0 || result === false || result === null;
+}
+async function scanDirectory(path, callback, subdirs = true) {
+  const results = [];
+  path = cleanPath(path);
   async function scan(subdir) {
     const files = await fs.promises.readdir(path + subdir);
     for (let i = 0; i < files.length; i++) {
       const filename = files[i];
-      if (filename.slice(0, 1) === ".") {
+      if (isHidden(filename)) {
         continue;
       }
       const stat = await fs.promises.stat(path + subdir + filename);
@@ -24,16 +40,14 @@ async function scanDirectory(path, callback, subdirs = true) {
       if (!stat.isFile()) {
         continue;
       }
-      const parts = filename.split(".");
-      const ext = parts.length > 1 ? "." + parts.pop() : "";
-      const file = parts.join(".");
+      const { ext, file } = split(filename);
       let callbackResult;
       if (callback) {
         callbackResult = callback(ext, file, subdir, path, stat);
         if (callbackResult instanceof Promise) {
           callbackResult = await callbackResult;
         }
-        if (callbackResult === void 0 || callbackResult === false || callbackResult === null) {
+        if (isIgnoredResult(callbackResult)) {
           continue;
         }
       } else {
@@ -47,5 +61,44 @@ async function scanDirectory(path, callback, subdirs = true) {
   await scan("");
   return results;
 }
+function scanDirectorySync(path, callback, subdirs = true) {
+  const results = [];
+  path = cleanPath(path);
+  function scan(subdir) {
+    const files = fs.readdirSync(path + subdir);
+    for (let i = 0; i < files.length; i++) {
+      const filename = files[i];
+      if (isHidden(filename)) {
+        continue;
+      }
+      const stat = fs.statSync(path + subdir + filename);
+      if (stat.isDirectory()) {
+        if (subdirs) {
+          scan(subdir + filename + "/");
+        }
+        continue;
+      }
+      if (!stat.isFile()) {
+        continue;
+      }
+      const { ext, file } = split(filename);
+      let callbackResult;
+      if (callback) {
+        callbackResult = callback(ext, file, subdir, path, stat);
+        if (isIgnoredResult(callbackResult)) {
+          continue;
+        }
+      } else {
+        callbackResult = true;
+      }
+      results.push(
+        callbackResult === true ? subdir + filename : callbackResult
+      );
+    }
+  }
+  scan("");
+  return results;
+}
 
 exports.scanDirectory = scanDirectory;
+exports.scanDirectorySync = scanDirectorySync;

package/lib/misc/scan.d.ts

@@ -15,13 +15,19 @@ import { Stats } from 'fs';
  */
 type ScanDirectoryCallbackFalseResult = boolean | null | undefined;
 type ScanDirectoryCallbackStringResult = ScanDirectoryCallbackFalseResult | string;
-type ScanDirectoryCallbackAsString = (ext: string, file: string, subdir: string, path: string, stat: Stats) => ScanDirectoryCallbackStringResult | Promise<ScanDirectoryCallbackStringResult>;
-type ScanDirectoryCallbackAsCustom<T> = (ext: string, file: string, subdir: string, path: string, stat: Stats) => T | ScanDirectoryCallbackFalseResult | Promise<T | ScanDirectoryCallbackFalseResult>;
-type ScanDirectoryCallback = ScanDirectoryCallbackAsCustom<unknown> | ScanDirectoryCallbackAsString;
+type Callback<T> = (ext: string, file: string, subdir: string, path: string, stat: Stats) => T;
+type AsyncCallback<T> = Callback<T | Promise<T>>;
+type ScanDirectoryCallback = AsyncCallback<ScanDirectoryCallbackStringResult | unknown>;
+type ScanDirectorySyncCallback = Callback<ScanDirectoryCallbackStringResult | unknown>;
 /**
  * Find all files in directory
  */
-declare function scanDirectory(path: string, callback?: ScanDirectoryCallbackAsString, subdirs?: boolean): Promise<string[]>;
-declare function scanDirectory<T>(path: string, callback: ScanDirectoryCallbackAsCustom<T>, subdirs?: boolean): Promise<T[]>;
+declare function scanDirectory(path: string, callback?: AsyncCallback<ScanDirectoryCallbackStringResult>, subdirs?: boolean): Promise<string[]>;
+declare function scanDirectory<T>(path: string, callback: AsyncCallback<T | ScanDirectoryCallbackFalseResult>, subdirs?: boolean): Promise<T[]>;
+/**
+ * Find all files in directory, synchronously
+ */
+declare function scanDirectorySync(path: string, callback?: Callback<ScanDirectoryCallbackStringResult>, subdirs?: boolean): string[];
+declare function scanDirectorySync<T>(path: string, callback: Callback<T | ScanDirectoryCallbackFalseResult>, subdirs?: boolean): T[];
 
-export { ScanDirectoryCallback, scanDirectory };
+export { ScanDirectoryCallback, ScanDirectorySyncCallback, scanDirectory, scanDirectorySync };