readline-pager 0.6.2 → 0.6.5

package/README.md

@@ -68,7 +68,7 @@ let page;
 const pager = createPager("./bigfile.txt");
 while ((page = pager.nextSync()) !== null) {}
 
-// Native C++ (fastest)
+// Native C++
 for await (const page of createNativePager("./bigfile.txt")) {
 }
 ```
@@ -87,6 +87,12 @@ createPager(filepath, {
   useWorker?: boolean,  // default: false
   tryNative?: boolean,  // default: true
 });
+
+createNativePager(filepath, {
+  pageSize?: number,    // default: 1_000
+  delimiter?: string,   // default: "\n"
+  backward?: boolean,   // default: false
+});
 ```
 
 - `chunkSize` — number of bytes read per I/O operation.
@@ -98,7 +104,7 @@ createPager(filepath, {
 - `tryNative` — attempts to use the native reader, falls back to the non-native version if it fails.
 
 > **Note:**
-> `createNativePager` supports only `pageSize`, `delimiter`, and `backward` options and does **not** support multi-character delimiters.
+> `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 due to fast SIMD-based scanning.
 
 ---
 
@@ -138,7 +144,7 @@ Run the benchmark locally:
 npm run benchmark:node
 
 # or customize with args
-node test/_benchmark.ts --lines=20000 --page-size=500 --backward
+node test/benchmark.ts --lines=20000 --page-size=500 --backward
 ```
 
 > Test setup: generated text files (UUID lines), NVMe SSD, Node.js runtime.

package/dist/main.cjs

@@ -529,7 +529,7 @@ function createPager(filepath, options = {}) {
 	if (tryNative) {
 		if (delimiter.length !== 1) throw new RangeError("native reader only supports single-character delimiters");
 	}
-	const _options = {
+	const readerOptions = {
 		chunkSize,
 		pageSize,
 		prefetch,
@@ -537,19 +537,19 @@ function createPager(filepath, options = {}) {
 	};
 	let nativeReader;
 	if (tryNative) {
-		const _nativeOptions = {
+		const nativeOptions = {
 			pageSize,
 			delimiter,
 			backward
 		};
 		try {
-			nativeReader = require_native.createNativePager(filepath, _nativeOptions);
+			nativeReader = require_native.createNativePager(filepath, nativeOptions);
 		} catch {}
 	}
-	const reader = tryNative && nativeReader ? nativeReader : useWorker ? createWorkerReader(filepath, _options) : backward ? createBackwardReader(filepath, _options) : createForwardReader(filepath, _options);
-	if (process.env.TEST_CLEANUPS) {
-		globalThis.__test_cleanups__ ??= [];
-		globalThis.__test_cleanups__.push(reader.close);
+	const reader = tryNative && nativeReader ? nativeReader : useWorker ? createWorkerReader(filepath, readerOptions) : backward ? createBackwardReader(filepath, readerOptions) : createForwardReader(filepath, readerOptions);
+	if (process.env.PAGER_TEST_CLEANUPS) {
+		globalThis.__pager_test_cleanups__ ??= [];
+		globalThis.__pager_test_cleanups__.push(reader.close);
 	}
 	return reader;
 }

package/dist/main.mjs

@@ -529,7 +529,7 @@ function createPager(filepath, options = {}) {
 	if (tryNative) {
 		if (delimiter.length !== 1) throw new RangeError("native reader only supports single-character delimiters");
 	}
-	const _options = {
+	const readerOptions = {
 		chunkSize,
 		pageSize,
 		prefetch,
@@ -537,19 +537,19 @@ function createPager(filepath, options = {}) {
 	};
 	let nativeReader;
 	if (tryNative) {
-		const _nativeOptions = {
+		const nativeOptions = {
 			pageSize,
 			delimiter,
 			backward
 		};
 		try {
-			nativeReader = createNativePager(filepath, _nativeOptions);
+			nativeReader = createNativePager(filepath, nativeOptions);
 		} catch {}
 	}
-	const reader = tryNative && nativeReader ? nativeReader : useWorker ? createWorkerReader(filepath, _options) : backward ? createBackwardReader(filepath, _options) : createForwardReader(filepath, _options);
-	if (process.env.TEST_CLEANUPS) {
-		globalThis.__test_cleanups__ ??= [];
-		globalThis.__test_cleanups__.push(reader.close);
+	const reader = tryNative && nativeReader ? nativeReader : useWorker ? createWorkerReader(filepath, readerOptions) : backward ? createBackwardReader(filepath, readerOptions) : createForwardReader(filepath, readerOptions);
+	if (process.env.PAGER_TEST_CLEANUPS) {
+		globalThis.__pager_test_cleanups__ ??= [];
+		globalThis.__pager_test_cleanups__.push(reader.close);
 	}
 	return reader;
 }

package/dist/native.cjs

@@ -7,16 +7,13 @@ function isMusl() {
 	if ((0, node_os.platform)() !== "linux") return false;
 	try {
 		return !(process.report?.getReport?.())?.header?.glibcVersionRuntime;
-	} catch {
-		return false;
-	}
+	} catch {}
+	return false;
 }
 function getPackageName() {
 	const p = (0, node_os.platform)();
 	const a = (0, node_os.arch)();
 	switch (p) {
-		case "darwin":
-		case "win32": return `@devmor-j/readline-pager-${p}-${a}`;
 		case "linux": return `@devmor-j/readline-pager-${p}-${isMusl() ? "musl-" : ""}${a}`;
 		default: throw new Error(`Unsupported platform: ${p}/${a}`);
 	}
@@ -25,40 +22,45 @@ function loadNativeAddon() {
 	try {
 		return require$1(getPackageName());
 	} catch {
-		const UNAVAILABLE = `Native addon not available for ${(0, node_os.platform)()}/${(0, node_os.arch)()}.`;
-		throw new Error(UNAVAILABLE);
+		const p = (0, node_os.platform)();
+		const a = (0, node_os.arch)();
+		throw new Error(`Native addon not available for ${p}/${a}.`);
 	}
 }
-function createNativePager(filepath, options) {
-	const { pageSize = 1e3, delimiter = "\n", backward = false } = options ?? {};
+function createNativePager(filepath, options = {}) {
+	const { pageSize = 1e3, delimiter = "\n", backward = false } = options;
 	if (!filepath) throw new Error("filepath required");
 	if (pageSize < 1) throw new RangeError("pageSize must be >= 1");
-	if (delimiter.length !== 1) throw new RangeError("native reader only supports single-character delimiters");
-	const nativePager = loadNativeAddon();
-	let fd = nativePager.open(filepath, pageSize, delimiter, backward);
+	if (delimiter?.length > 1) throw new RangeError("native reader only supports single-character delimiters");
+	const nativeReader = loadNativeAddon();
+	if (process.env.PAGER_TEST_CLEANUPS) {
+		globalThis.__pager_test_cleanups__ ??= [];
+		globalThis.__pager_test_cleanups__.push(nativeReader.close);
+	}
+	let fd = nativeReader.open(filepath, pageSize, delimiter, backward);
 	let closed = false;
-	const next = async () => {
+	async function next() {
 		if (closed || !fd) return null;
-		const data = await nativePager.next(fd);
+		const data = await nativeReader.next(fd);
 		if (!data) return null;
 		return data.toString("utf8").split(delimiter);
-	};
-	const nextSync = () => {
+	}
+	function nextSync() {
 		if (closed || !fd) return null;
-		const data = nativePager.nextSync(fd);
+		const data = nativeReader.nextSync(fd);
 		if (!data) return null;
 		return data.toString("utf8").split(delimiter);
-	};
-	const close = async () => {
-		if (closed) return;
+	}
+	async function close() {
+		if (closed || !fd) return;
 		closed = true;
 		if (fd) {
 			try {
-				await nativePager.close(fd);
+				await nativeReader.close(fd);
 			} catch {}
 			fd = null;
 		}
-	};
+	}
 	function tryClose() {
 		close().catch(() => {});
 	}

package/dist/native.mjs

@@ -6,16 +6,13 @@ function isMusl() {
 	if (platform() !== "linux") return false;
 	try {
 		return !(process.report?.getReport?.())?.header?.glibcVersionRuntime;
-	} catch {
-		return false;
-	}
+	} catch {}
+	return false;
 }
 function getPackageName() {
 	const p = platform();
 	const a = arch();
 	switch (p) {
-		case "darwin":
-		case "win32": return `@devmor-j/readline-pager-${p}-${a}`;
 		case "linux": return `@devmor-j/readline-pager-${p}-${isMusl() ? "musl-" : ""}${a}`;
 		default: throw new Error(`Unsupported platform: ${p}/${a}`);
 	}
@@ -24,40 +21,45 @@ function loadNativeAddon() {
 	try {
 		return require(getPackageName());
 	} catch {
-		const UNAVAILABLE = `Native addon not available for ${platform()}/${arch()}.`;
-		throw new Error(UNAVAILABLE);
+		const p = platform();
+		const a = arch();
+		throw new Error(`Native addon not available for ${p}/${a}.`);
 	}
 }
-function createNativePager(filepath, options) {
-	const { pageSize = 1e3, delimiter = "\n", backward = false } = options ?? {};
+function createNativePager(filepath, options = {}) {
+	const { pageSize = 1e3, delimiter = "\n", backward = false } = options;
 	if (!filepath) throw new Error("filepath required");
 	if (pageSize < 1) throw new RangeError("pageSize must be >= 1");
-	if (delimiter.length !== 1) throw new RangeError("native reader only supports single-character delimiters");
-	const nativePager = loadNativeAddon();
-	let fd = nativePager.open(filepath, pageSize, delimiter, backward);
+	if (delimiter?.length > 1) throw new RangeError("native reader only supports single-character delimiters");
+	const nativeReader = loadNativeAddon();
+	if (process.env.PAGER_TEST_CLEANUPS) {
+		globalThis.__pager_test_cleanups__ ??= [];
+		globalThis.__pager_test_cleanups__.push(nativeReader.close);
+	}
+	let fd = nativeReader.open(filepath, pageSize, delimiter, backward);
 	let closed = false;
-	const next = async () => {
+	async function next() {
 		if (closed || !fd) return null;
-		const data = await nativePager.next(fd);
+		const data = await nativeReader.next(fd);
 		if (!data) return null;
 		return data.toString("utf8").split(delimiter);
-	};
-	const nextSync = () => {
+	}
+	function nextSync() {
 		if (closed || !fd) return null;
-		const data = nativePager.nextSync(fd);
+		const data = nativeReader.nextSync(fd);
 		if (!data) return null;
 		return data.toString("utf8").split(delimiter);
-	};
-	const close = async () => {
-		if (closed) return;
+	}
+	async function close() {
+		if (closed || !fd) return;
 		closed = true;
 		if (fd) {
 			try {
-				await nativePager.close(fd);
+				await nativeReader.close(fd);
 			} catch {}
 			fd = null;
 		}
-	};
+	}
 	function tryClose() {
 		close().catch(() => {});
 	}

package/dist/worker.cjs

@@ -4,10 +4,10 @@ let node_worker_threads = require("node:worker_threads");
 const { filepath, options } = node_worker_threads.workerData;
 const { chunkSize, pageSize, delimiter } = options;
 const backpressure = pageSize * 8;
-const post = (msg) => {
+function post(msg) {
 	if (!node_worker_threads.parentPort) process.exit(1);
 	node_worker_threads.parentPort.postMessage(msg);
-};
+}
 (async () => {
 	try {
 		const fd = await (0, node_fs_promises.open)(filepath, "r");

package/dist/worker.mjs

@@ -4,10 +4,10 @@ import { parentPort, workerData } from "node:worker_threads";
 const { filepath, options } = workerData;
 const { chunkSize, pageSize, delimiter } = options;
 const backpressure = pageSize * 8;
-const post = (msg) => {
+function post(msg) {
 	if (!parentPort) process.exit(1);
 	parentPort.postMessage(msg);
-};
+}
 (async () => {
 	try {
 		const fd = await open(filepath, "r");

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "readline-pager",
-  "version": "0.6.2",
+  "version": "0.6.5",
   "scripts": {
     "build:js": "tsdown",
     "build:native": "node-gyp rebuild",
     "build": "npm run build:native && npm run build:js",
-    "pkg:native": "node scripts/package-native.ts",
     "pretest": "npm run build",
-    "test": "TEST_CLEANUPS=1 node --test --experimental-test-coverage test/**/*.test.ts",
+    "test": "PAGER_TEST_CLEANUPS=1 node --test --experimental-test-coverage test/**/*.test.ts",
     "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",
@@ -24,10 +23,10 @@
     "typescript": "~6.0.2"
   },
   "optionalDependencies": {
-    "@devmor-j/readline-pager-linux-arm64": "0.6.2",
-    "@devmor-j/readline-pager-linux-musl-arm64": "0.6.2",
-    "@devmor-j/readline-pager-linux-musl-x64": "0.6.2",
-    "@devmor-j/readline-pager-linux-x64": "0.6.2"
+    "@devmor-j/readline-pager-linux-arm64": "0.6.5",
+    "@devmor-j/readline-pager-linux-musl-arm64": "0.6.5",
+    "@devmor-j/readline-pager-linux-musl-x64": "0.6.5",
+    "@devmor-j/readline-pager-linux-x64": "0.6.5"
   },
   "gypfile": false,
   "type": "module",