diff --git a/types/readline-transform/index.d.ts b/types/readline-transform/index.d.ts new file mode 100644 index 0000000000..ec1ce8b56c --- /dev/null +++ b/types/readline-transform/index.d.ts @@ -0,0 +1,21 @@ +// Type definitions for readline-transform 0.9 +// Project: https://github.com/tilfin/readline-transform +// Definitions by: Piotr Roszatycki +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/// + +import { Transform, TransformOptions } from 'stream'; + +export interface ReadlineTransformOptions extends TransformOptions { + /** line break matcher for str.split() (default: /\r?\n/) */ + breakMatcher?: RegExp; + /** if content ends with line break, ignore last empty line (default: true) */ + ignoreEndOfBreak?: boolean; + /** if line is empty string, skip it (default: false) */ + skipEmpty?: boolean; +} + +export default class ReadlineTransform extends Transform { + constructor(options?: ReadlineTransformOptions); +} diff --git a/types/readline-transform/readline-transform-tests.ts b/types/readline-transform/readline-transform-tests.ts new file mode 100644 index 0000000000..9c343bd352 --- /dev/null +++ b/types/readline-transform/readline-transform-tests.ts @@ -0,0 +1,12 @@ +import { PassThrough } from 'stream'; +import ReadlineTransform from 'readline-transform'; + +const readStream = new PassThrough(); +const transform = new ReadlineTransform({ + breakMatcher: /\n/, + ignoreEndOfBreak: false, + skipEmpty: true +}); +const writeStream = new PassThrough({ objectMode: true }); + +readStream.pipe(transform).pipe(writeStream); diff --git a/types/readline-transform/tsconfig.json b/types/readline-transform/tsconfig.json new file mode 100644 index 0000000000..76521c5b6a --- /dev/null +++ b/types/readline-transform/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "esModuleInterop": true, + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "readline-transform-tests.ts" + ] +} diff --git a/types/readline-transform/tslint.json b/types/readline-transform/tslint.json new file mode 100644 index 0000000000..2750cc0197 --- /dev/null +++ b/types/readline-transform/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } \ No newline at end of file