Port stream.ts to TypeScript

This commit is contained in:
Hornwitser committed 2023-08-03 15:51:58 +02:00
1 parent dedb42447c
commit 2988cd962c
2 files changed
+46 -43

No files matched your search

+1
View File
@@ -34,6 +34,7 @@
"access": "public" "access": "public"
}, },
"devDependencies": { "devDependencies": {
"@types/fs-extra": "^11.0.1",
"@types/node": "^20.4.5", "@types/node": "^20.4.5",
"typescript": "^5.1.6" "typescript": "^5.1.6"
} }
@@ -1,7 +1,7 @@
"use strict"; "use strict";
const assert = require("assert"); import assert from "assert";
const fs = require("fs-extra"); import fs from "fs-extra";
const stream = require("stream"); import stream from "stream";
/** /**
@@ -11,20 +11,17 @@ const stream = require("stream");
* one removing the line feed and optional carriage return from the lines. * one removing the line feed and optional carriage return from the lines.
* *
* @example * @example
* let lineStream = new libStream.LineSplitter({ readableObjectMode: true }); * ```ts
* let lineStream = new lib.LineSplitter({ readableObjectMode: true });
* lineStream.on("data", line => { console.log(line.toString("utf8")); }); * lineStream.on("data", line => { console.log(line.toString("utf8")); });
* let fileStream = fs.createReadStream(path); * let fileStream = fs.createReadStream(path);
* fileStream.pipe(lineStream); * fileStream.pipe(lineStream);
* * ```
* @memberof module:lib
*/ */
class LineSplitter extends stream.Transform { export class LineSplitter extends stream.Transform {
constructor(options) { _partial: Buffer | null = null;
super(options);
this._partial = null;
}
_transform(chunk, encoding, callback) { _transform(chunk: Buffer, _encoding: string, callback: stream.TransformCallback) {
if (this._partial) { if (this._partial) {
chunk = Buffer.concat([this._partial, chunk]); chunk = Buffer.concat([this._partial, chunk]);
this._partial = null; this._partial = null;
@@ -43,14 +40,14 @@ class LineSplitter extends stream.Transform {
end -= 1; end -= 1;
} }
let line = chunk.slice(0, end); let line = chunk.subarray(0, end);
chunk = chunk.slice(next); chunk = chunk.subarray(next);
this.push(line); this.push(line);
} }
callback(); callback();
} }
_flush(callback) { _flush(callback: stream.TransformCallback) {
if (this._partial) { if (this._partial) {
this.push(this._partial); this.push(this._partial);
this._partial = null; this._partial = null;
@@ -63,25 +60,22 @@ class LineSplitter extends stream.Transform {
* Transform splitting a reverse stream into lines * Transform splitting a reverse stream into lines
* *
* Splits up a reverse stream of chunks created by {@link * Splits up a reverse stream of chunks created by {@link
* module:lib.createReverseReadStream} by newlines and passes on the * createReverseReadStream} by newlines and passes on the
* lines one by one in reverse order removing the line feed and optional * lines one by one in reverse order removing the line feed and optional
* carriage return from the lines. * carriage return from the lines.
* *
* @example * @example
* let revLineStream = new libStream.ReverseLineSplitter({ readableObjectMode: true }); * ```ts
* let revLineStream = new lib.ReverseLineSplitter({ readableObjectMode: true });
* revLineStream.on("data", line => { console.log(line.toString("utf8")); }); * revLineStream.on("data", line => { console.log(line.toString("utf8")); });
* let revFileStream = await libStream.createReverseReadStream(path); * let revFileStream = await lib.createReverseReadStream(path);
* revFileStream.pipe(revLineStream); * revFileStream.pipe(revLineStream);
* * ```
* @memberof module:lib
*/ */
class ReverseLineSplitter extends stream.Transform { export class ReverseLineSplitter extends stream.Transform {
constructor(options) { _partial: Buffer | null = null;
super(options);
this._partial = null;
}
_transform(chunk, encoding, callback) { _transform(chunk: Buffer, _encoding: string, callback: stream.TransformCallback) {
if (this._partial) { if (this._partial) {
chunk = Buffer.concat([chunk, this._partial]); chunk = Buffer.concat([chunk, this._partial]);
this._partial = null; this._partial = null;
@@ -103,14 +97,14 @@ class ReverseLineSplitter extends stream.Transform {
} }
} }
let line = chunk.slice(next + 1, end + 1); let line = chunk.subarray(next + 1, end + 1);
chunk = chunk.slice(0, next + 1); chunk = chunk.subarray(0, next + 1);
this.push(line); this.push(line);
} }
callback(); callback();
} }
_flush(callback) { _flush(callback: stream.TransformCallback) {
if (this._partial) { if (this._partial) {
let end = this._partial.length - 1; let end = this._partial.length - 1;
if (this._partial[end] === "\n".charCodeAt(0)) { if (this._partial[end] === "\n".charCodeAt(0)) {
@@ -120,7 +114,7 @@ class ReverseLineSplitter extends stream.Transform {
end -= 1; end -= 1;
} }
} }
this.push(this._partial.slice(0, end + 1)); this.push(this._partial.subarray(0, end + 1));
this._partial = null; this._partial = null;
} }
callback(); callback();
@@ -128,6 +122,8 @@ class ReverseLineSplitter extends stream.Transform {
} }
type ReadStreamOptions = Parameters<typeof fs.createReadStream>[1];
/** /**
* Create a file read stream running in reverse * Create a file read stream running in reverse
* *
@@ -136,19 +132,28 @@ class ReverseLineSplitter extends stream.Transform {
* are not reversed, thus the file content can be recreated by concatenating * are not reversed, thus the file content can be recreated by concatenating
* the chunks together in the reverse order they are read. * the chunks together in the reverse order they are read.
* *
* @param {string} path - * @param path -
* Path to file to open. May be anything accepted by fs.open. * Path to file to open. May be anything accepted by fs.open.
* @param {object} options - * @param options -
* Options to pass to fs.createReadStream. Values passed for `fd` and * Options to pass to fs.createReadStream. Values passed for `fd` and
* `fs` will be ignored. * `fs` will be ignored.
* @memberof module:lib
*/ */
async function createReverseReadStream(path, options) { export async function createReverseReadStream(path: string, options: ReadStreamOptions) {
if (typeof options === "string") {
options = { encoding: options };
}
const fileFd = await fs.open(path, "r"); const fileFd = await fs.open(path, "r");
const fileSize = (await fs.fstat(fileFd)).size; const fileSize = (await fs.fstat(fileFd)).size;
let filePosition = fileSize; let filePosition = fileSize;
const reverseFs = { const reverseFs = {
read(fd, buffer, offset, length, position, callback) { read(
fd: number,
buffer: Buffer,
offset: number,
length: number,
position: number,
callback: () => void,
) {
assert(fd === fileFd); assert(fd === fileFd);
assert(position === undefined); assert(position === undefined);
length = Math.min(length, filePosition); length = Math.min(length, filePosition);
@@ -156,13 +161,10 @@ async function createReverseReadStream(path, options) {
return fs.read(fd, buffer, offset, length, filePosition, callback); return fs.read(fd, buffer, offset, length, filePosition, callback);
}, },
open() { assert(false); }, open() { assert(false); },
close(fd, callback) { return fs.close(fd, callback); }, close(fd: number, callback: () => void) { return fs.close(fd, callback); },
}; };
return fs.createReadStream("", { ...options, fd: fileFd, fs: reverseFs }); return fs.createReadStream(
"",
{ ...options, fd: fileFd, fs: reverseFs } as ReadStreamOptions, // type specification is missing fs prop.
);
} }
module.exports = {
LineSplitter,
ReverseLineSplitter,
createReverseReadStream,
};