Starts a server before your Jest tests and tears it down after.
Why
jest-puppeteer works great for running tests in Jest using Puppeteer.
It's also useful for starting a local development server during the tests without letting Jest hang.
This package extracts just the local development server spawning without any ties to Puppeteer.
Install
npm install --save-dev jest-dev-server
Usage
jest-dev-server exports setup and teardown functions.
// global-setup.jsconst { setup: setupDevServer } = require("jest-dev-server");module.exports = async function globalSetup() { globalThis.servers = await setupDevServer({ command: `node config/start.js --port=3000`, launchTimeout: 50000, port: 3000, }); // Your global setup};
// global-teardown.jsconst { teardown: teardownDevServer } = require("jest-dev-server");module.exports = async function globalTeardown() { await teardownDevServer(globalThis.servers); // Your global teardown};
Specify several servers
You can specify several servers using an array of configs:
jest-dev-server use the wait-on npm package to wait for resources to become available before calling callback.
Type: object, default to {}.
delay: optional initial delay in ms, default 0
interval: optional poll resource interval in ms, default 250ms
log: optional flag which outputs to stdout, remaining resources waited on and when complete or errored
reverse: optional flag to reverse operation so checks are for resources being NOT available, default false
timeout: optional timeout in ms, default Infinity. Aborts with error
tcpTimeout: optional tcp timeout in ms, default 300ms
verbose: optional flag which outputs debug output, default false
window: optional stabilization time in ms, default 750ms. Waits this amount of time for file sizes to stabilize or other resource availability to remain unchanged