Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ coverage

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release
example/ts-cjs/dist/
example/ts-esm/dist/

# Dependency directories
node_modules
Expand Down
4 changes: 2 additions & 2 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
coverage
example
test
.gitignore
.github
.*
*.tgz
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ $ npm install -save readline-transform

```javascript
const { PassThrough } = require('stream');
const ReadlineTransform = require('readline-transform');
const { ReadlineTransform } = require('readline-transform');

const readStream = new PassThrough();
const transform = new ReadlineTransform({ skipEmpty: true });
Expand Down
3 changes: 2 additions & 1 deletion example/example.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const { PassThrough } = require('stream');
const ReadlineTransform = require('../');
const { ReadlineTransform } = require('../');
//const ReadlineTransform = require('../');

const readStream = new PassThrough();
const transform = new ReadlineTransform({ skipEmpty: true });
Expand Down
1 change: 1 addition & 0 deletions example/example.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import fs from 'node:fs';
import { PassThrough } from 'node:stream';
import { ReadlineTransform } from '../index.mjs';
//import ReadlineTransform from '../index.mjs';

const transform = new ReadlineTransform({ skipEmpty: true });
const fileStream = fs.createReadStream('./data.txt');
Expand Down
34 changes: 34 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/// <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;
1 change: 1 addition & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,4 @@ class ReadlineTransform extends Transform {
}

module.exports = exports.default = ReadlineTransform;
module.exports.ReadlineTransform = ReadlineTransform;
2 changes: 1 addition & 1 deletion index.mjs
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export { default as ReadlineTransform } from './index.js';
export { ReadlineTransform, default } from './index.js';
8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
{
"name": "readline-transform",
"version": "1.0.0",
"version": "2.0.0",
"description": "Transform stream to read line-by-line and write a string",
"main": "index.js",
"types": "index.d.ts",
"exports": {
".": {
"import": "./index.mjs",
"import": {
"default": "./index.mjs",
"types": "./index.d.ts"
},
"require": "./index.js"
}
},
Expand Down