@types/readline-transform

Installation

npm install --save @types/readline-transform

Summary

This package contains type definitions for readline-transform (https://github.com/tilfin/readline-transform).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/readline-transform.

index.d.ts

/// <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;
}

export = ReadlineTransform;

Additional Details

• Last updated: Mon, 11 Nov 2024 18:36:31 GMT
• Dependencies: @types/node

Credits

These definitions were written by Piotr Roszatycki.