@thi.ng/file-io 2.1.2 → 2.1.3

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-05-08T18:24:31Z
+- **Last updated**: 2024-06-21T19:34:38Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 192 standalone projects, maintained as part
+> This is one of 193 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -54,7 +54,7 @@ For Node.js REPL:
 const fio = await import("@thi.ng/file-io");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.06 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.05 KB
 
 ## Dependencies
 

package/file-chunks.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { ILogger } from "@thi.ng/logger";
 export interface FileChunkOpts {
     /**

package/files.js

@@ -1,4 +1,4 @@
-import { readdirSync, statSync } from "node:fs";
+import { readdirSync } from "node:fs";
 import { sep } from "node:path";
 import { isDirectory } from "./dir.js";
 import { __ensurePred } from "./internal/ensure.js";
@@ -26,7 +26,7 @@ function* __dirs(dir, match = "", logger, maxDepth = Infinity, depth = 0) {
   for (let f of readdirSync(dir).sort()) {
     const curr = dir + sep + f;
     try {
-      if (statSync(curr).isDirectory()) {
+      if (isDirectory(curr)) {
         if (pred(curr)) yield curr;
         yield* __dirs(curr, match, logger, maxDepth, depth + 1);
       }

package/hash.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { TypedArray } from "@thi.ng/api";
 import type { ILogger } from "@thi.ng/logger";
 import type { Readable } from "node:stream";
@@ -18,7 +16,7 @@ export declare const fileHash: (path: string, logger?: ILogger, algo?: HashAlgo)
  * "sha256"). If `logger` is given, the hash will be logged too.
  *
  * @remarks
- * Also see {@link fileHash} and {@link stringHash}.
+ * Also see {@link fileHash} and {@link bufferHash}.
  *
  * @param src
  * @param logger

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/file-io",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "description": "Assorted file I/O utils (with logging support) for NodeJS/Bun",
   "type": "module",
   "module": "./index.js",
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/file-io#readme",
+  "homepage": "https://thi.ng/file-io",
   "funding": [
     {
       "type": "github",
@@ -36,17 +36,17 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.2",
-    "@thi.ng/checks": "^3.6.4",
-    "@thi.ng/hex": "^2.3.46",
-    "@thi.ng/logger": "^3.0.12",
-    "@thi.ng/random": "^3.8.0"
+    "@thi.ng/api": "^8.11.3",
+    "@thi.ng/checks": "^3.6.5",
+    "@thi.ng/hex": "^2.3.47",
+    "@thi.ng/logger": "^3.0.13",
+    "@thi.ng/random": "^3.8.1"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.43.2",
-    "esbuild": "^0.21.1",
+    "@microsoft/api-extractor": "^7.47.0",
+    "esbuild": "^0.21.5",
     "typedoc": "^0.25.13",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.2"
   },
   "keywords": [
     "async",
@@ -123,5 +123,5 @@
     "status": "stable",
     "year": 2022
   },
-  "gitHead": "df34b4a9e650cc7323575356de207d78933bdcf3\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }

package/text.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { ILogger } from "@thi.ng/logger";
 /**
  * Reads text from given file `path`, optionally with custom encoding (default:

package/watch.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { type Event, type IClear, type INotify, type IObjectOf, type Listener, type Predicate } from "@thi.ng/api";
 import type { ILogger } from "@thi.ng/logger";
 import { type FSWatcher } from "node:fs";
@@ -16,7 +15,15 @@ export interface WatcherOpts {
     logger: ILogger;
 }
 export interface PathWatchOpts {
+    /**
+     * If enabled (default) and if the path refers to a directory, any file
+     * changes within that dir (or any subdir) will trigger an event.
+     */
     recursive: boolean;
+    /**
+     * File extension filter. If given, events are only triggered for paths
+     * matching this filter.
+     */
     ext: string | RegExp | Predicate<string>;
 }
 export declare const EVENT_ADDED = "added";

package/write.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { TypedArray } from "@thi.ng/api";
 import type { ILogger } from "@thi.ng/logger";
 import { type WriteFileOptions } from "node:fs";