Sha256: 4db902706ad5679ac75e85185c2784523a2cf2885bcd31290219f091884057d2
Contents?: true
Size: 1.8 KB
Versions: 33
Compression:
Stored size: 1.8 KB
Contents
# mimic-response
> Mimic a [Node.js HTTP response stream](https://nodejs.org/api/http.html#http_class_http_incomingmessage)
## Install
```
$ npm install mimic-response
```
## Usage
```js
import {PassThrough as PassThroughStream} from 'node:stream';
import mimicResponse from 'mimic-response';
const responseStream = getHttpResponseStream();
const myStream = new PassThroughStream();
mimicResponse(responseStream, myStream);
console.log(myStream.statusCode);
//=> 200
```
## API
### mimicResponse(from, to)
**Note #1:** The `from.destroy(error)` function is not proxied. You have to call it manually:
```js
import {PassThrough as PassThroughStream} from 'node:stream';
import mimicResponse from 'mimic-response';
const responseStream = getHttpResponseStream();
const myStream = new PassThroughStream({
destroy(error, callback) {
responseStream.destroy();
callback(error);
}
});
myStream.destroy();
```
Please note that `myStream` and `responseStream` never throw. The error is passed to the request instead.
#### from
Type: `Stream`
[Node.js HTTP response stream.](https://nodejs.org/api/http.html#http_class_http_incomingmessage)
#### to
Type: `Stream`
Any stream.
## Related
- [mimic-fn](https://github.com/sindresorhus/mimic-fn) - Make a function mimic another one
- [clone-response](https://github.com/lukechilds/clone-response) - Clone a Node.js response stream
---
<div align="center">
<b>
<a href="https://tidelift.com/subscription/pkg/npm-mimic-response?utm_source=npm-mimic-response&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
</b>
<br>
<sub>
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
</sub>
</div>
Version data entries
33 entries across 33 versions & 1 rubygems