# gulp-until

> Wait for an evaluation function to become true in your gulp pipe.

Latest version **0.1.3** (published 2016-11-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-until
pnpm add gulp-until
yarn add gulp-until
bun add gulp-until
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2016-11-17 |
| First published | 2016-11-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Fabian Pirklbauer |
| Maintainers | fabiandev |
| Keywords | gulp, wait, while, until, pipe |

## Links

- npm: https://www.npmjs.com/package/gulp-until
- Repository: https://github.com/fabiandev/gulp-until
- Homepage: https://github.com/fabiandev/gulp-until#readme
- Issues: https://github.com/fabiandev/gulp-until/issues
- npm.io page: https://npm.io/package/gulp-until

## Dependencies (2)

- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.7
- [map-stream](https://npm.io/package/map-stream.md) ^0.0.6

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.1.3 (latest) — 2016-11-17
- 0.1.2 — 2016-11-16
- 0.1.1 — 2016-11-16

## README

# gulp-until

This package evaluates a function until it returns `true` to go to the next pipe.  

> A true-ish return value like `1` or `{}` would *not* trigger the next pipe.  
> The function has to explicitly return `true` or `false`.

# Installation

```sh
$ npm install gulp-until --save-dev
```

```sh
$ yarn add gulp-until --dev
```

# Example Usage

Either pass a function directly:

```js
  import until from 'gulp-until';

  return gulp.src(config.src)
    .pipe(until(() => {
      // Once this function returns true for the first time,
      // the next pipe is executed.
    }))
    .pipe(gulp.dest(config.dest));
```
> The example above uses the ES6 syntax.

Or additionally give gulp-util a custom time to wait between checks.  
`Default: 100`

```js
  var until = require('gulp-until');

  return gulp.src(config.src)
    .pipe(until({
      wait: 800, // ms to wait between checks.
      check: function() {
        // Again the evaluation function.
      }
    }))
    .pipe(gulp.dest(config.dest));
```

---
_Source: https://npm.io/package/gulp-until · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._