Optional callback: ((res: "http".IncomingMessage) => void)Optional callback: ((res: "http".IncomingMessage) => void)options in socket.connect() are also supported.
Node.js maintains several connections per server to make HTTP requests. This function allows one to transparently issue requests.
url can be a string or a URL object. If url is a
string, it is automatically parsed with new URL(). If it is a URL object, it will be automatically converted to an ordinary options object.
If both url and options are specified, the objects are merged, with theoptions properties taking precedence.
The optional callback parameter will be added as a one-time listener for
the 'response' event.
http.request() returns an instance of the ClientRequest class. The ClientRequest instance is a writable stream. If one needs to
upload a file with a POST request, then write to the ClientRequest object.
const http = require('http');
const postData = JSON.stringify({
'msg': 'Hello World!'
});
const options = {
hostname: 'www.google.com',
port: 80,
path: '/upload',
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Content-Length': Buffer.byteLength(postData)
}
};
const req = http.request(options, (res) => {
console.log(`STATUS: ${res.statusCode}`);
console.log(`HEADERS: ${JSON.stringify(res.headers)}`);
res.setEncoding('utf8');
res.on('data', (chunk) => {
console.log(`BODY: ${chunk}`);
});
res.on('end', () => {
console.log('No more data in response.');
});
});
req.on('error', (e) => {
console.error(`problem with request: ${e.message}`);
});
// Write data to request body
req.write(postData);
req.end();
In the example req.end() was called. With http.request() one
must always call req.end() to signify the end of the request -
even if there is no data being written to the request body.
If any error is encountered during the request (be that with DNS resolution,
TCP level errors, or actual HTTP parse errors) an 'error' event is emitted
on the returned request object. As with all 'error' events, if no listeners
are registered the error will be thrown.
There are a few special headers that should be noted.
'continue' event should be set. See RFC 2616 Section 8.2.3 for more
information.auth option
to compute basic authentication.Example using a URL as options:
const options = new URL('http://abc:xyz@example.com');
const req = http.request(options, (res) => {
// ...
});
In a successful request, the following events will be emitted in the following order:
'socket''response''data' any number of times, on the res object
('data' will not be emitted at all if the response body is empty, for
instance, in most redirects)'end' on the res object'close'In the case of a connection error, the following events will be emitted:
'socket''error''close'In the case of a premature connection close before the response is received, the following events will be emitted in the following order:
'socket''error' with an error with message 'Error: socket hang up' and code'ECONNRESET''close'In the case of a premature connection close after the response is received, the following events will be emitted in the following order:
'socket''response''data' any number of times, on the res object'aborted' on the res object'error' on the res object with an error with message'Error: aborted' and code 'ECONNRESET'.'close''close' on the res objectIf req.destroy() is called before a socket is assigned, the following
events will be emitted in the following order:
req.destroy() called here)'error' with an error with message 'Error: socket hang up' and code'ECONNRESET''close'If req.destroy() is called before the connection succeeds, the following
events will be emitted in the following order:
'socket'req.destroy() called here)'error' with an error with message 'Error: socket hang up' and code'ECONNRESET''close'If req.destroy() is called after the response is received, the following
events will be emitted in the following order:
'socket''response''data' any number of times, on the res objectreq.destroy() called here)'aborted' on the res object'error' on the res object with an error with message'Error: aborted' and code 'ECONNRESET'.'close''close' on the res objectIf req.abort() is called before a socket is assigned, the following
events will be emitted in the following order:
req.abort() called here)'abort''close'If req.abort() is called before the connection succeeds, the following
events will be emitted in the following order:
'socket'req.abort() called here)'abort''error' with an error with message 'Error: socket hang up' and code'ECONNRESET''close'If req.abort() is called after the response is received, the following
events will be emitted in the following order:
'socket''response''data' any number of times, on the res objectreq.abort() called here)'abort''aborted' on the res object'error' on the res object with an error with message'Error: aborted' and code 'ECONNRESET'.'close''close' on the res objectSetting the timeout option or using the setTimeout() function will
not abort the request or do anything besides add a 'timeout' event.
Passing an AbortSignal and then calling abort on the correspondingAbortController will behave the same way as calling .destroy() on the
request itself.
Optional callback: ((res: "http".IncomingMessage) => void)Optional callback: ((res: "http".IncomingMessage) => void)Generated using TypeDoc
optionsinsocket.connect()are also supported.Node.js maintains several connections per server to make HTTP requests. This function allows one to transparently issue requests.
urlcan be a string or aURLobject. Ifurlis a string, it is automatically parsed withnew URL(). If it is aURLobject, it will be automatically converted to an ordinaryoptionsobject.If both
urlandoptionsare specified, the objects are merged, with theoptionsproperties taking precedence.The optional
callbackparameter will be added as a one-time listener for the'response'event.http.request()returns an instance of the ClientRequest class. TheClientRequestinstance is a writable stream. If one needs to upload a file with a POST request, then write to theClientRequestobject.In the example
req.end()was called. Withhttp.request()one must always callreq.end()to signify the end of the request - even if there is no data being written to the request body.If any error is encountered during the request (be that with DNS resolution, TCP level errors, or actual HTTP parse errors) an
'error'event is emitted on the returned request object. As with all'error'events, if no listeners are registered the error will be thrown.There are a few special headers that should be noted.
'continue'event should be set. See RFC 2616 Section 8.2.3 for more information.authoption to compute basic authentication.Example using a
URLasoptions:In a successful request, the following events will be emitted in the following order:
'socket''response''data'any number of times, on theresobject ('data'will not be emitted at all if the response body is empty, for instance, in most redirects)'end'on theresobject'close'In the case of a connection error, the following events will be emitted:
'socket''error''close'In the case of a premature connection close before the response is received, the following events will be emitted in the following order:
'socket''error'with an error with message'Error: socket hang up'and code'ECONNRESET''close'In the case of a premature connection close after the response is received, the following events will be emitted in the following order:
'socket''response''data'any number of times, on theresobject'aborted'on theresobject'error'on theresobject with an error with message'Error: aborted'and code'ECONNRESET'.'close''close'on theresobjectIf
req.destroy()is called before a socket is assigned, the following events will be emitted in the following order:req.destroy()called here)'error'with an error with message'Error: socket hang up'and code'ECONNRESET''close'If
req.destroy()is called before the connection succeeds, the following events will be emitted in the following order:'socket'req.destroy()called here)'error'with an error with message'Error: socket hang up'and code'ECONNRESET''close'If
req.destroy()is called after the response is received, the following events will be emitted in the following order:'socket''response''data'any number of times, on theresobjectreq.destroy()called here)'aborted'on theresobject'error'on theresobject with an error with message'Error: aborted'and code'ECONNRESET'.'close''close'on theresobjectIf
req.abort()is called before a socket is assigned, the following events will be emitted in the following order:req.abort()called here)'abort''close'If
req.abort()is called before the connection succeeds, the following events will be emitted in the following order:'socket'req.abort()called here)'abort''error'with an error with message'Error: socket hang up'and code'ECONNRESET''close'If
req.abort()is called after the response is received, the following events will be emitted in the following order:'socket''response''data'any number of times, on theresobjectreq.abort()called here)'abort''aborted'on theresobject'error'on theresobject with an error with message'Error: aborted'and code'ECONNRESET'.'close''close'on theresobjectSetting the
timeoutoption or using thesetTimeout()function will not abort the request or do anything besides add a'timeout'event.Passing an
AbortSignaland then callingaborton the correspondingAbortControllerwill behave the same way as calling.destroy()on the request itself.