@stdlib/assert/is-generator-object/docs/types/index.d.ts

Standard assertion utilities.

/*
* @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.
*/

// TypeScript Version: 4.1

/**
* Tests if a value is a generator object.
*
* @param value - value to test
* @returns boolean indicating whether value is a generator object
*
* @example
* function* generateID() {
*     var idx = 0;
*     while ( idx < idx+1 ) {
*         yield idx;
*         idx += 1;
*     }
* }
* var bool = isGeneratorObject( generateID() );
* // returns true
*
* @example
* var bool = isGeneratorObject( {} );
* // returns false
*
* @example
* var bool = isGeneratorObject( null );
* // returns false
*/
declare function isGeneratorObject( value: any ): value is Generator;


// EXPORTS //

export = isGeneratorObject;