Extract URL from Node.js HTTP ClientRequest

1.1.0 · maintenance · verified Wed Apr 22

The `http-request-to-url` package provides a focused utility function designed to extract the complete URL (including protocol, host, port, path, and query string) from a Node.js `http.ClientRequest` object. This is particularly useful in scenarios where an outgoing HTTP request has been initiated, and its full destination URL needs to be programmatically determined for purposes such as logging, proxying, or debugging. The package currently resides at version 1.1.0. Given its last commit date in 2019, it appears to be in a maintenance state, offering stable functionality primarily for CommonJS environments and leveraging standard Node.js `http` module properties without frequent updates or new feature development. Its differentiator is its singular purpose, directly addressing the extraction of a URL from a low-level Node.js request object.

Common errors

```
SyntaxError: Named export 'httpRequestToUrl' not found (module "http-request-to-url" does not have an export named 'httpRequestToUrl')
```
cause Attempting to use ES module named import syntax (`import { httpRequestToUrl } from 'http-request-to-url'`) for a CommonJS-only package.

fix Change the import statement to `const httpRequestToUrl = require('http-request-to-url');`
```
TypeError: httpRequestToUrl is not a function
```
cause This error typically occurs if `require('http-request-to-url')` does not correctly resolve to the intended function, possibly due to incorrect import handling or package corruption.

fix Ensure the package is correctly installed (`npm install http-request-to-url`) and verify the `require` statement is exactly `const httpRequestToUrl = require('http-request-to-url');`

Warnings

gotcha The package is CommonJS-only and does not provide native ES module support. Attempting to use `import` syntax directly in an ES module context will fail unless transpiled or using Node.js's CJS interop for default exports.
Fix: Use `const httpRequestToUrl = require('http-request-to-url');` for CommonJS environments. For ES modules, consider a wrapper or transpilation if strict ESM import is required.
gotcha The package has not been updated since 2019. While its core functionality is simple and relies on stable Node.js APIs, it may not receive updates for newer Node.js versions, security patches, or feature enhancements.
Fix: Evaluate if the current version meets your project's security and compatibility requirements. For critical applications, consider auditing the source code or forking it for maintenance.

Install

npm install http-request-to-url npm
yarn add http-request-to-url yarn
pnpm add http-request-to-url pnpm

Imports

httpRequestToUrl
wrong:
```
import httpRequestToUrl from 'http-request-to-url'
```
correct:
```
const httpRequestToUrl = require('http-request-to-url')
```
This package is CommonJS-only. Direct ESM 'import' statements will not work without a transpiler or Node.js's CJS-to-ESM interop.

Quickstart

Demonstrates how to create an `http.ClientRequest` and use `httpRequestToUrl` to extract its full target URL.

const httpRequestToUrl = require('http-request-to-url');
const http = require('http');

async function getRequestUrl() {
  const targetUrl = 'http://jsonplaceholder.typicode.com/posts/1?userId=1';
  // Create a client request without sending it immediately
  const clientRequest = http.request(targetUrl, {
    method: 'GET',
    headers: {
      'Accept': 'application/json'
    }
  }, (res) => {
    // Consume response data to prevent memory leaks
    res.resume(); 
  });

  clientRequest.end(); // Send the request

  try {
    const resolvedUrl = await httpRequestToUrl(clientRequest);
    console.log(`Resolved URL: ${resolvedUrl}`);
  } catch (error) {
    console.error(`Error resolving URL: ${error.message}`);
  }
}

getRequestUrl();

view raw JSON →