Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Provide a better streaming api in your app.
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test check for compression stream in requests
.gitignore
.travis.yml
LICENSE
README.md
package.json

README.md

node-streamin Build Status

Provide a better streaming api for your module.

Usage

var streamin = require('streamin');

// `io` can be a path to a file, a url, or a stream
var stream = streamin(io);

That's the gist of it. With this you can give your code a more conveniet API by allowing streams to be passed into your function and also consider the common use cases of files and urls as inputs or outputs.

API

streamin(io, [requestOptions])

If io is a path to a file, it will return a stream that points to a local file. If it's a url, a stream from a remote request will be returned. If it detects that io is already a stream, it returns it. Will also decompress a gzip/deflate compressed http stream.

requestOptions can be a hash of options passed to request.

Install

npm install streamin

Tests

Tests are written with mocha

npm test

License

MIT

Something went wrong with that request. Please try again.