npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@stdlib/fs-rename

v0.2.2

Published

Rename a file.

Downloads

33

Readme

Rename

NPM version Build Status Coverage Status

Rename a file.

Installation

npm install @stdlib/fs-rename

Usage

var rename = require( '@stdlib/fs-rename' );

rename( oldPath, newPath, clbk )

Asynchronously renames a file specified by oldPath to newPath.

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.

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() is that fs.renameSync() 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

    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.

    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

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

See Also


Notice

This package is part of 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, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.