JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 96
  • Score
    100M100P100Q73314F
  • License MIT

Serves the vinyl stream directly

Package Exports

  • vinyl-serve

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vinyl-serve) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

vinyl-serve v1.1.0 Build Status codecov.io

Serves the vinyl stream directly

Usage

import gulp from 'gulp'
import vinylServe from 'vinyl-serve'
import someTransform from './somewhere'

gulp.src('src/**/*.js')
  .pipe(someTransform())
  .pipe(vinylServe(7000))

This starts the server at port 7000 and, for example, localhost:7000/foo.js responses the transformed contents of src/foo.js.

Recipes

Serve multiple source streams

gulp.task('serve', function () {

  gulp.src('js/**/*.js')
    .pipe(someTransform())
    .pipe(vinylServe(7000))

  gulp.src('css/**/*.scss')
    .pipe(anotherTransform())
    .pipe(vinylServe(7000))

  gulp.src('html/**/*.html')
    .pipe(vinylServe(7000))

})

Modify the base path

gulp.src('./js/**/*.js', {base: './'})
  .pipe(someTransform())
  .pipe(vinylServe(7000))

With the above example, if you have js/foo.js, it's served at the path /js/foo.js, not /foo.js.

Debug

At the address __vinyl__, you can see the debug page and find all the available paths in the server.

screenshot

API

var vinylServe = require('vinyl-serve')

vinylServe(port)

param type description
port number The port number of the server (default: 7000)

This returns stream processor which serves the contents at the given port.

vinylServe.stop(port)

param type description
port number The port number of the server (default: 7000)

This restarts the server at the given port number. Throws error if there is no server at the port.

vinylServe.restart(port)

param type description
port number The port number of the server (default: 7000)

This stops the server at the given port number. Throws error if there is no server at the port.

Install

npm install vinyl-serve

License

MIT