Incorrect types for lifecycle functions

🐛 Bug Report

The types for the lifecycle functions (beforeEach etc.) are declared incorrectly in packages/jest-types/src/Global.ts. These functions are documented as being able to return a promise or generator and accepting a timeout parameter but the defined types disallow anything except a void returning function.

To Reproduce

Take the following code:

import { beforeEach } from "@jest/globals";

beforeEach((): Promise<void> => {
  return Promise.resolve();
}, 2000);

This causes TypeScript to complain with Expected 0-1 arguments, but got 2. ts(2554) and causes the typescript-eslint rule no-misused-promises to complain with Promise returned in function argument where a void return was expected..

Expected behavior

The given code should not show any issues.

I think that the type for HookFn should be changed to something like this:

export type LifecycleFn = (done?: DoneFn) => Generator | Promise<void | undefined | unknown> | void | undefined;
export type HookFn = (fn: LifecycleFn, timeout?: number) => void;

envinfo

  System:
    OS: macOS 10.15.4
    CPU: (12) x64 Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz
  Binaries:
    Node: 14.1.0 - /usr/local/bin/node
    npm: 6.14.4 - /usr/local/bin/npm
  npmPackages:
    jest: ^26.0.1 => 26.0.1

[SimenB]

Closed by #10836, thanks @villasv!

[github-actions[bot]]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.