Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

gentle-fs

2.3.1 • Public • Published

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".

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)

Keywords

Install

npm i gentle-fs

DownloadsWeekly Downloads

516,878

Version

2.3.1

License

Artistic-2.0

Unpacked Size

31.3 kB

Total Files

10

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar