Socket
Book a DemoInstallSign in
Socket

stream-write

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

stream-write

Write to a stream promise style

Source
npmnpm
Version
2.0.0
Version published
Weekly downloads
251
79.29%
Maintainers
1
Weekly downloads
 
Created
Source

stream-write

Write to streams, respecting backpressure.

build status

Example

Write random numbers to an http response until it ends:

var write = require('stream-write');
var http = require('http');

http.createServer(function(req, res){
  (async function (){
    while (true) {
      const open = await write(res, ''+Math.random())
      if (!open) break
    }
  })().catch(console.error);
}).listen(8000);

write(stream, chunk)

Write chunk to stream and returns a Promise that is resolved once stream is writable again, or rejects if an error happened.

The promise's resolved value is false when stream ended and you should stop writing to it.

HTTP special casing

When an HTTP request ended, the HTTP response stays writable, only it's underlying socket closes. To stay consistent with other streams' behavior, in that case write() will throw an error itself.

Installation

$ npm install stream-write

License

MIT

FAQs

Package last updated on 22 Oct 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts