From 4f7ef19cc76baad6ec000012bcd45f95290bf67d Mon Sep 17 00:00:00 2001 From: Piotr Roszatycki Date: Mon, 5 Feb 2018 21:25:49 +0100 Subject: [PATCH 1/2] New typings for readline-transform --- types/readline-transform/index.d.ts | 25 +++++++++++++++++++ .../readline-transform-tests.ts | 12 +++++++++ types/readline-transform/tsconfig.json | 23 +++++++++++++++++ types/readline-transform/tslint.json | 6 +++++ 4 files changed, 66 insertions(+) create mode 100644 types/readline-transform/index.d.ts create mode 100644 types/readline-transform/readline-transform-tests.ts create mode 100644 types/readline-transform/tsconfig.json create mode 100644 types/readline-transform/tslint.json diff --git a/types/readline-transform/index.d.ts b/types/readline-transform/index.d.ts new file mode 100644 index 0000000000..d2593055a1 --- /dev/null +++ b/types/readline-transform/index.d.ts @@ -0,0 +1,25 @@ +// 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'; + +declare namespace ReadlineTransform { + interface Options 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; + } +} + +declare class ReadlineTransform extends Transform { + constructor(options?: ReadlineTransform.Options); +} + +export = ReadlineTransform; diff --git a/types/readline-transform/readline-transform-tests.ts b/types/readline-transform/readline-transform-tests.ts new file mode 100644 index 0000000000..fc2b3e0e3a --- /dev/null +++ b/types/readline-transform/readline-transform-tests.ts @@ -0,0 +1,12 @@ +import { PassThrough } from 'stream'; +import ReadlineTransform = require('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..2e76497489 --- /dev/null +++ b/types/readline-transform/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "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..bc469d1af1 --- /dev/null +++ b/types/readline-transform/tslint.json @@ -0,0 +1,6 @@ +{ + "extends": "dtslint/dt.json", + "rules": { + "strict-export-declare-modifiers": false + } +} \ No newline at end of file From de15475529b79c9f48b90ed994f462b590b4b654 Mon Sep 17 00:00:00 2001 From: Piotr Roszatycki Date: Thu, 8 Feb 2018 13:15:20 +0100 Subject: [PATCH 2/2] Typings with esModuleInterop enabled --- types/readline-transform/index.d.ts | 22 ++++++++----------- .../readline-transform-tests.ts | 2 +- types/readline-transform/tsconfig.json | 1 + types/readline-transform/tslint.json | 7 +----- 4 files changed, 12 insertions(+), 20 deletions(-) diff --git a/types/readline-transform/index.d.ts b/types/readline-transform/index.d.ts index d2593055a1..ec1ce8b56c 100644 --- a/types/readline-transform/index.d.ts +++ b/types/readline-transform/index.d.ts @@ -7,19 +7,15 @@ import { Transform, TransformOptions } from 'stream'; -declare namespace ReadlineTransform { - interface Options 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 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; } -declare class ReadlineTransform extends Transform { - constructor(options?: ReadlineTransform.Options); +export default class ReadlineTransform extends Transform { + constructor(options?: ReadlineTransformOptions); } - -export = ReadlineTransform; diff --git a/types/readline-transform/readline-transform-tests.ts b/types/readline-transform/readline-transform-tests.ts index fc2b3e0e3a..9c343bd352 100644 --- a/types/readline-transform/readline-transform-tests.ts +++ b/types/readline-transform/readline-transform-tests.ts @@ -1,5 +1,5 @@ import { PassThrough } from 'stream'; -import ReadlineTransform = require('readline-transform'); +import ReadlineTransform from 'readline-transform'; const readStream = new PassThrough(); const transform = new ReadlineTransform({ diff --git a/types/readline-transform/tsconfig.json b/types/readline-transform/tsconfig.json index 2e76497489..76521c5b6a 100644 --- a/types/readline-transform/tsconfig.json +++ b/types/readline-transform/tsconfig.json @@ -4,6 +4,7 @@ "lib": [ "es6" ], + "esModuleInterop": true, "noImplicitAny": true, "noImplicitThis": true, "strictFunctionTypes": true, diff --git a/types/readline-transform/tslint.json b/types/readline-transform/tslint.json index bc469d1af1..2750cc0197 100644 --- a/types/readline-transform/tslint.json +++ b/types/readline-transform/tslint.json @@ -1,6 +1 @@ -{ - "extends": "dtslint/dt.json", - "rules": { - "strict-export-declare-modifiers": false - } -} \ No newline at end of file +{ "extends": "dtslint/dt.json" } \ No newline at end of file