light-my-request

What is light-my-request?

The light-my-request npm package is a lightweight HTTP request simulation tool designed primarily for testing purposes. It allows developers to simulate HTTP requests to their Node.js applications without the need for a real server. This is particularly useful for testing route handlers and middleware in isolation.

What are light-my-request's main functionalities?

Simulate HTTP GET Request

This feature allows you to simulate an HTTP GET request to a given handler function. The response can then be inspected to verify the behavior of the handler.

const { inject } = require('light-my-request');
const handler = (req, res) => { res.end('Hello, world!'); };

inject(handler, { method: 'GET', url: '/' }, (err, res) => {
  console.log(res.payload); // 'Hello, world!'
});

Simulate HTTP POST Request with Payload

This feature allows you to simulate an HTTP POST request with a payload. The handler can process the payload, and the response can be inspected to verify the behavior.

const { inject } = require('light-my-request');
const handler = (req, res) => {
  let body = '';
  req.on('data', chunk => { body += chunk; });
  req.on('end', () => { res.end(`Received: ${body}`); });
};

inject(handler, { method: 'POST', url: '/', payload: 'Hello, world!' }, (err, res) => {
  console.log(res.payload); // 'Received: Hello, world!'
});

Simulate HTTP Request with Headers

This feature allows you to simulate an HTTP request with custom headers. The handler can access these headers, and the response can be inspected to verify the behavior.

const { inject } = require('light-my-request');
const handler = (req, res) => {
  res.end(`Header: ${req.headers['x-custom-header']}`);
};

inject(handler, { method: 'GET', url: '/', headers: { 'x-custom-header': 'test-value' } }, (err, res) => {
  console.log(res.payload); // 'Header: test-value'
});

Other packages similar to light-my-request

supertest

Supertest is a popular HTTP assertion library that works with any test framework. It allows you to test HTTP endpoints by making requests and asserting on the responses. Compared to light-my-request, Supertest is more feature-rich and integrates well with various testing frameworks like Mocha and Jest.

nock

Nock is an HTTP mocking and expectations library for Node.js. It allows you to intercept HTTP requests and provide predefined responses, making it useful for testing HTTP clients. Unlike light-my-request, which focuses on simulating requests to handlers, Nock is more about mocking external HTTP requests.

axios-mock-adapter

Axios-mock-adapter is a library that allows you to mock requests made using the Axios HTTP client. It provides a way to define how requests should be handled and what responses should be returned. This is different from light-my-request, which is more focused on simulating requests to server handlers rather than mocking client-side requests.

README

The README file is missing