time-to-botec

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

index.js (1175B)

      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 * Time a snippet.
     23 *
     24 * @module @stdlib/utils/timeit
     25 *
     26 * @example
     27 * var timeit = require( '@stdlib/utils/timeit' );
     28 *
     29 * var code = '';
     30 * code += 'var x = Math.pow( Math.random(), 3 );';
     31 * code += 'if ( x !== x ) {';
     32 * code += 'throw new Error( \'Something went wrong.\' );';
     33 * code += '}';
     34 *
     35 * timeit( code, done );
     36 *
     37 * function done( error, results ) {
     38 *     if ( error ) {
     39 *         throw error;
     40 *     }
     41 *     console.dir( results );
     42 * }
     43 */
     44 
     45 // MODULES //
     46 
     47 var timeit = require( './timeit.js' );
     48 
     49 
     50 // EXPORTS //
     51 
     52 module.exports = timeit;