sync.js (1220B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var rename = require( 'fs' ).renameSync; // eslint-disable-line no-sync 24 25 26 // MAIN // 27 28 /** 29 * Synchronously renames a file. 30 * 31 * @param {(string|Buffer)} oldPath - old path 32 * @param {(string|Buffer)} newPath - new path 33 * @returns {(Error|null)} error object or null 34 * 35 * @example 36 * var err = renameSync( './beep/boop.txt', './beep/foo.txt' ); 37 * if ( err instanceof Error ) { 38 * throw err; 39 * } 40 */ 41 function renameSync( oldPath, newPath ) { 42 try { 43 rename( oldPath, newPath ); 44 } catch ( err ) { 45 return err; 46 } 47 return null; 48 } 49 50 51 // EXPORTS // 52 53 module.exports = renameSync;