time-to-botec/squiggle/node_modules/@stdlib/fs/rename/lib/main.js
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

52 lines
1.1 KiB
JavaScript

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
// MODULES //
var native = require( 'fs' ).rename;
// MAIN //
/**
* Asynchronously renames a file.
*
* @param {(string|Buffer)} oldPath - old path
* @param {(string|Buffer)} newPath - new path
* @param {Function} clbk - callback to invoke after renaming a path
*
* @example
* function done( error ) {
* if ( error ) {
* throw error;
* }
* }
*
* rename( './beep/boop.txt', './beep/foo.txt', done );
*/
function rename( oldPath, newPath, clbk ) {
native( oldPath, newPath, clbk );
}
// EXPORTS //
module.exports = rename;