time-to-botec

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

main.js (1539B)


      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 mod = require( 'module' );
     24 var contains = require( './../../contains' );
     25 var isString = require( './../../is-string' ).isPrimitive;
     26 var BUILTINS = require( './builtins.json' );
     27 
     28 
     29 // VARIABLES //
     30 
     31 var LIST = mod.builtinModules || BUILTINS;
     32 
     33 
     34 // MAIN //
     35 
     36 /**
     37 * Tests whether a string matches a Node.js built-in module name.
     38 *
     39 * @param {*} x - value to test
     40 * @returns {boolean} boolean indicating whether a string matches a Node.js built-in module name
     41 *
     42 * @example
     43 * var out = isNodeBuiltin( 'cluster' );
     44 * // returns true
     45 *
     46 * @example
     47 * var out = isNodeBuiltin( 'crypto' );
     48 * // returns true
     49 *
     50 * @example
     51 * var out = isNodeBuiltin( 'fs-extra' );
     52 * // returns false
     53 *
     54 * @example
     55 * var out = isNodeBuiltin( '' );
     56 * // returns false
     57 */
     58 function isNodeBuiltin( x ) {
     59 	if ( !isString( x ) ) {
     60 		return false;
     61 	}
     62 	return contains( LIST, x );
     63 }
     64 
     65 
     66 // EXPORTS //
     67 
     68 module.exports = isNodeBuiltin;