docs: update expect.extend examples
#13195
Conversation
| const toBeWithinRange: MatcherFunction<[floor: number, ceiling: number]> = | ||
| function (actual: unknown, floor: unknown, ceiling: unknown) { | ||
| const toBeWithinRange: MatcherFunction<[floor: unknown, ceiling: unknown]> = | ||
| function (actual, floor, ceiling) { |
There was a problem hiding this comment.
Cleaning up. I remember my thinking that expect.extend could grab types from MatcherFunction generics. Not sure if that was good idea. It involves lots of complexity (also in documentation), but has rather limited usage. For instance, does not work if expect is not imported after calling expect.extend. Fine for something small, but does not work with setupFilesAfterEnv. Better to stick with the declaration – single solution which works in many situations.
| To enable the matcher for all tests, move the `expect.extend` call to a [`setupFilesAfterEnv`](Configuration.md/#setupfilesafterenv-array) script: | ||
|
|
||
| ```js | ||
| import {expect} from '@jest/globals'; |
There was a problem hiding this comment.
Tried it out. Jest will transpile setupFilesAfterEnv scripts, so perhaps this can stay in ESM / TS for simplicity.
|
Happy about that! I had to do this some time ago. Well.. Better later than never ;D |
|
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. |
Summary
Currently the TypeScript examples of
expect.extendusage are the only ones in documentation where@types/jestis referenced. Elsewhere types imported from@jest/globalsare used. Perhaps it is time to update these last examples as well?The
@types/jestrelated documentation will stay in old docs. Can be linked quickly if someone opens an issue. Also I am very interested to see DefinitelyTyped/DefinitelyTyped#62037 landing with Jest v30 release. Some work has to be done to make that happen, but in general where will be just one way to extend theMatchersinterface. And it this documented in this PR (;Test plan
Tried out both JS and TS examples locally.