@thi.ng/file-io 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-01-10T15:20:18Z
+- **Last updated**: 2023-02-05T14:42:21Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [0.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@0.5.0) (2023-02-05)
+
+#### 🚀 Features
+
+- add fileChunks() ([bcff691](https://github.com/thi-ng/umbrella/commit/bcff691))
+
 ## [0.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@0.4.0) (2023-01-10)
 
 #### 🚀 Features

package/file-chunks.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="node" />
+import type { ILogger } from "@thi.ng/logger";
+export interface FileChunkOpts {
+    /**
+     * Optional logger instance
+     */
+    logger: ILogger;
+    /**
+     * Chunk size (in bytes).
+     *
+     * @defaultValue 1024
+     */
+    size: number;
+    /**
+     * Read start position (in bytes)
+     *
+     * @defaultValue 0
+     */
+    start: number;
+    /**
+     * Read end position (in bytes)
+     *
+     * @defaultValue Infinity
+     */
+    end: number;
+}
+/**
+ * Async iterator. Yields chunks of byte buffers from given file. User
+ * configurable size and byte ranges.
+ *
+ * @example
+ * ```ts
+ * for await(let buf of fileChunks("file.bin", { start: 16*1024*1024 })) {
+ *   // ...
+ * }
+ * ```
+ *
+ * @param path
+ * @param opts
+ */
+export declare function fileChunks(path: string, opts?: Partial<FileChunkOpts>): AsyncGenerator<Buffer, void, unknown>;
+//# sourceMappingURL=file-chunks.d.ts.map

package/file-chunks.js

@@ -0,0 +1,48 @@
+import { U32 } from "@thi.ng/hex";
+import { open } from "fs/promises";
+/**
+ * Async iterator. Yields chunks of byte buffers from given file. User
+ * configurable size and byte ranges.
+ *
+ * @example
+ * ```ts
+ * for await(let buf of fileChunks("file.bin", { start: 16*1024*1024 })) {
+ *   // ...
+ * }
+ * ```
+ *
+ * @param path
+ * @param opts
+ */
+export async function* fileChunks(path, opts) {
+    let { logger, size, start, end } = {
+        size: 1024,
+        start: 0,
+        end: Infinity,
+        ...opts,
+    };
+    logger &&
+        logger.debug(`start reading file chunks (size: 0x${size}): ${path}`);
+    let fd = undefined;
+    try {
+        fd = await open(path, "r");
+        while (start < end) {
+            logger &&
+                logger.debug(`reading chunk: 0x${U32(start)} - 0x${U32(start + size - 1)} (${path})`);
+            const { buffer, bytesRead } = await fd.read({
+                buffer: Buffer.alloc(size),
+                length: size,
+                position: start,
+            });
+            if (bytesRead === 0)
+                break;
+            yield buffer;
+            if (bytesRead < size)
+                break;
+            start += bytesRead;
+        }
+    }
+    finally {
+        await fd?.close();
+    }
+}

package/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./delete.js";
 export * from "./dir.js";
 export * from "./ext.js";
+export * from "./file-chunks.js";
 export * from "./files.js";
 export * from "./hash.js";
 export * from "./json.js";

package/index.js

@@ -1,6 +1,7 @@
 export * from "./delete.js";
 export * from "./dir.js";
 export * from "./ext.js";
+export * from "./file-chunks.js";
 export * from "./files.js";
 export * from "./hash.js";
 export * from "./json.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/file-io",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Assorted file I/O utils (with logging support) for NodeJS",
   "type": "module",
   "module": "./index.js",
@@ -34,18 +34,19 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.6.3",
-    "@thi.ng/checks": "^3.3.7",
-    "@thi.ng/logger": "^1.4.7",
-    "@thi.ng/random": "^3.3.21"
+    "@thi.ng/api": "^8.7.0",
+    "@thi.ng/checks": "^3.3.8",
+    "@thi.ng/hex": "^2.3.5",
+    "@thi.ng/logger": "^1.4.8",
+    "@thi.ng/random": "^3.3.22"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.7",
-    "@thi.ng/testament": "^0.3.9",
-    "rimraf": "^3.0.2",
+    "@microsoft/api-extractor": "^7.34.2",
+    "@thi.ng/testament": "^0.3.10",
+    "rimraf": "^4.1.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.22",
-    "typescript": "^4.9.4"
+    "typedoc": "^0.23.24",
+    "typescript": "^4.9.5"
   },
   "keywords": [
     "file",
@@ -83,6 +84,9 @@
     "./ext": {
       "default": "./ext.js"
     },
+    "./file-chunks": {
+      "default": "./file-chunks.js"
+    },
     "./files": {
       "default": "./files.js"
     },
@@ -112,5 +116,5 @@
     "status": "stable",
     "year": 2022
   },
-  "gitHead": "3f0b3e2a7c82aefc7e46fb4338369836b5e1b8cf\n"
+  "gitHead": "50ba9c87676fac60c46d2bc0e4d2c7711a374a68\n"
 }