Registry / http-networking / api-res

api-res

JSON →
library1.0.3jsnpmunverified

API Res is a lightweight Node.js HTTP(S) request library specifically designed for interacting with Nodal API services. Currently at version 1.0.3, it provides a simple interface for making RESTful API calls within a Node.js environment. While the exact release cadence is not specified, its minimalistic design suggests a focus on stability rather than frequent feature additions. Key differentiators include its explicit integration with Nodal APIs and a straightforward request syntax, aiming for ease of use in projects that leverage the Nodal framework. It serves as a foundational utility for consuming APIs, particularly those built with Nodal, by abstracting standard HTTP request complexities.

http-networking
npm install api-res
github ↗package ↗
INSTALL
IMPORT
SIG · API-RES
A
api-res
http-networkingjavascriptv1.0.3
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.

apiRes
✓ const apiRes = require('api-res');
✗ import apiRes from 'api-res';
Primarily designed for CommonJS environments in Node.js. Direct ESM import might not be supported without transpilation or a wrapper.
get
✓ const { get } = require('api-res');
✗ import { get } from 'api-res';
If the library exposes specific methods directly on its module export, this CJS destructuring is common. ESM destructuring is unlikely without explicit support.
post
✓ const { post } = require('api-res');
✗ import { post } from 'api-res';
Similar to 'get', assuming direct method exports for convenience in CJS. Always prefer the main module import if methods aren't directly exported.

Demonstrates basic GET and POST requests, including sending JSON payloads, custom headers, and robust error handling for API responses.

const apiRes = require('api-res'); async function fetchData() { try { // Example GET request const getResponse = await apiRes.get('http://localhost:3000/api/users'); console.log('GET Response Body:', getResponse.body); console.log('GET Status Code:', getResponse.statusCode); // Example POST request with data and headers const payload = { name: 'Alice', email: 'alice@example.com' }; const postOptions = { headers: { 'Content-Type': 'application/json', 'Authorization': `Bearer ${process.env.API_KEY ?? ''}` // Use env var for sensitive data }, json: true // Instructs library to send and expect JSON }; const postResponse = await apiRes.post('http://localhost:3000/api/users', payload, postOptions); console.log('POST Response Body:', postResponse.body); console.log('POST Status Code:', postResponse.statusCode); } catch (error) { console.error('An error occurred during API request:', error.message); if (error.response) { console.error('Error Response Body:', error.response.body); console.error('Error Status Code:', error.response.statusCode); } } } fetchData();
Debug
Known issues
gotchaThe library appears to be focused on CommonJS. Using 'import' syntax (ESM) directly may lead to runtime errors or require bundlers/transpilers to resolve.
fix
Use `const apiRes = require('api-res');` for importing the library in Node.js applications.
affects: >=1.0.0
gotchaAs a relatively lightweight and possibly less actively maintained library (last update appears to be around v1.0.x), ensure it's compatible with your current Node.js version and that any security concerns in underlying HTTP modules are mitigated if used in production.
fix
Regularly review dependencies for known vulnerabilities and consider wrapping critical network calls with circuit breakers or retry mechanisms.
affects: >=1.0.0
gotchaError handling for network issues (e.g., DNS resolution failure, connection timeout) versus application-level API errors (e.g., 404, 500) might require careful inspection of the `error` object structure returned by `api-res`.
fix
Inspect `error.message`, `error.code`, and potentially `error.response` properties within catch blocks to differentiate and handle errors gracefully, as shown in the quickstart example.
affects: >=1.0.0
Errors
Common errors & fixes
Error [ERR_REQUIRE_ESM]: require() of ES Module /path/to/node_modules/api-res/index.js from /your/app.js not supported.
Attempting to `require()` an ESM-only module, or using `import` syntax for a CJS-only module.
fix
Ensure your project is configured for CommonJS modules (e.g., no `"type": "module"` in `package.json` or rename `.js` files to `.mjs` for ESM). For `api-res`, stick to `require()`.
(node:XXXXX) UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'body' of undefined
An asynchronous request failed, but the promise rejection was not caught, or the `response` object was null/undefined due to an unhandled network error.
fix
Always use `try...catch` blocks with `async/await` or `.catch()` with Promises to handle potential errors gracefully. Check if `error.response` exists before accessing its properties.
Error: connect ECONNREFUSED 127.0.0.1:3000
The target API server is not running or is not accessible at the specified address and port.
fix
Verify the API server is online, listening on the correct port, and that there are no firewall rules blocking the connection.
Upgrade
Version history
1.0.3latest on npm
Audit
Dependencies
cmndoptionalMentioned as a complementary tool; 'plays well with'. Not a direct runtime dependency but often used together.
Agent activity
17 hits · last 30 days
node
16
Amazon
1
Resources
githubhttps://github.com/keithwhor/api-res ↗
packagehttps://www.npmjs.com/package/api-res ↗
api-res — npm install api-res · libregistry