time-to-botec

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

index.js (2015B)

      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 * Test if a value is an array-like object containing only symbols.
     23 *
     24 * @module @stdlib/assert/is-symbol-array
     25 *
     26 * @example
     27 * var isSymbolArray = require( '@stdlib/assert/is-symbol-array' );
     28 *
     29 * var bool = isSymbolArray( [ Symbol( 'abc' ), Symbol( 'def' ) ] );
     30 * // returns true
     31 *
     32 * bool = isSymbolArray( [ Symbol( 'abc' ), 'def' ] );
     33 * // returns false
     34 *
     35 * @example
     36 * var isSymbolArray = require( '@stdlib/assert/is-symbol-array' ).primitives;
     37 *
     38 * var bool = isSymbolArray( [ Symbol( 'abc' ), Symbol( 'def' ) ] );
     39 * // returns true
     40 *
     41 * bool = isSymbolArray( [ Symbol( 'abc' ), Object( Symbol( 'def' ) ) ] );
     42 * // returns false
     43 *
     44 * @example
     45 * var isSymbolArray = require( '@stdlib/assert/is-symbol-array' ).objects;
     46 *
     47 * var bool = isSymbolArray( [ Object( Symbol( 'abc' ) ), Object( Symbol( 'def' ) ) ] );
     48 * // returns true
     49 *
     50 * bool = isSymbolArray( [ Symbol( 'abc' ), Symbol( 'def' ) ] );
     51 * // returns false
     52 */
     53 
     54 // MODULES //
     55 
     56 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     57 var arrayfun = require( './../../tools/array-like-function' );
     58 var isSymbol = require( './../../is-symbol' );
     59 
     60 
     61 // MAIN //
     62 
     63 var isSymbolArray = arrayfun( isSymbol );
     64 setReadOnly( isSymbolArray, 'primitives', arrayfun( isSymbol.isPrimitive ) );
     65 setReadOnly( isSymbolArray, 'objects', arrayfun( isSymbol.isObject ) );
     66 
     67 
     68 // EXPORTS //
     69 
     70 module.exports = isSymbolArray;