| <p align="center"> | |
| <a href="https://gulpjs.com"> | |
| <img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png"> | |
| </a> | |
| </p> | |
| # fs-mkdirp-stream | |
| [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Coveralls Status][coveralls-image]][coveralls-url] | |
| Ensure directories exist before writing to them. | |
| ## Usage | |
| ```js | |
| var { Readable, Writable } = require('streamx'); | |
| var mkdirpStream = require('fs-mkdirp-stream'); | |
| Readable.from([{ dirname: './path/to/my/', path: './path/to/my/file.js' }]) | |
| .pipe( | |
| mkdirpStream(function (obj, callback) { | |
| // callback can take 3 arguments (err, dirname, mode) | |
| callback(null, obj.dirname); | |
| }) | |
| ) | |
| .pipe( | |
| new Writable({ | |
| write: function (obj, cb) { | |
| // This will be called once the directory exists | |
| // obj === { dirname: '/path/to/my/', path: '/path/to/my/file.js' } | |
| cb(); | |
| }, | |
| }) | |
| ); | |
| ``` | |
| ## API | |
| ### `mkdirpStream(resolver)` | |
| Takes a `resolver` function or string and returns a `streamx.Transform` stream. | |
| If the `resolver` is a function, it will be called once per chunk with the signature `(chunk, callback)`. The `callback(error, dirpath, mode)` must be called with the `dirpath` to be created as the 2nd parameter or an `error` as the 1st parameter; optionally with a `mode` as the 3rd parameter. | |
| If the `resolver` is a string, it will be created/ensured for each chunk (e.g. if it were deleted between chunks, it would be recreated). When using a string, a custom `mode` can't be used. | |
| ## License | |
| MIT | |
| Contains a custom implementation of `mkdirp` originally based on https://github.com/substack/node-mkdirp (Licensed MIT/X11 - Copyright 2010 James Halliday) with heavy modification to better support custom modes. | |
| <!-- prettier-ignore-start --> | |
| [downloads-image]: https://img.shields.io/npm/dm/fs-mkdirp-stream.svg?style=flat-square | |
| [npm-url]: https://www.npmjs.com/package/fs-mkdirp-stream | |
| [npm-image]: https://img.shields.io/npm/v/fs-mkdirp-stream.svg?style=flat-square | |
| [ci-url]: https://github.com/gulpjs/fs-mkdirp-stream/actions?query=workflow:dev | |
| [ci-image]: https://img.shields.io/github/workflow/status/gulpjs/fs-mkdirp-stream/dev?style=flat-square | |
| [coveralls-url]: https://coveralls.io/r/gulpjs/fs-mkdirp-stream | |
| [coveralls-image]: https://img.shields.io/coveralls/gulpjs/fs-mkdirp-stream/master.svg?style=flat-square | |
| <!-- prettier-ignore-end --> | |