time-to-botec/squiggle/node_modules/@stdlib/utils/timeit/lib/index.js

53 lines
1.1 KiB
JavaScript
Raw Normal View History

/**
* @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';
/**
* Time a snippet.
*
* @module @stdlib/utils/timeit
*
* @example
* var timeit = require( '@stdlib/utils/timeit' );
*
* var code = '';
* code += 'var x = Math.pow( Math.random(), 3 );';
* code += 'if ( x !== x ) {';
* code += 'throw new Error( \'Something went wrong.\' );';
* code += '}';
*
* timeit( code, done );
*
* function done( error, results ) {
* if ( error ) {
* throw error;
* }
* console.dir( results );
* }
*/
// MODULES //
var timeit = require( './timeit.js' );
// EXPORTS //
module.exports = timeit;