msw-storybook-addon
Version:
Mock APIs in Storybook using Mock Service Worker.
35 lines • 1.16 kB
text/typescript
import { t as SetupFunction } from "./addon-6GrjDtLF.mjs";
import { AnyHandler } from "msw";
import { LoaderFunction, Renderer } from "storybook/internal/types";
//#region src/csf3.d.ts
type MswParameter = Array<AnyHandler> | {
handlers?: Array<AnyHandler> | Record<string, AnyHandler | Array<AnyHandler>>;
};
declare module 'storybook/internal/csf' {
interface Parameters {
msw?: MswParameter;
}
}
/**
* Create a loader to initialize Mock Service Worker. This is the supported
* integration for CSF 3.0 projects.
*
* Deprecated when using CSF Next: use the preview annotations (`addonMsw()`)
* instead. Run `npx msw-storybook-migrate` to migrate automatically. See the
* {@link https://github.com/mswjs/msw-storybook-addon/blob/main/MIGRATION.md#from-2xx-to-3xx migration guide}
* for details.
*
* @example
* // .storybook/preview.ts
* import { mswLoader } from 'msw-storybook-addon/csf3'
*
* export default {
* loaders: [mswLoader()],
* parameters: {
* msw: [...initialHandlers]
* }
* }
*/
declare function mswLoader(setup?: SetupFunction): LoaderFunction<Renderer>;
//#endregion
export { MswParameter, mswLoader };