https://github.com/cloudcmd/rename-files
rename files
https://github.com/cloudcmd/rename-files
cloudcmd files javascript nodejs rename
Last synced: 10 months ago
JSON representation
rename files
- Host: GitHub
- URL: https://github.com/cloudcmd/rename-files
- Owner: cloudcmd
- License: mit
- Created: 2018-05-07T12:03:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-28T09:26:14.000Z (about 7 years ago)
- Last Synced: 2025-03-25T09:18:09.787Z (10 months ago)
- Topics: cloudcmd, files, javascript, nodejs, rename
- Language: JavaScript
- Size: 6.84 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: LICENSE
Awesome Lists containing this project
README
# Rename Files [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]
Rename files.
## Install
```
npm i @cloudcmd/rename-files
```
## API
### renameFiles(from, to[, names])
- `from` `` - source filename to copy
- `to` ``- destination filename of the copy operation
- `names` ``- file processing streams (optional)
`renameFiles` is a promise, can be used with:
```js
const renameFiles = require('@cloudcmd/rename-files');
const ok = () => 'ok';
const error = (e) => e.message;
renameFiles('/', '/tmp', ['bin'])
.then(ok)
.catch(error)
.then(console.log);
```
You can use `renameFiles` as a promise with `async-await`:
```js
const tryToCatch = require('try-to-catch');
const renameFiles = promisify(require('@cloudcmd/rename-files'));
(async () => {
const [e] = await tryToCatch(renameFiles, '/', '/tmp', ['bin']);
if (!e)
return;
console.error(e.message);
})();
```
## Related
- [copy-file](https://github.com/cloudcmd/copy-file "copy-file") - simply copy a file
- [fs-rename-files](https://github.com/coderaiser/fs-copy-file "fs-copy-file") - Node.js `v8.5.0` `fs.copyFile` ponyfill
- [fs-rename-files-sync](https://github.com/coderaiser/fs-copy-file-sync "fs-copy-file-sync") - Node.js `v8.5.0` `fs.copyFile` ponyfill
## License
MIT
[NPMIMGURL]: https://img.shields.io/npm/v/@cloudcmd/rename-files.svg?style=flat
[BuildStatusIMGURL]: https://img.shields.io/travis/cloudcmd/rename-files/master.svg?style=flat
[DependencyStatusIMGURL]: https://img.shields.io/david/cloudcmd/rename-files.svg?style=flat
[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[CoverageIMGURL]: https://coveralls.io/repos/cloudcmd/rename-files/badge.svg?branch=master&service=github
[NPMURL]: https://npmjs.org/package/@cloudcmd/rename-files "npm"
[BuildStatusURL]: https://travis-ci.org/cloudcmd/rename-files "Build Status"
[DependencyStatusURL]: https://david-dm.org/cloudcmd/rename-files "Dependency Status"
[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"
[CoverageURL]: https://coveralls.io/github/cloudcmd/rename-files?branch=master