Open jwalkerinterpres opened 1 month ago
P.S. Based on https://github.com/testing-library/react-hooks-testing-library/blob/main/src/types/react.ts it looks like the function actually takes two type arguments:
TProps
, which appears to be the type of the arguments of the hook function being tests?
TResult
, which appears to be the type of what the hook being tested returns?Even a single line of documentation:
This function takes two type parameters, the type of the hook's input and the type of its output.
would help clarify things.
(Also, the error message above mentioned "2-5" type arguments ... maybe another sentence could cover what those args are?)
EDIT: Actually I think I was looking at the wrong place (the perils of trying to make your own docs from unknown source code 😄). It looks like the real type to look at is the RenderHookResult
in https://github.com/testing-library/react-hooks-testing-library/blob/main/src/types/index.ts ... which also seems to take "props" and result.
It also takes a third TRenderer
(although I'm unclear on what this is), so that (sort of) explains the 3rd type parameter (I'm still unclear on #4/#5).
This library clearly supports TypeScript, because I see types mentioned in the commit messages, eg.
However, the word "type" doesn't even appear in your documentation or readme file. To be fair, types don't exactly require a ton of docs, but it'd be nice to at least mention how they're supposed to be used.
For instance:
So it seems renderHooks expects 2-5 type arguments ... surely you could spare a few lines in the docs to tell us what those arguments should be?