Registry / http-networking / response-iterator

response-iterator

library1.0.10jsnpmunverified

response-iterator is a utility library designed to normalize various HTTP response bodies into a consistent asynchronous iterator interface, compatible across both browser and Node.js environments. It currently stands at stable version 1.0.10 and is regularly maintained. The library abstracts away the differences in how `Response` objects (or similar constructs) are handled by different HTTP clients such as standard `fetch`, `node-fetch`, `cross-fetch`, `axios`, `got`, and `undici`. Its key differentiator is providing a simple `for await...of` loop mechanism to consume streamed data chunks, making it easier to process large responses efficiently without loading the entire body into memory, irrespective of the underlying fetch implementation. It significantly simplifies working with streaming data by adhering to the `Symbol.asyncIterator` protocol.

http-networking serialization web-framework

npm install response-iterator

github ↗package ↗

INSTALL

IMPORT

SIG · RESPONSE-ITERATOR

response-iterator

http-networkingjavascriptv1.0.10

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.

responseIterator

✓ import responseIterator from 'response-iterator';

✗ const responseIterator = require('response-iterator');

The package is ESM-only since version 1.x. Using `require()` in a CommonJS module will result in an `ERR_REQUIRE_ESM` error. Ensure your environment supports ESM or use dynamic import.

Demonstrates fetching a JSON file and consuming its content as an async iterator.

import responseIterator from 'response-iterator'; // A polyfill like 'isomorphic-fetch' or 'node-fetch' might be needed for Node.js environments // if a global `fetch` is not available. For browser, `fetch` is native. async function fetchData() { try { const res = await fetch('https://raw.githubusercontent.com/kmalakoff/response-iterator/master/package.json'); if (!res.ok) { throw new Error(`HTTP error! status: ${res.status}`); } let data = ''; for await (const chunk of responseIterator(res)) { data += chunk; } console.log('Package name:', JSON.parse(data).name); // Expected: "response-iterator" } catch (error) { console.error('Failed to fetch or process data:', error); } } fetchData();

Debug

Known issues

breakingMajor version 1.0.0 introduces breaking changes. While specific release notes for 0.x to 1.x are not readily available, according to semantic versioning, a jump to `1.0.0` signifies that the API is now considered stable, but with potential breaking changes from any `0.x` version. Always review your usage when upgrading from `0.x` to `1.x`.

fix

Consult the project's GitHub release history and examples. Re-evaluate direct usage of internal APIs or patterns that might have changed.

affects: >=1.0.0

breakingThe package transitioned to an ESM-only distribution model with its `1.x` release. Attempting to `require()` this package in a CommonJS module will fail.

fix

Migrate your consuming code to use ES Modules (`import responseIterator from 'response-iterator';`) or use dynamic `import()` within CommonJS. Ensure your Node.js environment or bundler is configured for ESM.

affects: >=1.0.0

gotchaAsynchronous iterators, including those produced by `response-iterator`, must be consumed within an `async` function using a `for await...of` loop. Forgetting `await` or not being in an `async` context will lead to runtime errors or unhandled promises.

fix

Ensure the function consuming the iterator is declared `async` and the iteration uses `for await (const chunk of iterator)`. Handle potential errors within the loop or with a `try...catch` block around the async operation.

affects: >=0.1.0

gotchaWhen handling network responses, especially large streams, it's crucial to properly handle errors that might occur during the stream's lifetime. An unhandled exception in the underlying `Response` stream or during chunk processing can cause the consuming `for await...of` loop to hang or terminate unexpectedly without proper cleanup.

fix

Always wrap the `fetch` call and the `for await...of` loop in a `try...catch` block. Implement robust error handling for network issues, parsing errors, and any custom logic applied to chunks.

affects: >=0.1.0

Errors

Common errors & fixes

TypeError [ERR_REQUIRE_ESM]: require() of ES Module .../node_modules/response-iterator/dist/index.js from ... not supported.

Attempting to import `response-iterator` using `require()` in a CommonJS environment, but the package is ESM-only.

fix

Change `const responseIterator = require('response-iterator');` to `import responseIterator from 'response-iterator';`. Ensure your project's `package.json` has `"type": "module"` or use dynamic imports like `const responseIterator = (await import('response-iterator')).default;`.

TypeError: responseIterator is not a function

This usually happens if `responseIterator` is imported incorrectly, or if the module itself failed to load or initialize. It could also mean `responseIterator` was imported as a named import when it's a default export.

fix

Verify the import statement is `import responseIterator from 'response-iterator';` (for a default export). If in CommonJS, confirm dynamic import usage: `const responseIterator = (await import('response-iterator')).default;`.

TypeError: (intermediate value).then is not a function

This error occurs when `await` is used on a non-Promise value, or when an `async` function tries to iterate over an async iterable without `for await...of` in an `async` context, or a synchronous iterable is treated as async.

fix

Ensure the function containing `for await (const chunk of responseIterator(res))` is declared `async`. Also, verify that `responseIterator(res)` is indeed returning an async iterable and not a plain value or a Promise of a value that needs further resolution.

Upgrade

Version history

1.0.10latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

9 hits · last 30 days

node

Resources

githubhttps://github.com/kmalakoff/response-iterator ↗

packagehttps://www.npmjs.com/package/response-iterator ↗