blob: 2518ea6ed36c57270caa1907117258d61f4892b3 [file] [log] [blame]
{
"_from": "rimraf@2.5.2",
"_id": "rimraf@2.5.2",
"_location": "/npm/rimraf",
"_nodeVersion": "5.6.0",
"_npmOperationalInternal": {
"host": "packages-6-west.internal.npmjs.com",
"tmp": "tmp/rimraf-2.5.2.tgz_1455346499772_0.9326622514054179"
},
"_npmUser": {
"email": "i@izs.me",
"name": "isaacs"
},
"_npmVersion": "3.7.0",
"_phantomChildren": {
"inflight": "1.0.5",
"inherits": "2.0.1",
"minimatch": "3.0.0",
"once": "1.3.3"
},
"_requiredBy": [
"/npm",
"/npm/fs-vacuum",
"/npm/fstream",
"/npm/node-gyp",
"/npm/npm-registry-client"
],
"_resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.5.2.tgz",
"_shasum": "62ba947fa4c0b4363839aefecd4f0fbad6059726",
"_shrinkwrap": null,
"author": {
"email": "i@izs.me",
"name": "Isaac Z. Schlueter",
"url": "http://blog.izs.me/"
},
"bin": {
"rimraf": "./bin.js"
},
"bugs": {
"url": "https://github.com/isaacs/rimraf/issues"
},
"dependencies": {
"glob": "^7.0.0"
},
"description": "A deep deletion module for node (like `rm -rf`)",
"devDependencies": {
"mkdirp": "^0.5.1",
"tap": "^5.1.1"
},
"directories": {},
"dist": {
"shasum": "62ba947fa4c0b4363839aefecd4f0fbad6059726",
"tarball": "http://registry.npmjs.org/rimraf/-/rimraf-2.5.2.tgz"
},
"files": [
"LICENSE",
"README.md",
"bin.js",
"rimraf.js"
],
"gitHead": "f414f87021f88d004ac487eebc8d07ce6a152721",
"homepage": "https://github.com/isaacs/rimraf#readme",
"license": "ISC",
"main": "rimraf.js",
"maintainers": [
{
"email": "i@izs.me",
"name": "isaacs"
}
],
"name": "rimraf",
"optionalDependencies": {},
"readme": "[![Build Status](https://travis-ci.org/isaacs/rimraf.svg?branch=master)](https://travis-ci.org/isaacs/rimraf) [![Dependency Status](https://david-dm.org/isaacs/rimraf.svg)](https://david-dm.org/isaacs/rimraf) [![devDependency Status](https://david-dm.org/isaacs/rimraf/dev-status.svg)](https://david-dm.org/isaacs/rimraf#info=devDependencies)\n\nThe [UNIX command](http://en.wikipedia.org/wiki/Rm_(Unix)) `rm -rf` for node.\n\nInstall with `npm install rimraf`, or just drop rimraf.js somewhere.\n\n## API\n\n`rimraf(f, [opts], callback)`\n\nThe first parameter will be interpreted as a globbing pattern for files. If you\nwant to disable globbing you can do so with `opts.disableGlob` (defaults to\n`false`). This might be handy, for instance, if you have filenames that contain\nglobbing wildcard characters.\n\nThe callback will be called with an error if there is one. Certain\nerrors are handled for you:\n\n* Windows: `EBUSY` and `ENOTEMPTY` - rimraf will back off a maximum of\n `opts.maxBusyTries` times before giving up, adding 100ms of wait\n between each attempt. The default `maxBusyTries` is 3.\n* `ENOENT` - If the file doesn't exist, rimraf will return\n successfully, since your desired outcome is already the case.\n* `EMFILE` - Since `readdir` requires opening a file descriptor, it's\n possible to hit `EMFILE` if too many file descriptors are in use.\n In the sync case, there's nothing to be done for this. But in the\n async case, rimraf will gradually back off with timeouts up to\n `opts.emfileWait` ms, which defaults to 1000.\n\n## options\n\n* unlink, chmod, stat, lstat, rmdir, readdir,\n unlinkSync, chmodSync, statSync, lstatSync, rmdirSync, readdirSync\n\n In order to use a custom file system library, you can override\n specific fs functions on the options object.\n\n If any of these functions are present on the options object, then\n the supplied function will be used instead of the default fs\n method.\n\n Sync methods are only relevant for `rimraf.sync()`, of course.\n\n For example:\n\n ```javascript\n var myCustomFS = require('some-custom-fs')\n\n rimraf('some-thing', myCustomFS, callback)\n ```\n\n* maxBusyTries\n\n If an `EBUSY`, `ENOTEMPTY`, or `EPERM` error code is encountered\n on Windows systems, then rimraf will retry with a linear backoff\n wait of 100ms longer on each try. The default maxBusyTries is 3.\n\n Only relevant for async usage.\n\n* emfileWait\n\n If an `EMFILE` error is encountered, then rimraf will retry\n repeatedly with a linear backoff of 1ms longer on each try, until\n the timeout counter hits this max. The default limit is 1000.\n\n If you repeatedly encounter `EMFILE` errors, then consider using\n [graceful-fs](http://npm.im/graceful-fs) in your program.\n\n Only relevant for async usage.\n\n* glob\n\n Set to `false` to disable [glob](http://npm.im/glob) pattern\n matching.\n\n Set to an object to pass options to the glob module. The default\n glob options are `{ nosort: true, silent: true }`.\n\n Glob version 6 is used in this module.\n\n Relevant for both sync and async usage.\n\n* disableGlob\n\n Set to any non-falsey value to disable globbing entirely.\n (Equivalent to setting `glob: false`.)\n\n## rimraf.sync\n\nIt can remove stuff synchronously, too. But that's not so good. Use\nthe async API. It's better.\n\n## CLI\n\nIf installed with `npm install rimraf -g` it can be used as a global\ncommand `rimraf <path> [<path> ...]` which is useful for cross platform support.\n\n## mkdirp\n\nIf you need to create a directory recursively, check out\n[mkdirp](https://github.com/substack/node-mkdirp).\n",
"readmeFilename": "README.md",
"repository": {
"type": "git",
"url": "git://github.com/isaacs/rimraf.git"
},
"scripts": {
"test": "tap test/*.js"
},
"version": "2.5.2"
}