Convert to TypeScript #10
Conversation
| type RestRequest, | ||
| type SetupWorkerApi, | ||
| } from 'msw'; | ||
| import type { Server } from 'miragejs'; |
There was a problem hiding this comment.
This type isn't actually used, but because of the way the mirage types are defined, the /server types won't be found unless something is imported from the top level, in which case the other modules are cached and used as well.
lib/msw-config.ts
Outdated
| @@ -25,6 +29,13 @@ type HTTPVerb = | |||
| | 'options' | |||
| | 'head'; | |||
|
|
|||
| type BaseHandler = ( | |||
There was a problem hiding this comment.
I had thought about this. Really baseHandler should be defined in mirageJS proper and this implement it to ensure any changes in the handler in mirage are respected by the pretender/msw modules.
There was a problem hiding this comment.
Also it would avoid the need to create these again for the pretender repo
There was a problem hiding this comment.
Yeah that's a great point. In fact, I think the handlers defined in mirage are incorrect:
/** Handle a GET request to the given path. */
get<Response extends AnyResponse>(
path: string,
handler?: RouteHandler<Registry, Response>,
options?: HandlerOptions
): void;
That's only one format, but they can also be just options, or just a handler, or a number of other formats (unfortunately).
I think there's still quite a bit of cleanup / deduplication to be done, but hopefully this is at least a baby step in the right direction.
This is a first pass at converting the library to TypeScript. A few types should be strengthened, but at least it builds and typechecks successfully.
I had to change up the logic a bit in
extractRouteArguments, because the way it was behaving before was difficult/impossible to do with type safety.This is building for esm and cjs, including separate type definitions, using tsup. I kept a pretty low target, ES2015, for now, to ensure broad compatibility.