No support for streams v1; new method destroy

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v3.0.0 2018-02-03
+
+  * 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.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Piotr Roszatycki <piotr.roszatycki@gmail.com>
+Copyright (c) 2017-2018 Piotr Roszatycki <piotr.roszatycki@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -136,8 +136,16 @@ await promiseReadable.once('end')
 await promiseReadable.once('error') // undefined if already ended or throws error
 ```
 
+#### destroy
+
+```js
+promiseReadable.destroy()
+```
+
+This method calls `destroy` method on stream and cleans up all own handlers.
+
 ### License
 
-Copyright (c) 2017 Piotr Roszatycki <piotr.roszatycki@gmail.com>
+Copyright (c) 2017-2018 Piotr Roszatycki <piotr.roszatycki@gmail.com>
 
 [MIT](https://opensource.org/licenses/MIT)

examples/read-all.js

@@ -8,6 +8,7 @@ async function main () {
   const data = await rstream.readAll()
   if (data != null) {
     console.log(`Read ${data.length} bytes in total`)
+    rstream.destroy()
   }
 }
 

examples/read-by-chunks-ts.ts

@@ -2,19 +2,21 @@ import { PromiseReadable } from '../lib/promise-readable'
 
 import { createReadStream } from 'fs'
 
-type Maybe<T> = T | undefined
+type Chunk = Buffer | undefined
 
 async function main () {
   const rstream = new PromiseReadable(createReadStream(process.argv[2] || '/etc/hosts'))
 
   let total = 0
 
-  for (let chunk: Maybe<Buffer>; (chunk = await rstream.read());) {
+  for (let chunk: Chunk; (chunk = await rstream.read());) {
     console.info(`Read ${chunk.length} bytes chunk`)
     total += chunk.length
   }
 
   console.info(`Read ${total} bytes in total`)
+
+  rstream.destroy()
 }
 
 main().catch(console.error)

examples/read-by-chunks.js

@@ -5,12 +5,17 @@ const { createReadStream } = require('fs')
 
 async function main () {
   const rstream = new PromiseReadable(createReadStream(process.argv[2] || '/etc/hosts'))
+
   let total = 0
+
   for (let chunk; (chunk = await rstream.read());) {
     console.log(`Read ${chunk.length} bytes chunk`)
     total += chunk.length
   }
+
   console.log(`Read ${total} bytes in total`)
+
+  rstream.destroy()
 }
 
 main().catch(console.error)

examples/read-on-data-event.js → examples/read-once-end.js

@@ -4,14 +4,11 @@ var PromiseReadable = require('../lib/promise-readable').PromiseReadable
 var createReadStream = require('fs').createReadStream
 
 var rstream = new PromiseReadable(createReadStream(process.argv[2] || '/etc/hosts'))
-var total = 0
 
-rstream.stream.on('data', function (chunk) {
-  console.log('Read', chunk.length, 'bytes chunk')
-  total += chunk.length
-})
+rstream.stream.pipe(process.stdout)
 
 rstream.once('end')
 .then(function () {
-  console.log('Read', total, 'bytes in total')
+  console.log('-- End of file')
+  rstream.destroy()
 })

lib/promise-readable.d.ts

@@ -10,6 +10,8 @@ export declare class PromiseReadable<TReadable extends Readable> {
   read (size?: number): Promise<Buffer | undefined>
   readAll (): Promise<Buffer | undefined>
 
+  destroy (): void
+
   once (event: 'close' | 'end' | 'error'): Promise<void>
   once (event: 'open'): Promise<number>
 }