Registry / http-networking / r2

r2

JSON →
library0.4.2jsnpmunverified

The `r2` package is a minimalist, promise-based HTTP client library envisioned as a spiritual successor to the popular `request` package. It distinguishes itself by being built primarily upon the browser's Fetch API, with Node.js support provided through shims, resulting in a substantially smaller footprint, particularly for browser environments (e.g., 66KB uncompressed for `r2` versus 2MB for `request` when bundled). The library's API is designed for modern JavaScript development, leveraging `async/await` for asynchronous operations. The current stable version is 2.0.1, released in April 2018. Its release cadence has been effectively halted since then, indicating long-term dormancy. A primary differentiator is its Fetch API-first design, aiming for simplicity and efficiency over feature-rich complexity, making it a lightweight option for basic HTTP interactions.

http-networking
npm install r2
github ↗package ↗
INSTALL
IMPORT
SIG · R2
R
r2
http-networkingjavascriptv0.4.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.

r2 (main function)
✓ const r2 = require('r2')
✗ import r2 from 'r2'
As of v2, r2 is exclusively a CommonJS module. Direct ES module imports are not supported without transpilation or a CJS wrapper.
r2.get (or other methods)
✓ const r2 = require('r2'); await r2.get('https://example.com').text
✗ const { get } = require('r2'); await get('https://example.com')
Named methods like get, post, put, etc., are properties of the main r2 object, not directly exported named functions.
r2() (function call)
✓ await r2('https://example.com').text
✗ new r2('https://example.com')
r2 is a function that returns a promise-like object directly for chaining, not a class to be instantiated with the 'new' keyword.

Demonstrates basic GET requests for text, PUT requests with JSON payloads, and GET requests with custom headers using r2's async/await interface.

const r2 = require('r2'); async function fetchData() { try { // Fetch HTML content from Google const html = await r2('https://www.google.com').text; console.log('Google HTML (truncated):', html.substring(0, 100) + '...'); // Send a PUT request with JSON data and receive JSON response const payload = { status: 'success', timestamp: Date.now() }; const jsonResponse = await r2.put('https://httpbin.org/put', { json: payload }).json; console.log('HTTPBin PUT response:', jsonResponse); // Fetch with custom headers const headers = { 'x-custom-header': 'r2-test' }; const responseWithHeaders = await r2('https://httpbin.org/headers', { headers }).json; console.log('HTTPBin Headers response:', responseWithHeaders.headers['X-Custom-Header']); } catch (error) { console.error('Error fetching data:', error); } } fetchData();
Debug
Known issues
breakingVersion 2.0.0 introduced a complete overhaul of the API, explicitly stating "MAJOR API BREAK OF EVERY METHOD AND THE HASHER." Code written for v1.x will not be compatible with v2.x without significant refactoring.
fix
Consult the v2.0.0 source code or documentation (if available) to understand the new API surface, as explicit migration guides are scarce.
affects: >=2.0.0
gotchaThe `r2` package has not received updates since April 2018. This means it may contain unpatched security vulnerabilities, outdated dependencies, or compatibility issues with newer Node.js versions or browser environments.
fix
Evaluate alternatives like `node-fetch`, `axios`, or the native `fetch` API (with a polyfill for Node.js) for projects requiring active maintenance, security updates, and modern features. Use `r2` with caution in production, especially for new projects.
affects: >=2.0.1
gotcha`r2` is built on the Fetch API but is primarily a CommonJS module. It does not natively support ES Modules (import/export syntax) without a transpilation step (e.g., Babel, TypeScript) or a wrapper.
fix
Use `const r2 = require("r2")` for Node.js environments. For browser environments where ES Modules are preferred, consider bundling with tools like Webpack or Rollup, or use a modern HTTP client with native ESM support.
affects: >=1.0.0
Errors
Common errors & fixes
SyntaxError: await is only valid in async functions and the top level bodies of modules
Attempting to use `await` keyword outside of an `async` function or a module explicitly configured as an ES module.
fix
Wrap the code using `await` in an `async` function and call it. Example: `async function myFunc() { await r2(...); } myFunc();`.
TypeError: r2 is not a function
Attempting to instantiate r2 using `new r2()`, or calling a method on an undefined `r2` variable.
fix
`r2` is a function that returns a promise-like object directly, not a class. Call it as `await r2('url').text`. Ensure `const r2 = require('r2')` is correctly defined and in scope.
Error: getaddrinfo ENOTFOUND localhost
The hostname specified in the URL (e.g., 'localhost') could not be resolved by the DNS system, or the network connection is unavailable.
fix
Verify the URL is correct and the target server is running and accessible from your environment. For 'localhost', ensure the server is listening on the correct port and address.
Upgrade
Version history
0.4.2latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
4 hits · last 30 days
node
4
Resources
githubhttps://github.com/mikeal/r2 ↗
packagehttps://www.npmjs.com/package/r2 ↗
r2 — npm install r2 · libregistry