vinyl-paths
Get the file paths in a `vinyl` stream
Last updated 8 months ago by sindresorhus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install vinyl-paths 
SYNC missed versions from official npm registry.

vinyl-paths Build Status

Get the file paths in a vinyl stream

Useful when you need to use the file paths from a Gulp pipeline in an async Node.js package.

Simply pass an async function such as del and this package will provide each path in the stream as the first argument.

Install

$ npm install vinyl-paths

Usage

// gulpfile.js
const gulp = require('gulp');
const stripDebug = require('gulp-strip-debug');
const del = require('del');
const vinylPaths = require('vinyl-paths');

// Log file paths in the stream
gulp.task('log', =>
	gulp.src('app/*')
		.pipe(stripDebug())
		.pipe(vinylPaths(async paths => {
			console.log('Paths:', paths);
		})
);

// Delete files in the stream
gulp.task('delete', =>
	gulp.src('app/*')
		.pipe(stripDebug())
		.pipe(vinylPaths(del))
);

// Or if you need to use the paths after the pipeline
gulp.task('delete2', =>
	new Promise(function (resolve, reject) {
		const vp = vinylPaths();

		gulp.src('app/*')
			.pipe(vp)
			.pipe(gulp.dest('dist'))
			.on('end', async () => {
				try {
					await del(vp.paths);
					resolve();
				} catch (error) {
					reject(error);
				}
			});
	})
);

You should only use a vanilla Node.js package like this if you're already using other plugins in the pipeline, otherwise just use the module directly as gulp.src is costly. Remember that Gulp tasks can return promises as well as streams!

API

vinylPaths(callback?)

The optional callback will receive a file path for every file and is expected to return a promise. An array of the file paths so far is available as a paths property on the stream.

callback(path)

Related

Current Tags

  • 3.0.1                                ...           latest (8 months ago)

5 Versions

  • 3.0.1                                ...           8 months ago
  • 3.0.0                                ...           a year ago
  • 2.1.0                                ...           5 years ago
  • 2.0.0                                ...           5 years ago
  • 1.0.0                                ...           6 years ago
Maintainers (1)
Downloads
Today 23
This Week 120
This Month 54
Last Day 31
Last Week 169
Last Month 875
Dependencies (1)
Dev Dependencies (3)
Dependents (170)

Copyright 2014 - 2017 © taobao.org |