readline-transform/index.d.ts

Transform stream to read line-by-line and write a string

/// <reference types="node" />

import { Transform, TransformOptions } from "stream";

declare namespace ReadlineTransform {
    interface ReadlineTransformOptions extends TransformOptions {
        /**
         * line break matcher for str.split()
         * @default /\r?\n/
         */
        breakMatcher?: RegExp | undefined;

        /**
         * if content ends with line break, ignore last empty line
         * @default true
         */

        ignoreEndOfBreak?: boolean | undefined;
        /**
         * if line is empty string, skip it
         * @default false
         */
        skipEmpty?: boolean | undefined;
    }
}

declare class ReadlineTransform extends Transform {
    constructor(options?: ReadlineTransform.ReadlineTransformOptions);

    static default: typeof ReadlineTransform;
    static ReadlineTransform: typeof ReadlineTransform;
}

export = ReadlineTransform;