stream.finished - npm Package Compare versions

Comparing version 1.1.2 to 1.2.0

CHANGELOG.md

 # Changelog
 
+## v1.2.0 2019-05-08
+
+* Support for promisify in Typescript.
+
 ## v1.1.2 2019-05-08
@@ -4,0 +8,0 @@

index.d.ts

@@ -7,11 +7,12 @@ /// <reference types="node" />
   stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream,
-  callback: (err?: NodeJS.ErrnoException) => void
+  callback: (err?: NodeJS.ErrnoException | null) => void
 ): () => void;
 
 declare namespace finished {
-  export function getPolyfill(): typeof finished;
-  export const implementation: typeof finished;
-  export function shim(): typeof finished;
+  function __promisify__(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream): Promise<void>;
+  function getPolyfill(): typeof finished;
+  const implementation: typeof finished;
+  function shim(): typeof finished;
 }
 
 export = finished;

package.json

 {
   "name": "stream.finished",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Polyfill/shim for stream.finished in node versions < v10",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -20,2 +20,14 @@ # stream.finished
 
+## Installation
+
+```shell
+npm install stream.finished
+```
+
+_Additionally for Typescript:_
+
+```shell
+npm install -D @types/node
+```
+
 ## Usage
@@ -30,2 +42,9 @@
 
+_Typescript:_
+
+```ts
+import finished from 'stream.finished';
+// Use `finished` just like the built-in method on `stream`
+```
+
 ### Shim
@@ -48,1 +67,30 @@
 ```
+
+_Typescript:_
+
+```js
+import finishedShim from 'stream.finished/shim';
+finishedShim();
+// `stream.finished` is now defined
+import stream from 'stream';
+// Use `stream.finished`
+```
+
+or:
+
+```js
+import 'stream.finished/auto';
+// `stream.finished` is now defined
+import stream from 'stream';
+// Use `stream.finished`
+```
+
+## License
+
+Copyright (c) 2018-2019 Piotr Roszatycki <[e-mail]>
+
+Copyright Node.js contributors. All rights reserved.
+
+Copyright (c) 2014 Mathias Buus
+
+[MIT](https://opensource.org/licenses/MIT)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10542

increased by10.01%

Lines of code

166

increased by0.61%

Number of lines in readme file

94

increased by104.35%

No dependency changes