@alessiofrittoli/web-utils/dist/generators.d.mts

Common TypeScript web utilities

/**
 * Check if a function is a `GeneratorFunction` or `AsyncGeneratorFunction`.
 *
 * @param	reference The function to check.
 * @returns	`true` if the given `reference` is a `GeneratorFunction` or `AsyncGeneratorFunction`.
 */
declare const isGeneratorFunction: (reference: unknown) => reference is (GeneratorFunction | AsyncGeneratorFunction);
/**
 * Check if a function is a `GeneratorFunction`.
 *
 * @param	reference The function to check.
 * @returns	`true` if the given `reference` is a `GeneratorFunction`.
 */
declare const isDefaultGeneratorFunction: (reference: unknown) => reference is GeneratorFunction;
/**
 * Check if a function is an `AsyncGeneratorFunction`.
 *
 * @param	reference The function to check.
 * @returns	`true` if the given `reference` is an `AsyncGeneratorFunction`.
 */
declare const isAsyncGeneratorFunction: (reference: unknown) => reference is AsyncGeneratorFunction;
/**
 * Check if reference is a `Generator` or `AsyncGenerator`.
 *
 * @param	reference The reference to check.
 * @returns	`true` if the given `generator` is a `Generator` or `AsyncGenerator`.
 */
declare const isGeneratorObject: <T>(reference: unknown) => reference is (Generator<T> | AsyncGenerator<T>);
/**
 * Check if reference is a `Generator`.
 *
 * @param	reference The reference to check.
 * @returns	`true` if the given `generator` is a `Generator`.
 */
declare const isDefaultGeneratorObject: <T>(reference: unknown) => reference is Generator<T>;
/**
 * Check if reference is an `AsyncGenerator`.
 *
 * @param	reference The reference to check.
 * @returns	`true` if the given `generator` is an `AsyncGenerator`.
 */
declare const isAsyncGeneratorObject: <T>(reference: unknown) => reference is AsyncGenerator<T>;

export { isAsyncGeneratorFunction, isAsyncGeneratorObject, isDefaultGeneratorFunction, isDefaultGeneratorObject, isGeneratorFunction, isGeneratorObject };