Question 1

How to test file uploads with supertest?

Accepted Answer

Use the .attach() method inherited from superagent, such as .attach('avatar', 'path/to/file.jpg') in a POST request. The README shows an example with multipart uploads, making it straightforward for testing file submissions.

Question 2

Supertest vs axios for API testing?

Accepted Answer

Supertest is designed for testing HTTP servers with a fluent assertion API, while axios is a general HTTP client. Supertest is better for integration tests with built-in assertions, whereas axios often requires additional libraries like Jest for assertions.

Question 3

How to handle cookies in supertest tests?

Accepted Answer

Use request.agent() to persist cookies across requests and the cookies() helper for assertions. The README provides examples with .expect(cookies.set(...)) for testing cookie properties like domain and httpOnly flags.

Question 4

Can supertest be used with Jest?

Accepted Answer

Yes, supertest is framework agnostic and works seamlessly with Jest. You can use it in Jest test cases with async/await or promises, as demonstrated in the async/await example in the README.

Question 5

How to test HTTP/2 endpoints with supertest?

Accepted Answer

Pass { http2: true } as an option when calling request(app, { http2: true }). This enables HTTP/2 support, and the README includes a dedicated example showing how to configure it for GET requests.

Question 6

Best practices for error handling in supertest?

Accepted Answer

Always include .expect() for status codes to avoid errors being silently passed to callbacks. Use .end() with proper error checking, as illustrated in the callback examples where err is passed to done() to fail tests appropriately.

Supertest

What is Supertest?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions