clone-response

What is clone-response?

The clone-response npm package is designed to clone HTTP response streams. This is particularly useful when you need to consume a response stream multiple times, for example, when you want to cache a response object for later use while still processing it immediately. It allows for the duplication of response objects in a way that each clone can be treated as an independent response.

What are clone-response's main functionalities?

Cloning HTTP Response Streams

This feature allows you to clone an HTTP response stream. In the provided code sample, an HTTP GET request is made, and the response is cloned using clone-response. Both the original and the cloned response can then be consumed independently, demonstrated by piping them to the standard output.

"use strict";
const http = require('http');
const cloneResponse = require('clone-response');

http.get('http://example.com', res => {
  const clonedResponse = cloneResponse(res);
  // Now you can consume `res` and `clonedResponse` independently.
  res.pipe(process.stdout);
  clonedResponse.pipe(process.stdout);
});

Other packages similar to clone-response

http-response-object

While not a direct clone utility, http-response-object offers a way to create and manipulate HTTP response objects in Node.js. It can be used in conjunction with other tools to achieve similar outcomes as clone-response, especially in scenarios where responses need to be reconstructed rather than cloned.

README

clone-response

Clone a Node.js HTTP response stream

Returns a new stream and copies over all properties and methods from the original response giving you a complete duplicate.

This is useful in situations where you need to consume the response stream but also want to pass an unconsumed stream somewhere else to be consumed later.

Install

npm install clone-response

Usage

import http from 'node:http';
import cloneResponse from 'clone-response';

http.get('http://example.com', response => {
	const clonedResponse = cloneResponse(response);
	response.pipe(process.stdout);

	setImmediate(() => {
		// The response stream has already been consumed by the time this executes,
		// however the cloned response stream is still available.
		doSomethingWithResponse(clonedResponse);
	});
});

Please bear in mind that the process of cloning a stream consumes it. However, you can consume a stream multiple times in the same tick, therefore allowing you to create multiple clones. For example:

const clone1 = cloneResponse(response);
const clone2 = cloneResponse(response);
// The response can still be consumed in this tick but cannot be consumed if passed
// into any async callbacks. clone1 and clone2 can be passed around and be
// consumed in the future.

API

cloneResponse(response)

Returns a clone of the passed in response stream.

response

Type: Stream

A Node.js HTTP response stream to clone.