readline-pager 0.7.2 → 0.7.3

package/README.md

@@ -1,5 +1,6 @@
 # 📄 readline-pager
 
+<!-- rumdl-disable MD033 -->
 <p align="center">
   <img src="https://raw.githubusercontent.com/devmor-j/readline-pager/main/logo.webp" alt="logo" width="349">
 </p>
@@ -10,9 +11,11 @@
   </a>
   <img src="https://img.shields.io/npm/dw/readline-pager" alt="downloads">
   <img src="https://img.shields.io/github/stars/devmor-j/readline-pager" alt="stars">
+  <img src="coverage.svg" alt="coverage">
 </p>
 
-⚡ High-performance paginated file reader for Node.js. Process large text files efficiently without loading them into memory.
+⚡ High-performance paginated file reader for Node.js. Process large text files
+efficiently without loading them into memory.
 
 - 📦 Zero dependencies
 - ⚡ Up to ~3× faster than Node.js `readline`
@@ -20,10 +23,12 @@
 - 🔁 Async (`for await...of`) and sync (`for...of`) iteration
 - 📄 Page-based reading with manual control (`next`, `nextSync`)
 - 🔀 Forward and backward reading support
-- 🧪 Fully typed with over 90% test coverage
+- 🧪 Fully typed with high test coverage
 
 > **Important:**  
-> Performance depends heavily on the `chunkSize` option. Tune it for your storage device. A value of **64 KiB** is usually a good starting point. Increasing it may improve throughput until you reach the best value for your hardware.
+> Performance depends heavily on the `chunkSize` option. Tune it for your
+> storage device. A value of **64 KiB** is usually a good starting point.
+> Increasing it may improve throughput until you reach the best value for your hardware.
 
 ---
 
@@ -103,7 +108,9 @@ createNativePager(filepath, {
 - `output` — Controls the page data type.
 
 > **Note:**
-> `createNativePager` requires x86 AVX2 or ARM NEON CPU instruction set extensions and will throw if they are not available. It also does **not** support multi-character delimiters because it uses fast SIMD-based scanning.
+> `createNativePager` requires x86 AVX2 or ARM NEON CPU instruction set extensions
+> and will throw if they are not available. It also does **not** support
+> multi-character delimiters because it uses fast SIMD-based scanning.
 
 ---
 
@@ -118,7 +125,8 @@ Returns `null` when the end of the file is reached.
 Empty lines are preserved.
 
 > **Note:**
-> Unlike Node.js `readline`, which may skip empty files or leading empty lines, `readline-pager` always returns all lines.
+> Unlike Node.js `readline`, which may skip empty files or leading empty lines,
+> `readline-pager` always returns all lines.
 >
 > - A completely empty file (`0` bytes) produces `[""]` on the first read.
 > - A file containing multiple empty lines returns each line as an empty string.
@@ -149,8 +157,6 @@ node test/benchmark.ts --lines=20000 --page-size=500 --backward
 > Test setup: generated text files (UUID lines), NVMe SSD, Node.js runtime.
 > Results are averaged across multiple runs. Actual performance depends on hardware.
 
----
-
 ### ⚡ Throughput (MB/s)
 
 | Method                 | 1M lines (35 MB) | 10M lines (353 MB) | 100M lines (3.5 GB) | 1B lines (35.3 GB) |

package/dist/main.d.cts

@@ -1,4 +1,4 @@
-import { a as Output, c as PagerOptions, i as NativeReaderOptions, l as ReaderOptions, n as AsyncFunction, o as PageOutput, r as NativeAddon, s as Pager, t as createNativePager, u as ResolvePageOutput } from "./native-7x1Vhdaw.cjs";
+import { i as PagerOptions, n as Output, r as Pager, t as createNativePager } from "./native-7FzZtBp1.cjs";
 
 //#region src/main.d.ts
 declare function createPager<T extends Output>(filepath: string, options: PagerOptions & {
@@ -6,4 +6,4 @@ declare function createPager<T extends Output>(filepath: string, options: PagerO
 }): Pager<T>;
 declare function createPager(filepath: string, options?: PagerOptions): Pager<"string">;
 //#endregion
-export { AsyncFunction, NativeAddon, NativeReaderOptions, Output, PageOutput, Pager, PagerOptions, ReaderOptions, ResolvePageOutput, createNativePager, createPager, createPager as default };
+export { type Pager, type PagerOptions, createNativePager, createPager, createPager as default };

package/dist/main.d.mts

@@ -1,4 +1,4 @@
-import { a as Output, c as PagerOptions, i as NativeReaderOptions, l as ReaderOptions, n as AsyncFunction, o as PageOutput, r as NativeAddon, s as Pager, t as createNativePager, u as ResolvePageOutput } from "./native-D6SBIgoE.mjs";
+import { i as PagerOptions, n as Output, r as Pager, t as createNativePager } from "./native-B0PXEEYw.mjs";
 
 //#region src/main.d.ts
 declare function createPager<T extends Output>(filepath: string, options: PagerOptions & {
@@ -6,4 +6,4 @@ declare function createPager<T extends Output>(filepath: string, options: PagerO
 }): Pager<T>;
 declare function createPager(filepath: string, options?: PagerOptions): Pager<"string">;
 //#endregion
-export { AsyncFunction, NativeAddon, NativeReaderOptions, Output, PageOutput, Pager, PagerOptions, ReaderOptions, ResolvePageOutput, createNativePager, createPager, createPager as default };
+export { type Pager, type PagerOptions, createNativePager, createPager, createPager as default };

package/dist/{native-7x1Vhdaw.d.cts → native-7FzZtBp1.d.cts}

@@ -1,7 +1,5 @@
 //#region src/types.d.ts
-type AsyncFunction = () => Promise<void>;
 type Output = "string" | "buffer";
-type PageOutput = string[] | Buffer;
 type ResolvePageOutput<T extends Output> = T extends "buffer" ? Buffer : string[];
 interface ReaderOptions {
   chunkSize: number;
@@ -19,14 +17,6 @@ interface NativeReaderOptions {
 type PagerOptions = Partial<ReaderOptions> & {
   backward?: boolean;
 };
-type AddonFD = object | null;
-type AddonData = Buffer | null;
-interface NativeAddon {
-  open: (filepath: string, pageSize: number, delimiter: string, backward: boolean) => AddonFD;
-  next: (fd: AddonFD) => Promise<AddonData>;
-  nextSync: (fd: AddonFD) => AddonData;
-  close: (fd: AddonFD) => Promise<void>;
-}
 interface Pager<T extends Output = "string"> {
   next(): Promise<ResolvePageOutput<T> | null>;
   nextSync(): ResolvePageOutput<T> | null;
@@ -41,4 +31,4 @@ declare function createNativePager<T extends Output>(filepath: string, options:
 }): Pager<T>;
 declare function createNativePager(filepath: string, options?: Partial<NativeReaderOptions>): Pager<"string">;
 //#endregion
-export { Output as a, PagerOptions as c, NativeReaderOptions as i, ReaderOptions as l, AsyncFunction as n, PageOutput as o, NativeAddon as r, Pager as s, createNativePager as t, ResolvePageOutput as u };
+export { PagerOptions as i, Output as n, Pager as r, createNativePager as t };

package/dist/{native-D6SBIgoE.d.mts → native-B0PXEEYw.d.mts}

@@ -1,7 +1,5 @@
 //#region src/types.d.ts
-type AsyncFunction = () => Promise<void>;
 type Output = "string" | "buffer";
-type PageOutput = string[] | Buffer;
 type ResolvePageOutput<T extends Output> = T extends "buffer" ? Buffer : string[];
 interface ReaderOptions {
   chunkSize: number;
@@ -19,14 +17,6 @@ interface NativeReaderOptions {
 type PagerOptions = Partial<ReaderOptions> & {
   backward?: boolean;
 };
-type AddonFD = object | null;
-type AddonData = Buffer | null;
-interface NativeAddon {
-  open: (filepath: string, pageSize: number, delimiter: string, backward: boolean) => AddonFD;
-  next: (fd: AddonFD) => Promise<AddonData>;
-  nextSync: (fd: AddonFD) => AddonData;
-  close: (fd: AddonFD) => Promise<void>;
-}
 interface Pager<T extends Output = "string"> {
   next(): Promise<ResolvePageOutput<T> | null>;
   nextSync(): ResolvePageOutput<T> | null;
@@ -41,4 +31,4 @@ declare function createNativePager<T extends Output>(filepath: string, options:
 }): Pager<T>;
 declare function createNativePager(filepath: string, options?: Partial<NativeReaderOptions>): Pager<"string">;
 //#endregion
-export { Output as a, PagerOptions as c, NativeReaderOptions as i, ReaderOptions as l, AsyncFunction as n, PageOutput as o, NativeAddon as r, Pager as s, createNativePager as t, ResolvePageOutput as u };
+export { PagerOptions as i, Output as n, Pager as r, createNativePager as t };

package/dist/native.d.cts

@@ -1,2 +1,2 @@
-import { t as createNativePager } from "./native-7x1Vhdaw.cjs";
+import { t as createNativePager } from "./native-7FzZtBp1.cjs";
 export { createNativePager };

package/dist/native.d.mts

@@ -1,2 +1,2 @@
-import { t as createNativePager } from "./native-D6SBIgoE.mjs";
+import { t as createNativePager } from "./native-B0PXEEYw.mjs";
 export { createNativePager };

package/package.json

@@ -1,32 +1,35 @@
 {
   "name": "readline-pager",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "scripts": {
     "build:js": "tsdown",
     "build:native": "node-gyp rebuild",
     "build": "npm run build:native && npm run build:js",
     "pretest": "npm run build",
-    "test": "PAGER_TEST_CLEANUPS=1 node --test --experimental-test-coverage test/**/*.test.ts",
+    "test": "PAGER_TEST_CLEANUPS=1 c8 --reporter=lcov --reporter=text node --test test/**/*.test.ts",
+    "test:coverage": "npx lcov-badge2 coverage/lcov.info -o coverage.svg",
     "prepublishOnly": "npm run build && npm run test",
     "benchmark:node": "node test/benchmark.ts",
     "benchmark:deno": "deno --allow-write --allow-read --allow-env test/benchmark.ts",
     "benchmark:bun": "bun test/benchmark.ts"
   },
   "devDependencies": {
-    "@types/bun": "~1.3.12",
+    "@types/bun": "~1.3.13",
     "@types/deno": "~2.5.0",
-    "@types/node": "~25.6.0",
-    "node-gyp": "~12.2.0",
-    "prettier": "~3.8.2",
+    "@types/node": "~25.6.2",
+    "c8": "~11.0.0",
+    "lcov-badge2": "~1.1.4",
+    "node-gyp": "~12.3.0",
+    "prettier": "~3.8.3",
     "prettier-plugin-organize-imports": "~4.3.0",
-    "tsdown": "~0.21.7",
-    "typescript": "~6.0.2"
+    "tsdown": "~0.22.0",
+    "typescript": "~6.0.3"
   },
   "optionalDependencies": {
-    "@devmor-j/readline-pager-linux-arm64": "0.7.2",
-    "@devmor-j/readline-pager-linux-musl-arm64": "0.7.2",
-    "@devmor-j/readline-pager-linux-musl-x64": "0.7.2",
-    "@devmor-j/readline-pager-linux-x64": "0.7.2"
+    "@devmor-j/readline-pager-linux-arm64": "0.7.3",
+    "@devmor-j/readline-pager-linux-musl-arm64": "0.7.3",
+    "@devmor-j/readline-pager-linux-musl-x64": "0.7.3",
+    "@devmor-j/readline-pager-linux-x64": "0.7.3"
   },
   "gypfile": false,
   "type": "module",