chore(docs): add readme to jest-types

[rethab]

No description provided.

[facebook-github-bot]

Hi @rethab!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

[SimenB]

Thanks! We do support types if you import @jest/globals, maybe mention it?

@mrazauskas thoughts?

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[mrazauskas]

@rethab Left a couple of comments. Just drafting. Feel free to rework (;

As an example, jest.useFakeTimers() (see #12572) are not yet correctly typed in @types/jest (unless something changed recently). The idea which I am trying to promote is that importing types will always provide up to date types of current installed version.

[rethab]

Thanks @mrazauskas and @SimenB I have incorporated all suggestions :)

[SimenB]

Sorry @rethab, one more thing 😅

One thing @jest/types might be used for directly is to type Jest config. I.e.

// jest.config.ts
import {Config} from '@jest/types';

const config: Config.InitialOptions = {
  // some typed config
};

export default config;

Could we add a mention of that?

[mrazauskas]

Thank you for fixing grammar. All looks good for me.

[rethab]

Sorry @rethab, one more thing 😅

One thing @jest/types might be used for directly is to type Jest config. I.e.

// jest.config.ts
import {Config} from '@jest/types';

const config: Config.InitialOptions = {
  // some typed config
};

export default config;

Could we add a mention of that?

No worries, I've added that.

But while we're at it, why does jest not provide those types? Would it be possible to export them for users to consume?

[mrazauskas]

But while we're at it, why does jest not provide those types? Would it be possible to export them for users to consume?

Good question. I have one super simple idea regarding config types. Will just do it now ;D

[SimenB]

thanks!

[github-actions]

This pull request 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.