Type Alias SetupServerOrWorker

Type declaration

• listHandlers: (() => RequestHandler[])

  Return the list of current request handlers.

  See

  • MSW docs for SetupServer.listHandlers()
  • MSW docs for SetupWorker.listHandlers()
  • • (): RequestHandler[]

    • Returns RequestHandler[]

• resetHandlers: ((...handlers: RequestHandler[]) => void)

  Reset request handlers to the initial list.

  See

  • MSW docs for SetupServer.resetHandlers()
  • MSW docs for SetupWorker.resetHandlers()
  • • (...handlers): void

    • Parameters

      • Rest...handlers: RequestHandler[]

      Returns void

• restoreHandlers: (() => void)

  Mark used one-time request handlers as unused.

  See

  • MSW docs for SetupServer.restoreHandlers()
  • MSW docs for SetupWorker.restoreHandlers()
  • • (): void

    • Returns void

• start: ((options?: SetupServerOrWorkerOptions) => Promise<void>)

  Start request interception.

  See

  • MSW docs for SetupServer.listen()
  • MSW docs for SetupWorker.start()
  • • (options?): Promise<void>

    • Parameters

      • Optionaloptions: SetupServerOrWorkerOptions

        Options for starting the server or worker.

      Returns Promise<void>

• stop: (() => void)

  Stop request interception.

  See

  • MSW docs for SetupServer.close()
  • MSW docs for SetupWorker.stop()
  • • (): void

    • Returns void

• Readonlytype: "server" | "worker"

  A type indicating whether this is a server or a worker.

• use: ((...handlers: RequestHandler[]) => void)

  Prepend request handlers to the current worker instance.

  See

  • MSW docs for SetupServer.use()
  • MSW docs for SetupWorker.use()
  • • (...handlers): void

    • Parameters

      • Rest...handlers: RequestHandler[]

      Returns void