🚀 Big News:Socket Has Acquired Secure Annex.Learn More →
promise-readable
Advanced tools
promise-readable - npm Package Compare versions
+40
-36
| # Changelog | ||
| ## v3.1.4 2018-03-12 | ||
| * Use markdownlint. | ||
| ## v3.1.3 2018-02-05 | ||
| * Minor bugfix for `destroy`. | ||
| * Minor bugfix for `destroy`. | ||
| ## v3.1.2 2018-02-05 | ||
| * Can call `destroy` twice. | ||
| * Can call `destroy` twice. | ||
| ## v3.1.1 2018-02-04 | ||
| * Minor bugfix in README. | ||
| * Minor bugfix in README. | ||
| ## v3.1.0 2018-02-04 | ||
| * New method `setEncoding`. | ||
| * `read` and `readAll` methods can return `string` if encoding is set. | ||
| * Support `import PromiseReadable from 'promise-readable'` syntax. | ||
| * New method `setEncoding`. | ||
| * `read` and `readAll` methods can return `string` if encoding is set. | ||
| * Support `import PromiseReadable from 'promise-readable'` syntax. | ||
| ## v3.0.1 2018-02-04 | ||
| * Minor refactoring. | ||
| * Minor refactoring. | ||
| ## v3.0.0 2018-02-03 | ||
| * No support for streams v1. | ||
| * New method `destroy`. | ||
| * Bugfix when `PromiseReadable` could ignore `error` event. | ||
| * No support for streams v1. | ||
| * New method `destroy`. | ||
| * Bugfix when `PromiseReadable` could ignore `error` event. | ||
| ## v2.1.1 2018-01-18 | ||
| * `readAll` resumes the stream. | ||
| * `readAll` resumes the stream. | ||
| ## v2.1.0 2017-10-10 | ||
| * Typescript: PromiseReadable<TReadable extends Readable>. | ||
| * Typescript: `PromiseReadable<TReadable extends Readable>`. | ||
| ## v2.0.0 2017-10-06 | ||
| * Use native `Promise` rather than `any-event`. | ||
| * Use native `Promise` rather than `any-event`. | ||
| ## v1.2.1 2017-10-06 | ||
| * Typescript: reference additional modules in our typings file. | ||
| * Typescript: reference additional modules in our typings file. | ||
| ## v1.2.0 2017-10-03 | ||
| * `once` is resolved to `undefined` when stream is already closed or | ||
| destroyed for `"close"` or `"end"` events and rejects for others. | ||
| * `read` and `readAll` is resolved when `"close"` event was occured. | ||
| * `once` is resolved to `undefined` when stream is already closed or | ||
| destroyed for `"close"` or `"end"` events and rejects for others. | ||
| * `read` and `readAll` is resolved when `"close"` event was occured. | ||
| ## v1.1.0 2017-10-01 | ||
| * Typescript: stream is `TReadable extends NodeJS.ReadableStream` | ||
| * Typescript: stream is `TReadable extends NodeJS.ReadableStream` | ||
| ## v1.0.0 2017-09-28 | ||
| * Exports also as a class and namespace and the default. | ||
| * Typings for Typescript. | ||
| * Additional safe checks for detecting already closed stream. | ||
| * Exports also as a class and namespace and the default. | ||
| * Typings for Typescript. | ||
| * Additional safe checks for detecting already closed stream. | ||
| _Breaking change:_ | ||
| _Breaking change:_ | ||
| * Resolves to `undefined` rather than `null` if there is no data or stream is | ||
| * Resolves to `undefined` rather than `null` if there is no data or stream is | ||
| closed. Please use double sign equality instead triple sign to check if | ||
@@ -71,3 +75,3 @@ stream is closed, ie. `data == null`. | ||
| * Upgraded chai@4.0.2, chai-as-promised@7.0.0, snazzy@7.0.0 | ||
| * Upgraded chai@4.0.2, chai-as-promised@7.0.0, snazzy@7.0.0 | ||
| standard@10.0.2, tap@10.5.1, tap-given@0.4.1 | ||
@@ -77,34 +81,34 @@ | ||
| * Minor tweaks for documentation. | ||
| * Minor tweaks for documentation. | ||
| ## v0.4.1 2017-03-14 | ||
| * `once('error')` is the same as `once('end')`. | ||
| * `once('error')` is the same as `once('end')`. | ||
| ## v0.4.0 2017-03-14 | ||
| * New method `once` replaces other `once*` methods. | ||
| * New method `once` replaces other `once*` methods. | ||
| ## v0.3.0 2017-03-11 | ||
| * Method `end` is renamed to `onceEnd`. | ||
| * Method `end` is renamed to `onceEnd`. | ||
| ## v0.2.0 2017-03-11 | ||
| * Methods `onceOpen` and `onceClose` (with prefix). | ||
| * Methods `onceOpen` and `onceClose` (with prefix). | ||
| ## v0.1.0 2017-03-10 | ||
| * New methods `open` and `close` for `fs.ReadStream` streams. | ||
| * New methods `open` and `close` for `fs.ReadStream` streams. | ||
| ## v0.0.2 2017-03-09 | ||
| * Listen on `end` event rather than `close`. | ||
| * Use `stream.read()` if stream2 is available. | ||
| * Use `pause`/`resume` to be sure that `end` event won't be missed if stream1 | ||
| is available. | ||
| * Do not block on reading of already ended stream. | ||
| * Listen on `end` event rather than `close`. | ||
| * Use `stream.read()` if stream2 is available. | ||
| * Use `pause`/`resume` to be sure that `end` event won't be missed if stream1 | ||
| is available. | ||
| * Do not block on reading of already ended stream. | ||
| ## v0.0.1 2017-03-08 | ||
| * Initial release | ||
| * Initial release |
+4
-5
| { | ||
| "name": "promise-readable", | ||
| "version": "3.1.3", | ||
| "version": "3.1.4", | ||
| "description": "Return promise for readable stream", | ||
@@ -30,2 +30,3 @@ "main": "lib/promise-readable.js", | ||
| "chai-as-promised": "^7.1.1", | ||
| "markdownlint-cli": "^0.7.1", | ||
| "snazzy": "^7.0.0", | ||
@@ -40,9 +41,7 @@ "standard": "^10.0.3", | ||
| "scripts": { | ||
| "pretest": "standard --verbose | snazzy && tsc --noEmit --pretty && tslint -t stylish -p .", | ||
| "pretest": "standard --verbose | snazzy && tsc --noEmit --pretty && tslint -t stylish -p . && markdownlint *.md", | ||
| "test": "tap test/*.js", | ||
| "test:coverage": "npm test -- --coverage", | ||
| "test:onchange:lcovonly": "npm run -s test-coverage -- -R min --coverage-report lcovonly; onchange '**/*.js' -- npm run -s test-coverage -- -R min --coverage-report lcovonly", | ||
| "update": "npm run update:upgrade && npm run update:reinstall", | ||
| "update:upgrade": "ncu --upgrade --upgradeAll", | ||
| "update:reinstall": "rm -f package-lock.json && rm -rf node_modules && npm cache clear --force && npm install" | ||
| "update": "npm run update:upgrade && npm run update:reinstall" | ||
| }, | ||
@@ -49,0 +48,0 @@ "standard": { |
+16
-14
@@ -1,4 +0,6 @@ | ||
| ## promise-readable | ||
| # promise-readable | ||
| <!-- markdownlint-disable MD013 --> | ||
| [](http://travis-ci.org/dex4er/js-promise-readable) [](https://coveralls.io/github/dex4er/js-promise-readable) [](https://www.npmjs.com/package/promise-readable) | ||
| <!-- markdownlint-enable MD013 --> | ||
@@ -16,7 +18,7 @@ This module allows to convert | ||
| ### Requirements | ||
| ## Requirements | ||
| This module requires Node >= 4. | ||
| ### Installation | ||
| ## Installation | ||
@@ -27,5 +29,5 @@ ```shell | ||
| ### Usage | ||
| ## Usage | ||
| #### constructor | ||
| ### constructor | ||
@@ -58,3 +60,3 @@ ```js | ||
| #### stream | ||
| ### stream | ||
@@ -73,3 +75,3 @@ ```js | ||
| #### read | ||
| ### read | ||
@@ -102,3 +104,3 @@ ```js | ||
| #### readAll | ||
| ### readAll | ||
@@ -116,3 +118,3 @@ ```js | ||
| #### setEncoding | ||
| ### setEncoding | ||
@@ -139,3 +141,3 @@ ```js | ||
| #### once | ||
| ### once | ||
@@ -166,3 +168,3 @@ ```js | ||
| #### destroy | ||
| ### destroy | ||
@@ -175,3 +177,3 @@ ```js | ||
| ### See also | ||
| ## See also | ||
@@ -183,6 +185,6 @@ [`PromiseWritable`](https://www.npmjs.com/package/promise-writable), | ||
| ### License | ||
| ## License | ||
| Copyright (c) 2017-2018 Piotr Roszatycki <piotr.roszatycki@gmail.com> | ||
| Copyright (c) 2017-2018 Piotr Roszatycki <mailto:piotr.roszatycki@gmail.com> | ||
| [MIT](https://opensource.org/licenses/MIT) |
No alert changes
Improved metrics
- Number of lines in readme file
181
1.12%Worsened metrics
- Total package byte prevSize
15204
-0.49%- Dev dependency count
11
10%No dependency changes