# streamp

> mkdir -p combined with streams.

Latest version **3.0.3** (published 2025-02-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install streamp
pnpm add streamp
yarn add streamp
bun add streamp
```

## Health

**Score 15/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

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

Negative: stale; low maintenance score; declining downloads.

## Facts

| | |
|---|---|
| Version | 3.0.3 |
| Published | 2025-02-14 |
| First published | 2015-03-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ionică Bizău |
| Maintainers | ionicabizau |
| Keywords | stream, file, mkdirp |

## Links

- npm: https://www.npmjs.com/package/streamp
- Repository: https://github.com/IonicaBizau/node-streamp
- Issues: https://github.com/IonicaBizau/node-streamp/issues
- npm.io page: https://npm.io/package/streamp

## Dependencies (2)

- [ul](https://npm.io/package/ul.md) ^5.0.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0

## 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

- 3.0.3 (latest) — 2025-02-14
- 3.0.2 — 2020-08-09
- 3.0.1 — 2019-11-24
- 2.2.9 — 2019-01-03
- 2.2.8 — 2017-09-08
- 2.2.7 — 2017-03-20
- 2.2.6 — 2017-01-02
- 2.2.5 — 2016-10-11
- 2.2.4 — 2016-10-11
- 2.2.3 — 2016-05-25
- 2.2.2 — 2016-04-26
- 2.2.1 — 2016-01-14
- 2.2.0 — 2015-12-03
- 2.1.0 — 2015-11-12
- 2.0.0 — 2015-09-15
- … 1 more at https://npm.io/package/streamp/versions

## README

<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


















# streamp

 [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/streamp.svg)](https://www.npmjs.com/package/streamp) [![Downloads](https://img.shields.io/npm/dt/streamp.svg)](https://www.npmjs.com/package/streamp) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>







> mkdir -p combined with streams.

















## :cloud: Installation

```sh
# Using npm
npm install --save streamp

# Using yarn
yarn add streamp
```













## :clipboard: Example



```js
// Dependencies
const Streamp = require("streamp")

// Constants
const PATH = __dirname + "/long/path/to/foo.txt"

// Create writable stream
const bar = new Streamp.writable(PATH)
bar.write(new Date().toString() + "\n")
bar.end()

// Create readable stream
const foo = new Streamp.readable(PATH)
foo.pipe(process.stdout)
```












## :question: Get Help

There are few ways to get help:



 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
 2. For bug reports and feature requests, open issues. :bug:
 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:







## :memo: Documentation


### `readable(options)`
Creates a readable stream in the specified path (which will be created if doesn't exist).

#### Params

- **String|Object** `options`: The path to the file or an object containing the following fields:
 - `path` (String): The file path.
 - `flags` (String): The stream flags (default: `"a"`).
 - `options` (Object): Additional options which are passed when the stream is created.

#### Return
- **Stream** The readable stream that was created.

### `writable(options)`
Creates a writable stream in the specified path (which will be created if doesn't exist).

#### Params

- **String|Object** `options`: The path to the file or an object containing the following fields:
 - `path` (String): The file path.
 - `flags` (String): The stream flags (default: `"a"`).
 - `options` (Object): Additional options which are passed when the stream is created.

#### Return
- **Stream** The writable stream that was created.














## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].


## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:


 - Starring and sharing the projects you like :rocket:
 - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
 - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
 - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
 - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`

    ![](https://i.imgur.com/z6OQI95.png)


Thanks! :heart:
















## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

 - `blah`
 - `csv-it`
 - `github-colors`
 - `google-font-downloader`
 - `kindly-license`
 - `np-init`
 - `obj2env`
 - `rucksack`











## :scroll: License

[MIT][license] © [Ionică Bizău][website]






[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW

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