# self-stream

> self-stream is a small node module that streams your transformations to the same file.

Latest version **1.1.1** (published 2016-07-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install self-stream
pnpm add self-stream
yarn add self-stream
bun add self-stream
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2016-07-14 |
| First published | 2016-04-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Tomas Della Vedova - @delvedor |
| Maintainers | delvedor |
| Keywords | self, file, stream, transform, single, same, change |

## Links

- npm: https://www.npmjs.com/package/self-stream
- Repository: https://github.com/delvedor/self-stream
- Homepage: https://github.com/delvedor/self-stream#readme
- Issues: https://github.com/delvedor/self-stream/issues
- npm.io page: https://npm.io/package/self-stream

## Dependencies (1)

- [pump](https://npm.io/package/pump.md) ^1.0.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.1.1 (latest) — 2016-07-14
- 1.1.0 — 2016-04-17
- 1.0.0 — 2016-04-15

## README

# self-stream
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) [![Build Status](https://travis-ci.org/delvedor/self-stream.svg?branch=master)](https://travis-ci.org/delvedor/self-stream)

Sometimes you need to change something in a file and probably you will do:
```javascript
const fs = require('fs')
fs.readFile('file.md', 'utf8', (readErr, data) => {
  if (readErr) return console.log(readErr)
  data = changeSomething(data)
  fs.writeFile('file.md', data, 'utf8', (writeErr) => {
    if (writeErr) return console.log(writeErr)
    console.log('done')
  })
})
```
And that's not a good thing, because you are loading the entire file in your working memory slowing down your application.  
In the magic world of Nodejs for avoid this problem you can use streams.
But as you probably know with streams you cannot read, transform and write the same file.  
Here come to help **self-stream**, an "hack" solution to this problem.  
The solution is not in-place, because in case of something fails during the transform process, you will not lose the original file.

**Needs Node.js >= 4.4.1**  
If are using **4.4.1 <= Node.js < 5** you need ***--es_staging*** flag

## Install
```
$ npm install self-stream --save
```
## API

#### selfStream(filename, transform, callback)
*filename*: the file to change with the relative path  
*transform*: is a function or an array of functions with all the transforms  
*callback*: callback function  

### Example:
```javascript
const selfStream = require('self-stream')
const through2 = require('through2')

const transform = through2(function (chunk, enc, cb) {
  for (var i = 0; i < chunk.length; i++) {
    if (chunk[i] === 97) chunk[i] = 122 // swap 'a' for 'z'
  }
  this.push(chunk)
  cb()
})

selfStream('file.md', transform, function (err) {
  if (err) return console.log(err)
})

```

As you can see in the [source code](https://github.com/delvedor/self-stream/blob/master/selfStream.js) self-stream uses pump to pipe all the streams and at the end it will rewrite the original file with the modified one.

## Contributing
If you feel you can help in any way, be it with examples, extra testing, or new features please open a pull request or open an issue.

The code follows the Standard code style.  
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
______________________________________________________________________________________________________________________
## License
The code is released under the MIT license.

The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non infringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

---
_Source: https://npm.io/package/self-stream · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
