getWorker() TS issue

[robcaldecott]

[email protected] 
[email protected]

This is odd, the following code generates a TS error even though on the face of it the types look OK:

import { getWorker } from "msw-storybook-addon";

afterAll(() => {
  // ts(2339) error
  getWorker().close();
});

It seems to think close is missing from SetupApi but that doesn't make sense.

I have created a sample repo here:

https://github.com/robcaldecott/msw-storybook-addon-type-errors

Current workarounds are either // @ts-ignore or this:

import { SetupServerApi } from "msw/lib/types/node";

afterAll(() => {
  (getWorker() as SetupServerApi).close();
});

Better ideas are welcome.

[kettanaito]

Hey, @robcaldecott. Thanks for reaching out.

We need to improve on our type annotations (and also rename getWorker, it made me believe you're referring to the Service Worker, when, in fact, the add-on properly assigns the api to the worker/server depending on the environment).

I wonder if one can do conditional types based on the environment. The least we can do right now is to make getWorker a generic function so that you could use it like this:

getWorker<SetupServerApi>().close()