read-all-stream

WebJar for read-all-stream

License	MIT
GroupId	org.webjars.npm
ArtifactId	read-all-stream
Last Version	3.0.0
Release Date	Aug 29, 2015
Type	jar
Description	read-all-stream WebJar for read-all-stream
Project URL	http://webjars.org
Source Code Management	https://github.com/floatdrop/read-all-stream

Download read-all-stream

Filename	Size
read-all-stream-3.0.0.pom
read-all-stream-3.0.0.jar	5 KB
read-all-stream-3.0.0-sources.jar	22 bytes
read-all-stream-3.0.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/read-all-stream/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>read-all-stream</artifactId>
    <version>3.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/read-all-stream/
implementation 'org.webjars.npm:read-all-stream:3.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/read-all-stream/
implementation ("org.webjars.npm:read-all-stream:3.0.0")

Apache Buildr

'org.webjars.npm:read-all-stream:jar:3.0.0'

Apache Ivy

<dependency org="org.webjars.npm" name="read-all-stream" rev="3.0.0">
  <artifact name="read-all-stream" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='read-all-stream', version='3.0.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "read-all-stream" % "3.0.0"

Leiningen

[org.webjars.npm/read-all-stream "3.0.0"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : pinkie-promise	jar	[1.0.0,2)
org.webjars.npm : readable-stream	jar	[2.0.0,3)

Project Modules

There are no modules declared in this project.

read-all-stream

Read stream to buffer or string

Install

$ npm install --save read-all-stream

Usage

var read = require('read-all-stream');
var stream = fs.createReadStream('index.js');

read(stream).then(function (data) {
	console.log(data.length);
});

read(stream, 'utf8', function (err, data) {
	console.log(data.length);
	//=> 42
});

API

read(stream, [options], [callback])

If callback is omitted, Promise will be returned.

stream

Required
Type: Stream

Event emitter, which data events will be consumed.

options

Type: object or string

If type of options is string, then it will be used as encoding. If type is Object, then next options are available:

options.encoding

Type: string, null
Default: 'utf8'

Encoding to be used on toString of the data. If null, the body is returned as a Buffer.

callback(err, data)

Will be called after stream is read.

err

Error object (if error event happens).

data

The data in stream.

License

MIT © Vsevolod Strukchinsky

Versions

Version
3.0.0 Aug 29, 2015