time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1343B)

      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 /**
     22 * Rename a file.
     23 *
     24 * @module @stdlib/fs/rename
     25 *
     26 * @example
     27 * var rename = require( '@stdlib/fs/rename' );
     28 *
     29 * function done( error ) {
     30 *     if ( error ) {
     31 *         throw error;
     32 *     }
     33 * }
     34 *
     35 * rename( './beep/boop.txt', './beep/foo.txt', done );
     36 *
     37 * @example
     38 * var renameSync = require( '@stdlib/fs/rename' ).sync;
     39 *
     40 * var err = renameSync( './beep/boop.txt', './beep/foo.txt' );
     41 * if ( err instanceof Error ) {
     42 *     throw err;
     43 * }
     44 */
     45 
     46 // MODULES //
     47 
     48 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     49 var rename = require( './main.js' );
     50 var sync = require( './sync.js' );
     51 
     52 
     53 // MAIN //
     54 
     55 setReadOnly( rename, 'sync', sync );
     56 
     57 
     58 // EXPORTS //
     59 
     60 module.exports = rename;