A minimal but customizable Express server for testing
Typescript based preconfigured Express application intended for quick testing requests and responses, it can can be customized to listen for HTTP and HTTPS traffic and alter the default body parser behavior.
The following Content-Type
headers will be parsed and exposed via req.body
:
- JSON (
application/json
) - Text (
text/plain
) - URL-Encoded (
application/x-www-form-urlencoded
) - Buffer (
application/octet-stream
)
npm install --save-dev @b4dnewz/express-test-server
import createServer from "@b4dnewz/express-test-server"
const server = await createServer({
// server options
});
// Express route handler
server.get('/foo', (req, res) => {
res.send('bar');
});
// Express alternative route handlers
server.get('/bar', () => 'foo');
server.get('/baz', 'foo');
import createServer from "@b4dnewz/express-test-server"
let server;
beforeAll(async () => {
server = await createServer();
});
afterAll(async () => {
await server.close();
});
it("respond to get requests", async () => {
sever.get("/foo", "bar")
const {body} = await got(`${server.url}/foo`)
expect(body).toEqual("bar")
})
port (default 0)
Specify a custom port for the HTTP server instance, otherwise it will automatically choose a random free TCP port
await createServer({
port: 8888
})
sslPort (default 443)
Specify a custom port for the HTTPS server instance, otherwise it will try to default ssl port
await createServer({
sslPort: 4443
})
hostname (default localhost)
Specify a custom hostname for both HTTP and HTTPS servers, remember that you need a resolvable DNS host name for this to work.
await createServer({
hostname: "0.0.0.0"
})
await createServer({
hostname: "test.example.com"
})
listen (default true)
If false will prevent the test server to automatically start to listen for requests when instanciated.
const server = await createServer({
listen: false
})
// listen later on a desired port
await server.listen({
port: 8888
})
MIT