aboutsummaryrefslogtreecommitdiff
path: root/node_modules/is-generator-fn/index.d.ts
blob: 7eabf623823dea01c0f515b6d4933aeec9416328 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
declare const isGeneratorFn: {
	/**
	Check if something is a generator function.

	@example
	```
	import isGeneratorFn = require('is-generator-fn');

	isGeneratorFn(function * () {});
	//=> true

	isGeneratorFn(function () {});
	//=> false
	```
	*/
	(value: unknown): value is GeneratorFunction;

	// TODO: Remove this for the next major release, refactor the whole definition to:
	// declare function isGeneratorFn(value: unknown): value is GeneratorFunction;
	// export = isGeneratorFn;
	default: typeof isGeneratorFn;
};

export = isGeneratorFn;