index.d.ts 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. import { IncomingMessage, ServerResponse } from 'http';
  2. import { Plugin } from 'vite';
  3. interface ViteMockOptions {
  4. mockPath?: string;
  5. configPath?: string;
  6. ignore?: RegExp | ((fileName: string) => boolean);
  7. watchFiles?: boolean;
  8. localEnabled?: boolean;
  9. prodEnabled?: boolean;
  10. injectFile?: string;
  11. injectCode?: string;
  12. /**
  13. * @deprecated Deprecated after 2.8.0
  14. */
  15. supportTs?: boolean;
  16. logger?: boolean;
  17. }
  18. declare type MethodType = 'get' | 'post' | 'put' | 'delete' | 'patch';
  19. declare type Recordable<T = any> = Record<string, T>;
  20. declare interface MockMethod {
  21. url: string;
  22. method?: MethodType;
  23. timeout?: number;
  24. statusCode?: number;
  25. response?: ((opt: {
  26. url: Recordable;
  27. body: Recordable;
  28. query: Recordable;
  29. headers: Recordable;
  30. }) => any) | any;
  31. rawResponse?: (req: IncomingMessage, res: ServerResponse) => void;
  32. }
  33. interface NodeModuleWithCompile extends NodeModule {
  34. _compile(code: string, filename: string): any;
  35. }
  36. declare function viteMockServe(opt: ViteMockOptions): Plugin;
  37. export { MethodType, MockMethod, NodeModuleWithCompile, Recordable, ViteMockOptions, viteMockServe };