https://github.com/marak/vinyl-http
push and receive streams of vinyl over http
https://github.com/marak/vinyl-http
Last synced: about 1 year ago
JSON representation
push and receive streams of vinyl over http
- Host: GitHub
- URL: https://github.com/marak/vinyl-http
- Owner: Marak
- Created: 2014-09-17T20:26:28.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-04-20T09:32:39.000Z (about 10 years ago)
- Last Synced: 2024-10-29T10:38:47.002Z (over 1 year ago)
- Language: JavaScript
- Homepage: www.gulpjs.com
- Size: 7.81 KB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vinyl-http
## Unreleased v0.0.0
## Information
Packagevinyl-http
Description
Vinyl adapter for HTTP
Node Version
>= 0.10
## Purpose
This vinyl adapter allows you to either either post or receive streams of vinyl from an HTTP server.
This enables the ability to quickly push or retrieve streams of files to or from remote sources.
An HTTP server component is required and shipped with this module. It can be used as a stand-alone server or as middleware for your existing http server.
Alternatives to using this module could be `gulp-sftp`, but that would necessitate an open ssh server while `vinyl-http` requires only an open http server.
## Usage
### Start the server
```javascript
var server = require('vinyl-http').createServer();
server.listen(8888);
```
### Push local to remote
```javascript
var vhttp = require('../index');
var vfs = require('vinyl-fs');
var map = require("map-stream");
var log = function(file, cb) {
console.log(file)
cb(null, file);
};
vfs.src('test/fixtures/**')
.pipe(vhttp.dest('http://localhost:8888/upload'))
.pipe(map(log));
```
### Pull remote to local
```javascript
var vhttp = require('../index');
var vfs = require('vinyl-fs');
var map = require("map-stream");
var log = function(file, cb) {
console.log(file)
cb(null, file);
};
vhttp.src('http://localhost:8888/test/fixtures/**')
.pipe(map(log))
.pipe(vfs.dest('./download'));
```
### Stream from remote to remote
```javascript
var vhttp = require('../index');
var vfs = require('vinyl-fs');
var map = require("map-stream");
var log = function(file, cb) {
console.log(file)
cb(null, file);
};
vhttp.src('http://localhost:8888/test/fixtures/**')
.pipe(map(log))
.pipe(vhttp.dest('http://localhost:8888/upload2'));
```
## API
### src(globs[, opt])
- Takes a glob string or an array of glob strings as the first argument.
- Returns a Readable/Writable stream.
- On write the stream will simply pass items through.
- This stream emits matching [vinyl] File objects
### dest(folder[, opt])
- Takes a folder path as the first argument.
- Possible options for the second argument:
- Returns a Readable/Writable stream.
## TODO
- Add Tests
- Investigate adding compression
- Add protection for directory traversals on server