flush-write-stream

WebJar for flush-write-stream

License	MIT
GroupId	org.webjars.npm
ArtifactId	flush-write-stream
Last Version	1.1.1
Release Date	Mar 21, 2019
Type	jar
Description	flush-write-stream WebJar for flush-write-stream
Project URL	http://webjars.org
Source Code Management	https://github.com/mafintosh/flush-write-stream

Download flush-write-stream

Filename	Size
flush-write-stream-1.1.1.pom
flush-write-stream-1.1.1.jar	6 KB
flush-write-stream-1.1.1-sources.jar	22 bytes
flush-write-stream-1.1.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/flush-write-stream/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>flush-write-stream</artifactId>
    <version>1.1.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/flush-write-stream/
implementation 'org.webjars.npm:flush-write-stream:1.1.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/flush-write-stream/
implementation ("org.webjars.npm:flush-write-stream:1.1.1")

Apache Buildr

'org.webjars.npm:flush-write-stream:jar:1.1.1'

Apache Ivy

<dependency org="org.webjars.npm" name="flush-write-stream" rev="1.1.1">
  <artifact name="flush-write-stream" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='flush-write-stream', version='1.1.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "flush-write-stream" % "1.1.1"

Leiningen

[org.webjars.npm/flush-write-stream "1.1.1"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : inherits	jar	[2.0.3,3)
org.webjars.npm : readable-stream	jar	[2.3.6,3)

Project Modules

There are no modules declared in this project.

flush-write-stream

A write stream constructor that supports a flush function that is called before finish is emitted

npm install flush-write-stream

Usage

var writer = require('flush-write-stream')

var ws = writer(write, flush)

ws.on('finish', function () {
  console.log('finished')
})

ws.write('hello')
ws.write('world')
ws.end()

function write (data, enc, cb) {
  // i am your normal ._write method
  console.log('writing', data.toString())
  cb()
}

function flush (cb) {
  // i am called before finish is emitted
  setTimeout(cb, 1000) // wait 1 sec
}

If you run the above it will produce the following output

writing hello
writing world
(nothing happens for 1 sec)
finished

API

var ws = writer([options], write, [flush])

Create a new writable stream. Options are forwarded to the stream constructor.

var ws = writer.obj([options], write, [flush])

Same as the above except objectMode is set to true per default.

License

MIT

Versions

Version
1.1.1 Mar 21, 2019
1.0.3 Apr 23, 2018
1.0.2 Feb 13, 2018
1.0.0 Jan 17, 2018