@magic/fs 0.0.33 → 0.0.34

package/README.md

@@ -321,7 +321,11 @@ update dependencies
 
 - fix import mapping from .mjs to .js
 
-##### 0.0.34 - unreleased
+##### 0.0.34
+
+- update types
+
+##### 0.0.35 - unreleased
 
 ...
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic/fs",
-  "version": "0.0.33",
+  "version": "0.0.34",
   "author": "Wizards & Witches",
   "description": "nodejs fs promises + goodies",
   "license": "AGPL-3.0",
@@ -42,7 +42,7 @@
     "@magic-themes/docs": "0.0.15",
     "@magic/core": "0.0.156",
     "@magic/format": "0.0.68",
-    "@magic/test": "0.2.22",
+    "@magic/test": "0.2.24",
     "@types/node": "24.7.2",
     "typescript": "5.9.3"
   },

package/src/getDirectories.js

@@ -10,18 +10,9 @@ import { getFilePath } from './getFilePath.js'
 
 const libName = '@magic/fs.getDirectories'
 
-/**
- * @typedef {object} Options
- * @property {string} [root]
- * @property {number} [maxDepth]
- * @property {number} [minDepth]
- * @property {boolean | number} [depth]
- * @property {boolean} [noRoot]
- */
-
 /**
  * @param {string | string[]} dir
- * @param {number | false | Options} [options]
+ * @param {number | false | { root?: string, maxDepth?: number, minDepth?: number, depth?: boolean | number, noRoot?: boolean }} [options]
  * if options is a number, its the max depth of recursion.
  * if it is false, maxDepth is set to 1
  * @returns {Promise<string[]>}

package/src/getFilePath.js

@@ -8,18 +8,11 @@ import { fs } from './fs.js'
 const libName = '@magic/fs.getFilePath'
 
 /**
- * @typedef {typeof import('./getFiles.js').getFiles} GetFiles
- * @typedef {import('./getFiles.js').Options} GetFilesOptions
- * @typedef {typeof import('./getDirectories.js').getDirectories} GetDirectories
  *
- */
-
-/**
- *
- * @param {GetFiles | GetDirectories} fn
+ * @param {import('./getFiles.js').getFiles | import('./getDirectories.js').getDirectories} fn
  * @param {string} dir
  * @param {string} file
- * @param {GetFilesOptions} args
+ * @param {number | {minDepth?: number, maxDepth?: number, depth?: number | false, extension?: string, ext?: string, root?: string}} [args]
  * @returns {Promise<string | string[] | undefined>}
  */
 export const getFilePath = async (fn, dir, file, args = {}) => {

package/src/getFiles.js

@@ -9,24 +9,11 @@ import { fs } from './fs.js'
 
 const libName = '@magic/fs.getFiles'
 
-/**
- * @typedef {object} Options
- * @property {number} [minDepth]
- * @property {number} [maxDepth]
- * @property {number | false} [depth]
- * @property {string} [extension]
- * @property {string} [ext]
- * @property {string} [root]
- */
-
 /**
  * @param {string} dir
- * First argument: directory to scan
- * @param {number | Options} [options]
- * If number, sets maxDepth directly.
+ * @param {number | {minDepth?: number, maxDepth?: number, depth?: number | false, extension?: string, ext?: string, root?: string}} [options]
  * @returns {Promise<string[]>}
  */
-
 export const getFiles = async (dir, options = {}) => {
   if (is.number(options)) {
     options = {

package/src/rmrf.js

@@ -9,17 +9,13 @@ const cwd = process.cwd()
 
 const libName = '@magic/fs.rmrf'
 
-/**
- * @typedef {object} Options
- * @property {boolean} [dryRun]
- */
-
 /**
  * Recursively removes a file or directory.
  *
  * @throws {Error} If the argument is invalid, outside cwd, or fs operations fail.
  * @param {string} dir
- * @param {Options} [opts]
+ * @param {object} [opts]
+ * @param {boolean} [opts.dryRun]
  * @returns {Promise<boolean | undefined>}
  */
 export const rmrf = async (dir, opts = {}) => {

package/types/getDirectories.d.ts

@@ -1,11 +1,13 @@
 export function getDirectories(
   dir: string | string[],
-  options?: number | false | Options,
+  options?:
+    | number
+    | false
+    | {
+        root?: string
+        maxDepth?: number
+        minDepth?: number
+        depth?: boolean | number
+        noRoot?: boolean
+      },
 ): Promise<string[]>
-export type Options = {
-  root?: string | undefined
-  maxDepth?: number | undefined
-  minDepth?: number | undefined
-  depth?: number | boolean | undefined
-  noRoot?: boolean | undefined
-}

package/types/getFilePath.d.ts

@@ -1,9 +1,41 @@
 export function getFilePath(
-  fn: GetFiles | GetDirectories,
+  fn:
+    | ((
+        dir: string,
+        options?:
+          | number
+          | {
+              minDepth?: number
+              maxDepth?: number
+              depth?: number | false
+              extension?: string
+              ext?: string
+              root?: string
+            },
+      ) => Promise<string[]>)
+    | ((
+        dir: string | string[],
+        options?:
+          | number
+          | false
+          | {
+              root?: string
+              maxDepth?: number
+              minDepth?: number
+              depth?: boolean | number
+              noRoot?: boolean
+            },
+      ) => Promise<string[]>),
   dir: string,
   file: string,
-  args?: GetFilesOptions,
+  args?:
+    | number
+    | {
+        minDepth?: number
+        maxDepth?: number
+        depth?: number | false
+        extension?: string
+        ext?: string
+        root?: string
+      },
 ): Promise<string | string[] | undefined>
-export type GetFiles = typeof import('./getFiles.js').getFiles
-export type GetFilesOptions = import('./getFiles.js').Options
-export type GetDirectories = typeof import('./getDirectories.js').getDirectories

package/types/getFiles.d.ts

@@ -1,9 +1,13 @@
-export function getFiles(dir: string, options?: number | Options): Promise<string[]>
-export type Options = {
-  minDepth?: number | undefined
-  maxDepth?: number | undefined
-  depth?: number | false | undefined
-  extension?: string | undefined
-  ext?: string | undefined
-  root?: string | undefined
-}
+export function getFiles(
+  dir: string,
+  options?:
+    | number
+    | {
+        minDepth?: number
+        maxDepth?: number
+        depth?: number | false
+        extension?: string
+        ext?: string
+        root?: string
+      },
+): Promise<string[]>

package/types/index.d.ts

@@ -1,19 +1,80 @@
 export const fs: {
   readonly mkdirp: (p: string) => Promise<boolean | void>
-  readonly rmrf: (dir: string, opts?: Options) => Promise<boolean | undefined>
+  readonly rmrf: (
+    dir: string,
+    opts?: {
+      dryRun?: boolean | undefined
+    },
+  ) => Promise<boolean | undefined>
   readonly getFileType: (name: string) => string
   readonly getDirectories: (
     dir: string | string[],
-    options?: number | false | Options,
+    options?:
+      | number
+      | false
+      | {
+          root?: string
+          maxDepth?: number
+          minDepth?: number
+          depth?: boolean | number
+          noRoot?: boolean
+        },
+  ) => Promise<string[]>
+  readonly getFiles: (
+    dir: string,
+    options?:
+      | number
+      | {
+          minDepth?: number
+          maxDepth?: number
+          depth?: number | false
+          extension?: string
+          ext?: string
+          root?: string
+        },
   ) => Promise<string[]>
-  readonly getFiles: (dir: string, options?: number | Options) => Promise<string[]>
   readonly exists: (f: import('fs').PathLike) => Promise<boolean>
   readonly getContentType: (uri: string) => string
   readonly getFilePath: (
-    fn: GetFiles | GetDirectories,
+    fn:
+      | ((
+          dir: string,
+          options?:
+            | number
+            | {
+                minDepth?: number
+                maxDepth?: number
+                depth?: number | false
+                extension?: string
+                ext?: string
+                root?: string
+              },
+        ) => Promise<string[]>)
+      | ((
+          dir: string | string[],
+          options?:
+            | number
+            | false
+            | {
+                root?: string
+                maxDepth?: number
+                minDepth?: number
+                depth?: boolean | number
+                noRoot?: boolean
+              },
+        ) => Promise<string[]>),
     dir: string,
     file: string,
-    args?: GetFilesOptions,
+    args?:
+      | number
+      | {
+          minDepth?: number
+          maxDepth?: number
+          depth?: number | false
+          extension?: string
+          ext?: string
+          root?: string
+        },
   ) => Promise<string | string[] | undefined>
   readonly readdir: typeof import('fs/promises').readdir
   readonly readDir: typeof import('fs/promises').readdir

package/types/rmrf.d.ts

@@ -1,4 +1,6 @@
-export function rmrf(dir: string, opts?: Options): Promise<boolean | undefined>
-export type Options = {
-  dryRun?: boolean | undefined
-}
+export function rmrf(
+  dir: string,
+  opts?: {
+    dryRun?: boolean | undefined
+  },
+): Promise<boolean | undefined>