doc: Update ExpectAPI.md

[ajubin]

Update doc to add types for custom matchers

Fix : #10642

Summary

Motivation : Copy pasting documentation doesn't work, as mentioned here, #10642

Test plan

[facebook-github-bot]

Hi @ajubin!

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!

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

[ajubin]

Hi, the CI failed for Node v15.x on windows-latest on install step and for facebook.jest on step macos >run tests whereas it seems ok for every other actions, is it a problem ?

[SimenB]

@orta is this correct? I keep getting confused byt how to properly do this 🙈

[orta]

This originally was based on my work in svg-snapshots - it's possible that the Jest types have moved on since but I think the key difference is that mine is in a .ts file and the not working example in #10642 (comment) is in a .d.ts file. They do have different semantics in the type system.

Mine assumes that you will have an import "dep" in each file where you use the matcher. This makes that file get the modification, the new version I think would be a change everywhere (if the .d.ts is in the right spot) which could not be true in the runtime depending on your config

[ajubin]

Hi, actually on the doc it's a bit unclear how to do it.

[orta]

Sure, then I'd recommend switching the code back, and adding something like:

- _Note_: In TypeScript, when using `@types/jest` for example, you can declare the new `toBeWithinRange` matcher like this:
+ _Note_: In TypeScript, when using `@types/jest` for example, you can declare the new `toBeWithinRange` matcher in the imported module like this:

Which I think makes it clearer overall

[ajubin]

I'll do this :) What about the failing checks ?
And should I update the versionned documentation also ?

[orta]

The fail is unrelated, this should be fine 👍🏻

[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.