blob: c99c4db2cac0180ba89abf1fc87505b9d048eef0 (
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
76
77
78
79
80
81
82
83
84
85
86
|
import {Buffer} from 'node:buffer';
import {Readable as ReadableStream} from 'node:stream';
export type Options = {
/**
The HTTP response status code.
*/
readonly statusCode: number;
/**
The HTTP headers object.
Keys are in lowercase.
*/
readonly headers: Record<string, string>;
/**
The response body.
The contents will be streamable but is also exposed directly as `response.body`.
*/
readonly body: Buffer;
/**
The request URL string.
*/
readonly url: string;
};
/**
Returns a streamable response object similar to a [Node.js HTTP response stream](https://nodejs.org/api/http.html#http_class_http_incomingmessage).
@example
```
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!'
```
*/
export default class Response extends ReadableStream {
/**
The HTTP response status code.
*/
readonly statusCode: number;
/**
The HTTP headers.
Keys will be automatically lowercased.
*/
readonly headers: Record<string, string>;
/**
The response body.
*/
readonly body: Buffer;
/**
The request URL string.
*/
readonly url: string;
constructor(options?: Options);
}
|
