Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Supertest lets you test a Node.js HTTP API by sending a request to the application and checking the response. A test can verify status codes, headers, response bodies, or a custom condition. Supertest provides the HTTP request and assertion layer; Mocha, Jest, or another test runner organizes and runs the tests, but Supertest does not require one particular runner.

What Supertest tests—and what it does not

A Supertest test exercises an API through its HTTP request-and-response boundary. You specify a method and path, then inspect the response the application produces. This is useful for checking observable behavior such as whether a route returns JSON with the expected status and data.

Supertest is not a test runner. Your chosen runner is responsible for discovering and executing tests and reporting failures. The official examples show Mocha, as well as use without a test framework; the request API can also be used with callback, promise, or async/await patterns.

Prepare the application for tests

Export the application separately from the code that starts the production listener. Tests can then import the application function directly, without depending on a fixed test port. Supertest accepts an application function or an HTTP server; when the server is not already listening, it binds it to an ephemeral port.

Free tools Windows power users keep installed

One-click scans. No signup required.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
#1 Best Overall
Elebase USB to USB C Adapter for iPhone 18 Pro Max,USBC Car Charger Adapter
  • Read Before You Buy — No Video Output: These adapters support charging and USB 2.0 data transfer, but cannot transmit video signals. Except for standard USB webcams (which use USB data only), they are not compatible with HDMI/DisplayPort cables, video-capable USB-C hubs, or docking stations with video output.
  • Convert USB-A Ports to USB-C: Designed to connect USB-C earphones, cables, flash drives, card readers, and other USB-C accessories to standard USB-A ports. Plug-and-play with no drivers or software required.
  • Aluminum Alloy Housing: Built with a sturdy aluminum alloy shell that aids in heat dissipation and protects against daily wear and scratches. Designed to maintain a stable and secure connection.
  • Compact & Travel-Friendly: The ultra-compact design allows the adapter to stay plugged into your device without blocking adjacent ports or adding bulk, reducing wear and tear on your original USB ports.
  • 12-Month Warranty: Backed by a 12-month manufacturer warranty for peace of mind. Designed to meet strict quality control standards for reliable everyday performance.

For example, an Express project can keep route setup in an app module and start listening in a separate entry point:

// app.js
const express = require('express');
const app = express();

app.get('/user', (req, res) => {
  res.status(200).json({ name: 'Ada' });
});

module.exports = app;

// server.js
const app = require('./app');
const port = process.env.PORT || 3000;
app.listen(port, () => console.log(`Listening on ${port}`));

The separation shown here is a project organization pattern, not a Supertest requirement. Keep your existing routes and middleware; the important point is that the test can import the app without having to start the production listener.

Install Supertest

Add Supertest as a development dependency so it is available to tests without becoming a runtime dependency of the deployed application:

npm install --save-dev supertest

At retrieval on October 3, 2026, the project package metadata listed Supertest 7.3.0 and Node.js >=14.18.0. These are time-sensitive package details, not a statement about the version in your project: check your lockfile and the package metadata when choosing a version.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Rank #2
Anker USB-C Hub, 5-in-1 USB Hub for Laptops, 4K HDMI Multiport Adapter
  • 5-in-1 USB-C Hub: Experience comprehensive connectivity featuring a Power Delivery input, two USB-A 2.0 ports, a USB-A 3.0 port, and an HDMI port. (Note: The USB-C power delivery input port is only for connecting an external wall charger to power your laptop and cannot power peripheral devices.)
  • 90W Pass-Through Charging: Achieve optimal charging with 90W pass-through power to your laptop, supported by a total input of 100W, with the hub reserving 10W for operational efficiency. (Note: Wall charger not included.)
  • Quick Data Transfers: Accelerate your productivity with rapid data transfers using a high-speed 5Gbps USB 3.0 port and two 480Mbps USB 2.0 ports.
  • 4K HDMI Display: Enhance your visual experience with a hub capable of delivering 4K resolution at 30Hz in both mirror and extend modes. Please note that this hub is compatible with MacBook (macOS 12 and newer), Windows 10 and 11, ChromeOS, and laptops equipped with DP Alt Mode and Power Delivery. Note: This device is not compatible with Linux.
  • What You Get: Anker USB-C Hub (5-in-1, 4K HDMI), welcome guide, 18-month warranty, and our friendly customer service.

Write a first route test

Import the application and pass it to Supertest’s request(). The following CommonJS example requests GET /user, checks that the response is JSON and has status 200, and verifies the body:

const request = require('supertest');
const app = require('./app');

test('GET /user returns the user as JSON', async () => {
  const response = await request(app)
    .get('/user')
    .expect('Content-Type', /json/)
    .expect(200);

  expect(response.body).toEqual({ name: 'Ada' });
});

The test() and expect() globals in this example belong to the test runner; they are not supplied by Supertest. The Supertest chain names the method and path, performs the request, and applies HTTP response assertions. You can inspect other response properties or add your own condition after the request resolves.

Choose how the test completes

Use the completion style that fits your test runner, and make sure asynchronous failures reach it. Supertest supports callback, promise, and async/await patterns.

Callback with .end()

When calling .end(), forward its error to the runner’s failure path. An assertion failure from a chained .expect() is reported through the err argument:

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Rank #3
Sale
Anker USB C Hub, 7in1 Multi-Port USB Adapter, 4K@60Hz USBC to HDMI Splitter
  • Sleek 7-in-1 USB-C Hub: Features an HDMI port, two USB-A 3.0 ports, and a USB-C data port, each providing 5Gbps transfer speeds. It also includes a USB-C PD input port for charging up to 100W and dual SD and TF card slots, all in a compact design.
  • Flawless 4K@60Hz Video with HDMI: Delivers exceptional clarity and smoothness with its 4K@60Hz HDMI port, making it ideal for high-definition presentations and entertainment. (Note: Only the HDMI port supports video projection; the USB-C port is for data transfer only.)
  • Double Up on Efficiency: The two USB-A 3.0 ports and a USB-C port support a fast 5Gbps data rate, significantly boosting your transfer speeds and improving productivity.
  • Fast and Reliable 85W Charging: Offers high-capacity, speedy charging for laptops up to 85W, so you spend less time tethered to an outlet and more time being productive.
  • What You Get: Anker USB-C Hub (7-in-1), welcome guide, 18-month warranty, and our friendly customer service.
request(app)
  .get('/user')
  .expect('Content-Type', /json/)
  .expect(200)
  .end((err, res) => {
    if (err) return done(err);
    done();
  });

Here, done is a callback provided by a runner that supports callback-style tests. Omitting done(err) can cause an assertion failure not to fail the test correctly.

Runner callback passed to .expect()

The documented Mocha-style example passes the runner’s completion callback to the final expectation:

it('gets the user', function (done) {
  request(app)
    .get('/user')
    .expect(200, done);
});

This is a runner integration example, not a requirement to use Mocha.

Promise or async/await

For promise-based runners, return the request promise or await it in an async test. These styles avoid manually signaling completion with done:

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Rank #4
Sale
UGREEN USB to USB C Adapter Combo 4-Pack, 10Gbps USB C Converter Space Gray
  • Dual Converters, Infinite Potential:Includes 2× USB C male to USB A female adapters and 2× USB A male to USB C female adapters. Perfect for a wide range of uses—tablets with Bluetooth keyboards, expand USB ports on macbook, and more. Two different converters for all your daily needs
  • Next-Level 10Gbps & 3A Charging: No more slow 480Mbps, this usb to usb c adapter has a transfer speed of up to 10Gbps, allowing you to do more transferring in less time. This usb adapter fits both USB A and USB C charger, supporting up to 3A fast charging
  • Upgraded Exquisite Craftsmanship: With an aluminum alloy housing and metal connector, the usbc to usb adapter is extremely durable and sturdy. Rigorously tested to withstand more than 10,000 times of plugging and unplugging, ensuring long-lasting performance
  • Broad Compatible: The usb c to usb adapter widely supports all USB C/ USB A devices like laptops, tablets, cellphones, car chargers, and phone chargers. Such as compatible with MacBook Pro/Air 2023/2022, Thunderbolt 4/3 Devices,Apple MagSafe Watch 9/8/7/SE/Ultra, iPad Pro 2022/2021, Samsung Galaxy S23/S20/S10, and iPhone 17/16/15 Pro. Plug and play
  • Please Note: To reach 10Gbps speed, keep the cable under 3.3 ft. For USB A Male to USB C adapters, try flipping the USB C connector. USB C Male to USB A adapters support bidirectional 10Gbps transfer within 3.3 ft
it('gets the user', function () {
  return request(app)
    .get('/user')
    .expect(200);
});

it('checks the user body', async function () {
  const res = await request(app).get('/user').expect(200);
  expect(res.body.name).toBe('Ada');
});

Assertions chained before .end() run in their declared order. Prefer one consistent asynchronous style within a test and follow the conventions of your runner.

Test a sequence that depends on cookies

A plain request(app) call is suitable for an independent request. For a sequence that needs client state—such as a cookie set by one response and sent with a later request—create an agent with request.agent(app) and reuse it:

const request = require('supertest');
const app = require('./app');

test('keeps the session cookie between requests', async () => {
  const agent = request.agent(app);

  await agent
    .post('/login')
    .send({ username: 'ada', password: 'example' })
    .expect(200);

  const response = await agent
    .get('/account')
    .expect(200);

  expect(response.body.username).toBe('ada');
});

The route names, credentials, and expected response in this example are illustrative; adapt them to your application. The agent carries request state such as cookies across its requests. Database setup, test-data isolation, and cleanup depend on the application and are not prescribed by Supertest.

Common problems and fixes

  • The test hangs or finishes before the request: return the request promise or await it, or use the runner’s callback pattern and call it once. An asynchronous test must signal completion to its runner.
  • An assertion in a callback does not fail the test: when using .end(), pass its error to the runner as done(err) rather than ignoring it.
  • A later route does not receive the expected cookie: use the same request.agent(app) instance for both requests; separate request(app) calls do not represent one persistent agent.
  • The test cannot import the application cleanly: separate app construction/export from the production call to listen(), then pass the imported app to request().
  • The installed package does not match an example’s compatibility assumptions: check the project’s lockfile and current package metadata; the version and Node.js requirement reported at retrieval may have changed.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

HTTP/2 and other request needs

The official Supertest README also documents an HTTP/2 option. Use that mode only when the application/server and project requirements call for HTTP/2; ordinary HTTP request examples are the simpler default. For exact current options beyond the workflows shown here, consult the Supertest project repository.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Best Value
Anker USB C Hub, 5-in-1 USBC to HDMI Splitter with 4K Display
  • 5-in-1 Connectivity: Equipped with a 4K HDMI port, a 5 Gbps USB-C data port, two 5 Gbps USB-A ports, and a USB C 100W PD-IN port. Note: The USB C 100W PD-IN port supports only charging and does not support data transfer devices such as headphones or speakers.
  • Powerful Pass-Through Charging: Supports up to 85W pass-through charging so you can power up your laptop while you use the hub. Note: Pass-through charging requires a charger (not included). Note: To achieve full power for iPad, we recommend using a 45W wall charger.
  • Transfer Files in Seconds: Move files to and from your laptop at speeds of up to 5 Gbps via the USB-C and USB-A data ports. Note: The USB C 5Gbps Data port does not support video output.
  • HD Display: Connect to the HDMI port to stream or mirror content to an external monitor in resolutions of up to 4K@30Hz. Note: The USB-C ports do not support video output.
  • What You Get: Anker 332 USB-C Hub (5-in-1), welcome guide, our worry-free 18-month warranty, and friendly customer service.

Or skip the browser setup

Supertest is for exercising an API’s HTTP behavior in tests. If you also need a website screenshot, ScreenshotNeo is a separate screenshot API and MCP server, not a replacement for API tests. Its one-call request can return a screenshot or PDF:

curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webp

See the ScreenshotNeo API documentation for request details. ScreenshotNeo removes cookie banners, popups, and chat widgets before capture; bot checks, blank pages, and failed loads are not billed. Its MCP server lets AI agents take screenshots. The Free plan includes 1,000 screenshots a month with no card, and paid plans start at $5 for 3,000. Learn about ScreenshotNeo or sign up free.

Frequently Asked Questions

Do I need Mocha or Jest to use Supertest?

No. Supertest supplies the HTTP request and assertion layer; a test runner is optional, though commonly used to organize and execute tests.

Can I test an app without starting it on a fixed port?

Yes. Pass the application function to `request(app)`; Supertest binds it to an ephemeral port when needed.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.