{"id":17472751,"url":"https://github.com/shinnn/rmfr","last_synced_at":"2025-04-09T22:54:13.884Z","repository":{"id":21968679,"uuid":"25293444","full_name":"shinnn/rmfr","owner":"shinnn","description":"Node.js implementation of rm -fr – recursive removal of files and directories","archived":false,"fork":false,"pushed_at":"2018-03-02T02:57:42.000Z","size":77,"stargazers_count":23,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T22:54:08.995Z","etag":null,"topics":["async","delete","javascript","promise","recursive","remove","rimraf","rm"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shinnn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-10-16T08:35:10.000Z","updated_at":"2021-02-02T05:15:39.000Z","dependencies_parsed_at":"2022-08-18T03:05:21.745Z","dependency_job_id":null,"html_url":"https://github.com/shinnn/rmfr","commit_stats":null,"previous_names":["shinnn/rimraf-promise"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Frmfr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Frmfr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Frmfr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Frmfr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shinnn","download_url":"https://codeload.github.com/shinnn/rmfr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248125632,"owners_count":21051766,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","delete","javascript","promise","recursive","remove","rimraf","rm"],"created_at":"2024-10-18T17:35:28.401Z","updated_at":"2025-04-09T22:54:13.860Z","avatar_url":"https://github.com/shinnn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rmfr\n\n[![npm version](https://img.shields.io/npm/v/rmfr.svg)](https://www.npmjs.com/package/rmfr)\n[![Build Status](https://travis-ci.org/shinnn/rmfr.svg?branch=master)](https://travis-ci.org/shinnn/rmfr)\n[![Build status](https://ci.appveyor.com/api/projects/status/afcmk50xuig9jfs7/branch/master?svg=true)](https://ci.appveyor.com/project/ShinnosukeWatanabe/rmfr/branch/master)\n[![Coverage Status](https://coveralls.io/repos/github/shinnn/rmfr/badge.svg?branch=master)](https://coveralls.io/github/shinnn/rmfr?branch=master)\n\n[Node.js](https://nodejs.org/) implementation of `rm -fr` – recursive removal of files and directories\n\n```javascript\nconst rmfr = require('rmfr');\n\n(async () =\u003e await rmfr('path/to/target'))();\n```\n\n## Installation\n\n[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).\n\n```\nnpm install rmfr\n```\n\n## API\n\n```javascript\nconst rmfr = require('rmfr');\n```\n\n### rmfr(*path* [, *options*])\n\n*path*: `string` (a file/directory path)  \n*options*: `Object`  \nReturn: `Promise`\n\nWhen it finish removing a target, it will be [*fulfilled*](https://promisesaplus.com/#point-26) with no arguments.\n\nWhen it fails to remove a target, it will be [*rejected*](https://promisesaplus.com/#point-30) with an error as its first argument.\n\n#### Options\n\nAll [`rimraf`](https://github.com/isaacs/rimraf) [options](https://github.com/isaacs/rimraf#options) except for `disableGlob` are available, with some differences:\n\n* `glob` option defaults to `false`.\n  * If you want to specify targets using glob pattern, set `glob` option `true` or provide a [`node-glob` options object](https://github.com/isaacs/node-glob#options).\n* `unlink`, `chmod`, `rmdir` and `readdir` options default to the corresponding [`graceful-fs`](https://github.com/isaacs/node-graceful-fs) methods.\n\n```javascript\nconst rmfr = require('rmfr');\n\nrmfr('inde*.js'); // doesn't remove `./index.js`\nrmfr('inde*.js', {glob: true}); // removes `./index.js`\n```\n\n## License\n\n[ISC License](./LICENSE) © 2017 - 2018 Shinnosuke Watanabe\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Frmfr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinnn%2Frmfr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Frmfr/lists"}