blob: 51b5ecd632a6fcc8f050e661991d34b330900d1a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# responselike
> A response-like object for mocking a Node.js HTTP response stream
Returns a streamable response object similar to a [Node.js HTTP response stream](https://nodejs.org/api/http.html#http_class_http_incomingmessage). Useful for formatting cached responses so they can be consumed by code expecting a real response.
## Install
```sh
npm install responselike
```
## Usage
```js
import Response from 'responselike';
const response = new Response({
statusCode: 200,
headers: {
foo: 'bar'
},
body: Buffer.from('Hi!'),
url: 'https://example.com'
});
response.statusCode;
// 200
response.headers;
// {foo: 'bar'}
response.body;
// <Buffer 48 69 21>
response.url;
// 'https://example.com'
response.pipe(process.stdout);
// 'Hi!'
```
## API
### new Response(options?)
Returns a streamable response object similar to a [Node.js HTTP response stream](https://nodejs.org/api/http.html#http_class_http_incomingmessage).
#### options
Type: `object`
##### statusCode
Type: `number`
The HTTP response status code.
##### headers
Type: `object`
The HTTP headers. Keys will be automatically lowercased.
##### body
Type: `Buffer`
The response body. The Buffer contents will be streamable but is also exposed directly as `response.body`.
##### url
Type: `string`
The request URL string.
|
