time-to-botec

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

index.js (1250B)

      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 a generator object.
     23 *
     24 * @module @stdlib/assert/is-generator-object
     25 *
     26 * @example
     27 * var isGeneratorObject = require( '@stdlib/assert/is-generator-object' );
     28 *
     29 * function* generateID() {
     30 *     var idx = 0;
     31 *     while ( idx < idx+1 ) {
     32 *         yield idx;
     33 *         idx += 1;
     34 *     }
     35 * }
     36 *
     37 * var bool = isGeneratorObject( generateID() );
     38 * // returns true
     39 *
     40 * bool = isGeneratorObject( generateID );
     41 * // returns false
     42 *
     43 * bool = isGeneratorObject( {} );
     44 * // returns false
     45 */
     46 
     47 // MODULES //
     48 
     49 var isGeneratorObject = require( './main.js' );
     50 
     51 
     52 // EXPORTS //
     53 
     54 module.exports = isGeneratorObject;