@jnode/request

Simple HTTP(S) requesting package for Node.js.

Installation

npm i @jnode/request@beta

Quick start

Import

const { request, FormPart } = require('@jnode/request');

Make a request

request('GET', 'https://example.com/').then((res) => {
  console.log(res.text());
});

Make a multipart/form-body request

request('POST', 'https://example.com/', [
  new FormPart('foo', 'bar'),
  new FormPart('awa', 'uwu')
]).then((res) => {
  console.log(res.text());
});

Reference

request.request(method, url[, body, headers, options])

• method <string> A string specifying the HTTP request method. Default: 'GET'.
• url <string> | <URL> The target URL to request, support both http and https.
• body <string> | <Buffer> | <Uint8Array> | <stream.Readable> | <URLSearchParams> | <request.FormPart[]> | <Object[]> The request body. Using <URLSearchParams> will send a application/x-www-form-urlencoded request; using <request.FormPart[]> or <Object[]> will send a multipart/form-body request.
• headers <Object> An object containing request headers. Content-Length is automatically calculated for <string>, <Buffer>, <Uint8Array>, or <URLSearchParams> body. And Content-Type will be force replaced while sending a multipart/form-body request with <FormPart[]> or <Object[]> body.
• options <Object>
  • multipart <string> Multipart type. Default: 'form-body'.
  • options in http.request().
• Returns: <request.RequestResponse>

Make a HTTP(S) request.

Class: request.FormPart

new request.FormPart(name, body[, headers, options])

• name <string> Name of the part.
• body <string> | <Buffer> | <Uint8Array> | <stream.Readable> | <URLSearchParams> The body of the part. Using <URLSearchParams> will create a application/x-www-form-urlencoded part.
• headers <Object> An object containing part headers. There is a special filename field, will be added to Content-Disposition.
• options <Object>
  • filename <string> File name.
  • disposition <string> Part disposition. Default: 'form-data'.

Class: request.RequestResponse

new request.RequestResponse(res)

• res <http.IncomingMessage> The original node:http response object.

requestResponse.res

• Type: <http.IncomingMessage>

requestResponse.statusCode

• Type: <number>

The response HTTP status code.

requestResponse.headers

• Type: <Object>

The response HTTP headers.

requestResponse._body

• Type: <Buffer>

Notice: You should avoid reading this property directly, use requestRespond.buffer() instead.

requestResponse.buffer()

• Returns: <Promise> Fulfills with a <Buffer> object.

Receives the body of the response stream and return as a buffer.

requestResponse.text([encoding])

• encoding <string> The character encoding to use. Default: 'utf8'.
• Returns: <Promise> Fulfills with a string.

Receives the body of the response stream and return as a string.

requestResponse.json([encoding])

• encoding <string> The character encoding to use. Default: 'utf8'.
• Returns: <Promise> Fulfills with any of <Object>, <Array>, <string>, <number>, <boolean>, or <null>.

Receives the body of the response stream and parse string as JSON.

requestResponse.rl()

• Returns: <readline.Interface>

Provides an interface for reading data from response one line at a time.

requestResponse.sse()

• Returns: <request.EventReceiver>

Provides an interface for reading data from response as Server-Sent Events (SSE, text/event-stream).

Class: request.EventReceiver

• Extends: <EventEmitter>

An interface for reading data from <stream.Readable> as Server-Sent Events (SSE, text/event-stream).

new request.EventReceiver(res)

• res <stream.Readable> The response stream or any readable stream.

Event: 'close'

Emitted when the request has been completed.

Event: 'event'

• event <Object>
  • data <string> The full data string of this event.
  • event <string> The event name.
  • id <string> The event id.

eventReceiver.res

• Type: <stream.Readable>

The response stream or any readable stream.

eventReceiver.rl

• Type: <readline.Interface>

An interface for reading data from response one line at a time.

eventReceiver[Symbol.asyncIterator]()

• Returns: <AsyncIterator>

Create an AsyncIterator object that iterates through each event as an object. This method allows asynchronous iteration of InterfaceConstructor objects through for await...of loops.

for await (const event of eventReceiver) {
    // Each event in the event stream will be successively available here as
    // { data, event, id }
}