wait-stream v1.2.0

wait-stream

Simple wait module for streams3 in node.

Set a delay in a pipeline using setTimeout. Works well with Gulp.

Uses through2 as opposed to node core's stream module. See this excellent article by @rvagg for more:

Why I don't use Node's core 'stream' module

Usage

wait(timeout, options)

timeout

{number} The delay in ms to pass to setTimeout.

options

once

{boolean} The delay will only happen for the first chunk to enter the stream; all other chunks will pass through immediately.

Example

const wait = require('wait-stream');

pipeline
    .pipe(wait(500)) // wait 500 ms before continuing
    .pipe(nextTask);

Example using Gulp

Added because of the rising popularity of Gulp.

const gulp = require('gulp');
const wait = require('wait-stream');

gulp.task('default', build);

function build() {
  gulp.src('source/**')
      .pipe(build)               // could be anything
      .pipe(wait(500))           // wait 500 ms before continuing
      .pipe(gulp.dest('dest'));
}

Contributing

License

The MIT License (MIT)

Copyright (c) 2016 Justin Helmer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.