Registry / http-networking / http-response-object

http-response-object

library3.0.2jsnpmunverified

http-response-object is a minimalistic JavaScript library designed to encapsulate HTTP response data into a simple, consistent object. It provides a standardized structure for common response properties such as `statusCode`, `headers`, `body`, and `url`, which simplifies handling and passing HTTP responses across different application layers. The current stable version is 3.0.2. While the project maintains a focused scope, it receives updates to ensure compatibility and address specific use cases. Key differentiators include its lightweight design, explicit support for both Node.js `Buffer` and `String` for the response body, and the inclusion of TypeScript types, which enhance developer experience through strong type checking. It is frequently employed in contexts requiring a normalized representation of HTTP responses, such as in HTTP client abstractions, proxy implementations, or server-side rendering logic, offering a predictable interface for response data.

http-networking serialization

npm install http-response-object

github ↗package ↗

INSTALL

IMPORT

SIG · HTTP-RESPONSE-OBJE

http-response-object

http-networkingjavascriptv3.0.2

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Response

✓ import Response from 'http-response-object';

✗ import { Response } from 'http-response-object';

The primary export is a default class, as commonly used for single-purpose libraries.

Response (CommonJS)

✓ const Response = require('http-response-object');

✗ const { Response } = require('http-response-object');

As shown in the official documentation, the module exports the Response class directly.

Response type

✓ import type Response from 'http-response-object';

✗ import { Response } from 'http-response-object';

When only importing the type for TypeScript, use the default import syntax with 'type'.

This quickstart demonstrates how to create `Response` objects for both successful and error scenarios, access their properties, and utilize the `getBody()` method, including handling its error-throwing behavior for non-2xx status codes. It also highlights the automatic lowercasing of header keys.

import Response from 'http-response-object'; // Create a successful response with Buffer body const successResponse = new Response( 200, { 'Content-Type': 'application/json', 'Cache-Control': 'no-cache' }, Buffer.from(JSON.stringify({ message: 'Operation successful!' })), 'https://api.example.com/resource' ); console.log(`Success Status: ${successResponse.statusCode}`); // 200 console.log(`Content-Type header (auto-lowercased): ${successResponse.headers['content-type']}`); // application/json console.log(`Body (decoded): ${successResponse.body.toString()}`); // {"message":"Operation successful!"} try { // getBody() returns the body for 2xx status codes const successfulBody = successResponse.getBody().toString(); console.log(`Decoded body via getBody(): ${successfulBody}`); } catch (e) { console.error('Unexpected error on successful getBody():', e); } // Create an error response with a string body const errorResponse = new Response( 404, { 'X-Trace-ID': 'req-12345' }, 'Resource Not Found', 'https://api.example.com/non-existent' ); console.log(`Error Status: ${errorResponse.statusCode}`); // 404 console.log(`Trace ID header: ${errorResponse.headers['x-trace-id']}`); // req-12345 try { // getBody() throws an error for non-2xx status codes errorResponse.getBody(); } catch (e: any) { console.log(`Caught expected error for 404: ${e.message}`); // Example: 'Response status code 404 is not 2xx' console.log(`Error object has statusCode property: ${e.statusCode}`); // 404 console.log(`Error object has headers property: ${JSON.stringify(e.headers)}`); // { "x-trace-id": "req-12345" } console.log(`Error object has url property: ${e.url}`); // https://api.example.com/non-existent }

Debug

Known issues

gotchaThe `headers` object keys are automatically converted to lowercase upon instantiation. If you rely on case-sensitive header names, this will lead to unexpected behavior.

fix

Always access headers using their lowercase form (e.g., `response.headers['content-type']`) or normalize keys before comparison.

affects: >=1.0.0

gotchaThe `getBody()` method will throw an error if the `statusCode` of the response is not in the 2xx range. This is designed to enforce checking for successful HTTP responses before attempting to process the body.

fix

Always wrap calls to `getBody()` in a `try...catch` block or ensure `statusCode` is 2xx before calling it. The thrown error object will contain `statusCode`, `headers`, `body`, and `url` properties for inspection.

affects: >=1.0.0

gotchaThe `body` property can be either a `Buffer` (typical for Node.js server-side) or a `String` (potentially for lighter-weight clients). Be consistent in your application's handling or always convert to your desired type.

fix

If expecting a string, call `.toString()` on `response.body`. If expecting a Buffer, ensure inputs are always Buffers or convert strings to Buffers explicitly.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Response status code 401 is not 2xx

Attempting to call `response.getBody()` on a Response object with a non-2xx (e.g., 4xx or 5xx) HTTP status code.

fix

Implement a `try...catch` block around `response.getBody()` or explicitly check `response.statusCode` to be within the 200-299 range before calling `getBody()`.

TypeError: Cannot read properties of undefined (reading 'someHeader')

Attempting to access a header with an incorrect or case-sensitive key, or a header that does not exist. `http-response-object` automatically lowercases all header keys.

fix

Always access headers using their lowercase names (e.g., `response.headers['content-type']` instead of `response.headers['Content-Type']`). Verify the header exists before accessing if it's optional.

Upgrade

Version history

3.0.2latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

13 hits · last 30 days

node

Resources

githubhttps://github.com/ForbesLindesay/http-response-object ↗

packagehttps://www.npmjs.com/package/http-response-object ↗