Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 3.73 KB

README.md

File metadata and controls

67 lines (45 loc) · 3.73 KB
Raw

CI browser tests NPM version npm downloads Known Vulnerabilities Codacy Badge Coverage Status Minified size

readable-web-to-node-stream

Converts a Web-API readable stream into a Node.js readable stream.

Installation

Install via npm:

npm install readable-web-to-node-stream

or yarn:

yarn add readable-web-to-node-stream

Compatibility

Source is written in TypeScript and compiled to ECMAScript 2017 (ES8).

Unit tests are performed on the following browsers:

  • Latest Google Chrome 74.0

Example

Import readable-web-stream-to-node in JavaScript:

const {ReadableWebToNodeStream} = require('readable-web-to-node-stream');

async function download(url) {
    const response = await fetch(url);
    const readableWebStream = response.body;
    const nodeStream = new ReadableWebToNodeStream(readableWebStream);
}

API

constructor(stream: ReadableStream): Promise

stream: ReadableStream: the Web-API readable stream.

close(): Promise Will cancel close the Readable-node stream, and will release Web-API-readable-stream.

waitForReadToComplete(): Promise If there is no unresolved read call to Web-API Readable​Stream immediately returns, otherwise it will wait until the read is resolved.

Licence

(The MIT License)

Copyright (c) 2019 Borewit

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 the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.