readline-pager 0.2.4 → 0.2.6

package/README.md

@@ -1,16 +1,24 @@
 # 📄 readline-pager
 
-<p align="center"><img src="logo.webp" alt="logo" width="349"></p>
+<p align="center">
+  <img src="https://raw.githubusercontent.com/devmor-j/readline-pager/main/logo.webp" alt="logo" width="349">
+</p>
 
-Memory-efficient, paginated file reader for Node.js with async iteration, prefetching, backward reading and optional worker support.
+<p align="center">
+  <a href="https://www.npmjs.com/package/readline-pager">
+    <img src="https://img.shields.io/npm/v/readline-pager?color=brightgreen" alt="version">
+  </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">
+</p>
 
-`readline-pager` reads large text files page-by-page without loading the entire file into memory.
+⚡ Memory-efficient, paginated file reader for Node.js with async iteration, prefetching, backward reading and optional worker support. `readline-pager` reads large text files page-by-page without loading the entire file into memory.
 
 - ✅ Zero dependencies
 - ✅ Async iterator (`for await...of`) + manual `next()` API
 - ✅ Forward & backward reading (EOF → BOF)
 - ✅ Optional worker thread mode (forward only)
-- ✅ Up to ~3× faster than Node.js `readline`
+- ✅ Up to ~3x faster than Node.js `readline`
 - ✅ ~97% test coverage & fully typed (TypeScript)
 
 > **Important:**
@@ -30,6 +38,7 @@ npm install readline-pager
 
 ```ts
 import { createPager } from "readline-pager";
+// const { createPager } = require("readline-pager");
 
 const pager = createPager("./bigfile.txt");
 
@@ -43,8 +52,6 @@ for await (const page of pager) {
 **Recommended for highest throughput:**
 
 ```ts
-const pager = createPager("./bigfile.txt");
-
 while (true) {
   const page = await pager.next();
   if (!page) break;
@@ -52,9 +59,7 @@ while (true) {
 
 // or
 let page;
-while ((page = await pager.next()) !== null) {
-  // process page
-}
+while ((page = await pager.next()) !== null) {}
 ```
 
 - `while + next()` is the fastest iteration method (avoids extra async-iterator overhead).
@@ -68,14 +73,14 @@ while ((page = await pager.next()) !== null) {
 createPager(filepath, {
   chunkSize?: number,     // default: 64 * 1024 (64 KiB)
   pageSize?: number,      // default: 1_000
-  delimiter?: string,      // default: "\n"
+  delimiter?: string,     // default: "\n"
   prefetch?: number,      // default: 1
   backward?: boolean,     // default: false
   useWorker?: boolean,    // default: false (forward only)
 });
 ```
 
-- `chunkSize`: number of bytes read per I/O operation. **Tune this** — default is `64 * 1024`.
+- `chunkSize` — number of bytes read per I/O operation.
 - `pageSize` — number of lines per page.
 - `delimiter` — line separator.
 - `prefetch` — max number of pages buffered internally. Not required for typical use; tuning has little effect once the engine is optimized.
@@ -127,14 +132,14 @@ node test/_benchmark.ts --lines=20000 --page-size=500 --backward
 |   100M |  3528.59 |                   ~441 |                 ~298 |                     **~1,378** |
 | 1,000M | 35285.95 |                   ~426 |                 ~294 |                     **~1,168** |
 
-**Takeaway:** `readline-pager` delivers multi-GB/s memory-to-memory throughput on large files on typical NVMe hardware; results vary with `chunkSize`, runtime (Node vs Bun), and CPU/OS.
+**Runtime Environment:** Node.js v25.6.1 & Bun v1.3.9
 
 ---
 
 ## 🛠 Development & Contributing
 
-- Minimum supported Node.js: **v18.12** (lts/hydrogen).
-- Development/test environment: **Node v25.6**, **TypeScript v5.9**.
+- Minimum supported Node.js: **v18.12 (lts/hydrogen)**.
+- Development/test environment: **Node v25.6 & TypeScript v5.9**.
 
 Run tests:
 

package/dist/main.cjs

@@ -1,4 +1,4 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
 let node_fs_promises = require("node:fs/promises");
 let node_worker_threads = require("node:worker_threads");
 
@@ -298,4 +298,5 @@ function createPager(filepath, options = {}) {
 }
 
 //#endregion
-exports.createPager = createPager;
+exports.createPager = createPager;
+exports.default = createPager;

package/dist/main.d.cts

@@ -20,4 +20,4 @@ interface Pager extends AsyncIterable<string[]> {
 //#region src/main.d.ts
 declare function createPager(filepath: string, options?: PagerOptions): Pager;
 //#endregion
-export { Pager, PagerOptions, ReaderOptions, createPager };
+export { Pager, PagerOptions, ReaderOptions, createPager, createPager as default };

package/dist/main.d.mts

@@ -20,4 +20,4 @@ interface Pager extends AsyncIterable<string[]> {
 //#region src/main.d.ts
 declare function createPager(filepath: string, options?: PagerOptions): Pager;
 //#endregion
-export { Pager, PagerOptions, ReaderOptions, createPager };
+export { Pager, PagerOptions, ReaderOptions, createPager, createPager as default };

package/dist/main.mjs

@@ -302,4 +302,4 @@ function createPager(filepath, options = {}) {
 }
 
 //#endregion
-export { createPager };
+export { createPager, createPager as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "readline-pager",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "scripts": {
     "build": "tsdown",
     "pretest": "npm run build",