Skip to content

Commit

Permalink
Improve "Transform streams" documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mantoni committed Jun 29, 2018
1 parent 281934c commit eca4548
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,16 +138,13 @@ project.

## Transform streams

Transform streams can be used to alter the data before passing it on. In the
usage example above, `Stringify` and `Format` are transform streams.

For example, [Studio Log X][7] is a Transform stream that can remove
confidential properties from the log data and [Studio Log Format][6] project
implements the `basic`, `fancy` and `console` pretty printers.
Transform streams can be used to alter the data before passing it on. For
example, [Studio Log X][7] is a Transform stream that can remove confidential
data from the log data and [Studio Log Format][6] project implements the
`basic`, `fancy` and `console` pretty printers.

Format transforms are [node transform streams][3] in `writableObjectMode`. Here
is an example transform implementation, similar to the [ndjson stringify
transform][5]:
is an example implementation, similar to the [ndjson stringify transform][5]:

```js
const { Transform } = require('stream');
Expand Down

0 comments on commit eca4548

Please sign in to comment.