stream-via

WebJar for stream-via

License	MIT
GroupId	org.webjars.npm
ArtifactId	stream-via
Last Version	1.0.4
Release Date	Jul 31, 2017
Type	jar
Description	stream-via WebJar for stream-via
Project URL	http://webjars.org
Source Code Management	https://github.com/75lb/stream-via

Download stream-via

Filename	Size
stream-via-1.0.4.pom
stream-via-1.0.4.jar	8 KB
stream-via-1.0.4-sources.jar	22 bytes
stream-via-1.0.4-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/stream-via/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>stream-via</artifactId>
    <version>1.0.4</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/stream-via/
implementation 'org.webjars.npm:stream-via:1.0.4'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/stream-via/
implementation ("org.webjars.npm:stream-via:1.0.4")

Apache Buildr

'org.webjars.npm:stream-via:jar:1.0.4'

Apache Ivy

<dependency org="org.webjars.npm" name="stream-via" rev="1.0.4">
  <artifact name="stream-via" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='stream-via', version='1.0.4')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "stream-via" % "1.0.4"

Leiningen

[org.webjars.npm/stream-via "1.0.4"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

stream-via

Process each chunk of a stream via the supplied function. Useful for meddling inside a stream pipeline. Works in both string/Buffer and object modes.

Synopsis

Replace all instances of the a character with 4.

const via = require('stream-via')
const fs = require('fs')

process.stdin
  .pipe(via(function (chunk) {
    return chunk.toString().replace(/a/g, '4')
  }))
  .pipe(process.stdout)

Output:

$ echo 'twat' | node example/simple.js
tw4t

API

stream-via

• stream-via
  • via(throughFunction, [options]) ⇒ Duplex ⏏
    • .async(throughFunction, [options]) ⇒ Duplex
    • ~throughFunction : function

via(throughFunction, [options]) ⇒ Duplex ⏏

Kind: Exported function
Params

• throughFunction throughFunction - a function to process each chunk
• [options] object - passed to the returned stream constructor

via.async(throughFunction, [options]) ⇒ Duplex

Kind: static method of via
Params

• throughFunction throughFunction - a function to process each chunk
• [options] object - passed to the returned stream constructor

via~throughFunction : function

Kind: inner typedef of via
Params

• chunk buffer | string
• enc string
• done function - only used in via.async, call it like so: done(err, returnValue).

---

© 2015-17 Lloyd Brookes <[email protected]>. Documented by jsdoc-to-markdown.

Versions

Version
1.0.4 Jul 31, 2017
1.0.3 Jul 30, 2017
0.1.0 Jul 26, 2017