@stdlib/fs-rename

Rename a file.

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary

Keywords

async change del delete file filesystem fs javascript move node node-js nodejs path relocate remove rename renamesync rm stdlib sync

Last synced: 6 months ago · JSON representation ·

Repository

Rename a file.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 465 KB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

async change del delete file filesystem fs javascript move node node-js nodejs path relocate remove rename renamesync rm stdlib sync

Created over 4 years ago · Last pushed 8 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Rename

Rename a file.

## Installation ```bash npm install @stdlib/fs-rename ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). - To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally. The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage ```javascript var rename = require( '@stdlib/fs-rename' ); ``` #### rename( oldPath, newPath, clbk ) Asynchronously renames a file specified by `oldPath` to `newPath`. ```javascript var join = require( 'path' ).join; var oldPath = join( __dirname, 'examples', 'fixtures', 'file.txt' ); var newPath = join( __dirname, 'examples', 'fixtures', 'tmp.txt' ); rename( oldPath, newPath, done ); function done( error ) { if ( error ) { throw error; } } ``` #### rename.sync( oldPath, newPath ) Synchronously renames a file specified by `oldPath` to `newPath`. ```javascript var join = require( 'path' ).join; var oldPath = join( __dirname, 'examples', 'fixtures', 'file.txt' ); var newPath = join( __dirname, 'examples', 'fixtures', 'tmp.txt' ); var err = rename.sync( oldPath, newPath ); if ( err instanceof Error ) { throw err; } ```

## Notes - `oldPath` can specify a directory. In this case, `newPath` must either **not** exist, or it must specify an **empty** directory. - `oldPath` should **not** name an ancestor directory of `newPath`. - If `oldPath` points to the pathname of a file that is **not** a directory, `newPath` should **not** point to the pathname of a directory. - Write access permission is **required** for both the directory containing `oldPath` and the directory containing `newPath`. - If the link named by `newPath` exists, `newPath` is removed and `oldPath` is renamed to `newPath`. The link named by `newPath` will remain visible to other threads throughout the renaming operation and refer to either the file referred to by `newPath` or to the file referred to by `oldPath` before the operation began. - If `oldPath` and `newPath` resolve to either the same existing directory entry or to different directory entries for the same existing file, no action is taken, and no error is returned. - If `oldPath` points to a pathname of a symbolic link, the symbolic link is renamed. If the `newPath` points to a pathname of a symbolic link, the symbolic link is removed. - If a link named by `newPath` exists and the file's link count becomes `0` when it is removed and no process has the file open, the space occupied by the file is freed and the file is no longer accessible. If one or more processes have the file open when the last link is removed, the link is removed before the function returns, but the removal of file contents is postponed until all references to the file are closed. - The difference between `rename.sync` and [`fs.rename()`][node-fs] is that [`fs.renameSync()`][node-fs] will throw if an `error` is encountered (e.g., if given a non-existent path) and this API will return an `error`. Hence, the following anti-pattern ```javascript var fs = require( 'fs' ); // Check for path existence to prevent an error being thrown... if ( fs.existsSync( '/path/to/file.txt' ) ) { fs.renameSync( '/path/to/file.txt', '/path/to/tmp.txt' ); } ``` can be replaced by an approach which addresses existence via `error` handling. ```javascript var rename = require( '@stdlib/fs-rename' ); // Explicitly handle the error... var err = rename.sync( '/path/to/file.txt', '/path/to/tmp.txt' ); if ( err instanceof Error ) { // You choose what to do... throw err; } ```

## Examples ```javascript var join = require( 'path' ).join; var readFile = require( '@stdlib/fs-read-file' ).sync; var writeFile = require( '@stdlib/fs-write-file' ).sync; var exists = require( '@stdlib/fs-exists' ).sync; var unlink = require( '@stdlib/fs-unlink' ).sync; var rename = require( '@stdlib/fs-rename' ).sync; var src = join( __dirname, 'examples', 'fixtures', 'file.txt' ); var tmp = join( __dirname, 'examples', 'tmp.txt' ); var dest = join( __dirname, 'examples', 'foo.txt' ); // Create a temporary file: writeFile( tmp, readFile( src ) ); // Confirm that the temporary file exists: console.log( exists( tmp ) ); // => true // Rename the temporary file: rename( tmp, dest ); // Confirm that the renamed temporary file exists: console.log( exists( dest ) ); // => true // Remove the temporary file: unlink( dest ); // Confirm that the temporary file no longer exists: console.log( exists( dest ) ); // => false ```

## CLI

## Installation To use as a general utility, install the CLI package globally ```bash npm install -g @stdlib/fs-rename-cli ```

### Usage ```text Usage: rename [options] Options: -h, --help Print this message. -V, --version Print the package version. ```

### Notes - Relative paths are resolved relative to the current working directory. - Errors are written to `stderr`.

### Examples ```bash $ rename ./examples/fixtures/file.txt ./examples/fixtures/tmp.txt ```

* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 19

Last Year

Push event: 19

Committers

Last synced: about 2 years ago

All Time

Total Commits: 50
Total Committers: 1
Avg Commits per committer: 50.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 14
Committers: 1
Avg Commits per committer: 14.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	50

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 2
Total downloads:
- npm 33 last-month

Total dependent packages: 4
(may contain duplicates)
Total dependent repositories: 1
(may contain duplicates)
Total versions: 18
Total maintainers: 4

npmjs.org: @stdlib/fs-rename

Rename a file.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 13
Dependent Packages: 4
Dependent Repositories: 1
Downloads: 19 Last month

Rankings

Dependent packages count: 4.5%

Dependent repos count: 10.3%

Average: 13.0%

Forks count: 15.4%

Stargazers count: 16.7%

Downloads: 17.9%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 6 months ago

npmjs.org: @stdlib/fs-rename-cli

Rename a file.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 5
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 14 Last month

Rankings

Forks count: 15.9%

Stargazers count: 17.2%

Average: 31.0%

Dependent repos count: 37.4%

Dependent packages count: 53.6%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 7 months ago

Dependencies

package.json npm

@stdlib/assert-is-browser ^0.0.x development
@stdlib/assert-is-windows ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/fs-exists ^0.0.x development
@stdlib/fs-unlink ^0.0.x development
@stdlib/fs-write-file ^0.0.x development
@stdlib/process-exec-path ^0.0.x development
@stdlib/string-replace ^0.0.x development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/cli-ctor ^0.0.x
@stdlib/fs-read-file ^0.0.x
@stdlib/process-cwd ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-property ^0.0.x

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

@stdlib/fs-rename

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Rename

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/fs-rename

Rankings

Maintainers (4)

Funding

npmjs.org: @stdlib/fs-rename-cli

Rankings

Maintainers (4)

Funding

Dependencies