time-to-botec

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

main.js (1631B)

      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 hasIteratorSymbolSupport = require( '@stdlib/assert/has-iterator-symbol-support' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Iterator symbol.
     30 *
     31 * @name IteratorSymbol
     32 * @constant
     33 * @type {(symbol|null)}
     34 *
     35 * @example
     36 * function iterator() {
     37 *     var it;
     38 *     var i;
     39 *
     40 *     i = -1;
     41 *
     42 *     it = {};
     43 *     it.next = next;
     44 *     it.return = done;
     45 *
     46 *     if ( IteratorSymbol ) {
     47 *         it[ IteratorSymbol ] = iterator;
     48 *     }
     49 *     return it;
     50 *
     51 *     function next() {
     52 *         i += 1;
     53 *         return {
     54 *             'value': i,
     55 *             'done': false
     56 *         };
     57 *     }
     58 *
     59 *     function done( value ) {
     60 *         if ( arguments.length === 0 ) {
     61 *             return {
     62 *                 'done': true
     63 *             };
     64 *         }
     65 *         return {
     66 *             'value': value,
     67 *             'done': true
     68 *         };
     69 *     }
     70 * }
     71 *
     72 * var obj = iterator();
     73 */
     74 var IteratorSymbol = ( hasIteratorSymbolSupport() ) ? Symbol.iterator : null;
     75 
     76 
     77 // EXPORTS //
     78 
     79 module.exports = IteratorSymbol;