benchmark.js

/**
* @license Apache-2.0
*
* Copyright (c) 2019 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 bench = require( '@stdlib/bench' );
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var aliases = require( '@stdlib/namespace/aliases' );
var pkg = require( './../package.json' ).name;
var example = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
	var values;
	var v;
	var i;

	values = aliases();

	b.tic();
	for ( i = 0; i < b.iterations; i++ ) {
		v = example( values[ i%values.length ] );
		if ( typeof v !== 'string' && v !== null ) {
			b.fail( 'should return a string or null' );
		}
	}
	b.toc();
	if ( !isString( v ) && v !== null ) {
		b.fail( 'should return a string or null' );
	}
	b.pass( 'benchmark finished' );
	b.end();
});