https://github.com/javascript-studio/studio-browser-stream
💧 Naive stream shim for smaller Browserify bundles
https://github.com/javascript-studio/studio-browser-stream
Last synced: 5 months ago
JSON representation
💧 Naive stream shim for smaller Browserify bundles
- Host: GitHub
- URL: https://github.com/javascript-studio/studio-browser-stream
- Owner: javascript-studio
- License: mit
- Created: 2018-06-29T14:54:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-25T23:51:29.000Z (over 2 years ago)
- Last Synced: 2025-03-16T09:37:37.399Z (10 months ago)
- Language: JavaScript
- Size: 815 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Studio Browser Stream
💧 Naive stream shim for smaller Browserify bundles.
## Why?
This library exists to make it possible to use [Studio Log][1] in browsers by
letting Browserify replace the node `stream` module with this implementation.
The default Browserify `stream` implementation adds 200+KB to the bundle.
__Note!__ This library is intentionally incompatible with the original node
`stream` module. It is only supposed to behave in the context of the [Studio
Log][1] modules.
## Usage
Add this section to your `package.json`:
```json
{
"browser": {
"stream": "@studio/browser-stream"
}
}
```
## Install
```bash
❯ npm i @studio/browser-stream
```
## API
- `Writable`
- `PassThrough`
- `Transform`
## Related modules
- 👻 [Studio Log][1] is a tiny streaming ndJSON logger.
- 🎩 [Studio Log Format][2] pretty prints Studio Log streams.
- 📦 [Studio Changes][3] is used to create the changelog for this module.
## License
MIT
Made with ❤️ on 🌍
[1]: https://github.com/javascript-studio/studio-log
[2]: https://github.com/javascript-studio/studio-log-format
[3]: https://github.com/javascript-studio/studio-changes