node package manager
Love JavaScript? Your insights can make it even better. Take the 2017 JavaScript Ecosystem Survey »

gentle-fs

gentle-fs npm version license Travis AppVeyor Coverage Status

gentle-fs is a standalone library for "gently" remove or link directories.

Install

$ npm install gentle-fs

Table of Contents

Example

// todo

Features

  • Performs filesystem operations "gently". Please see details in the API specs below for a more precise definition of "gently".

Contributing

The npm team enthusiastically welcomes contributions and project participation! There's a bunch of things you can do if you want to contribute! The Contributor Guide has all the information you need for everything from reporting bugs to contributing entire new features. Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.

API

> rm(target, opts, cb)

Will delete all directories between target and opts.base, as long as they are empty. That is, if target is /a/b/c/d/e and base is /a/b, but /a/b/c has other files besides the d directory inside of it, /a/b/c will remain.

Example
rm(target, opts, cb)

> link(from, to, opts, cb)

If from is a real directory, and from is not the same directory as to, will symlink from to to, while also gently rming the to directory, and then call the callback. Otherwise, will call callback with an Error.

Example
link(from, to, opts, cb)

> linkIfExists(from, to, opts, cb)

Performs the same operation as link, except does nothing when from is the same as to, and calls the callback.

Example
linkIfExists(from, to, opts, cb)