Nyro HTTP Request Library

Common errors

• TypeError: nyro is not a function

  cause Attempting to call `nyro` as a function after using `const nyro = require('nyro');` in a CommonJS module, or due to incorrect default import in ESM.
  fix For ESM, ensure `import nyro from 'nyro';` is used. For CommonJS, if the library is ESM-only in v2+, you might need `const { default: nyro } = await import('nyro');` or configure your environment for ESM.

• ERR_REQUIRE_ESM: require() of ES Module .../node_modules/nyro/index.mjs from ... not supported.

  cause You are attempting to `require()` Nyro (which is an ESM module) from a CommonJS module, or your Node.js environment is not configured for ESM.
  fix Either convert your consuming module to ESM by adding `"type": "module"` to your `package.json` and using `import` statements, or use a dynamic import: `const { default: nyro } = await import('nyro');`.

• Property 'body' does not exist on type 'NyroResponse<any>'

  cause When using TypeScript, the inferred type of the response might not match the expected structure, or the `bodySchema` is incorrectly defined.
  fix Ensure `bodySchema` correctly reflects the expected runtime shape of the response body. If the schema is dynamic or very complex, you might need to manually assert the type: `const { body } = await nyro(...) as { body: ExpectedBodyType };`

• Error: Protocol 'http:' not supported by agent

  cause Incorrect proxy agent configuration, often when mixing HTTP and HTTPS protocols for the proxy or target URL, or using an agent not compatible with the protocol.
  fix Ensure your proxy agent (e.g., `http-proxy-agent`, `https-proxy-agent`, `socks-proxy-agent`) matches the protocol of your proxy server. Also, verify that the `url` in your Nyro request matches the protocol expected by the agent.

Warnings

• breaking Version 2.0.0 introduced significant changes, likely transitioning to an ESM-first architecture. This means direct `require()` statements in CommonJS modules might no longer work as expected and may require configuration changes or dynamic imports.
  Fix: Migrate to ES module import syntax (`import ... from 'nyro';`) or use dynamic `import()` within CommonJS modules. Ensure your project's `package.json` specifies `"type": "module"` if it's an ESM project.
• gotcha The documentation mentions 'Browser Support (Node Only)'. This implies that certain browser-like features or configurations are available when running Nyro in a Node.js environment, but the library is not intended for direct client-side browser usage.
  Fix: Do not attempt to use Nyro directly in a web browser. It is designed for server-side (Node.js) applications. For client-side, consider browser-native `fetch` or a dedicated browser-compatible HTTP client.
• gotcha The `bodySchema` option is for defining the *expected structure* of the request body for validation and type safety, not for defining the actual data payload to be sent. Incorrectly assuming it's the request body itself can lead to empty or malformed requests.
  Fix: The actual data payload should be passed via the `body` option. Use `bodySchema` purely for validation against a JavaScript type constructor (e.g., `String`, `Number`, `Object`, `Array`) or custom validation functions.
• gotcha Nyro includes a 'Layer7 Attack' feature. While potentially intended for security testing or load generation, using this functionality for malicious purposes is explicitly prohibited by the library's license and can lead to legal consequences.
  Fix: Exercise extreme caution and ensure legal and ethical compliance when using any features that could be construed as attack-oriented. Only use such features in controlled, authorized environments for legitimate security research or testing.

Install

• npm install nyro npm
• yarn add nyro yarn
• pnpm add nyro pnpm

Imports

• nyro
  wrong:

  const nyro = require('nyro');

  correct:

  import nyro from 'nyro';

  Nyro is primarily an ESM module, direct CommonJS `require` can cause issues. Use dynamic import for CJS if necessary.
• Method
  wrong:

  import nyro, { Method } from 'nyro';

  correct:

  import { Method } from 'nyro';

  Named export for HTTP methods enum. Also available as a string literal, e.g., 'GET'.
• ResponseType
  wrong:

  import * as NyroTypes from 'nyro';

  correct:

  import { ResponseType } from 'nyro';

  Named export for expected response type enum (e.g., 'json', 'text').
• NyroResponse

  import type { NyroResponse } from 'nyro';

  Type import for the response object, useful for TypeScript applications to define the shape of the `await nyro(...)` result.

Quickstart

Demonstrates a basic promise-based GET request, including URL parameters, HTTP method, expected response type, custom headers, and response body schema validation using Nyro. It logs the status code and the parsed AI reply.

import nyro, { ResponseType, Method } from 'nyro';

(async() => {

 const { body, statusCode } = await nyro({
    url: 'https://hercai.onrender.com/v3/hercai',
    params: {
        question: 'Hi How Are You?'
    },
    method: Method.Get, // Or 'GET'
    responseType: ResponseType.Json, // Or 'json'
    headers: {
        'User-Agent': 'Nyro-App/1.0'
    },
    bodySchema: {
        content: String,
        reply: String
    }
 });

  console.log(`Status Code: ${statusCode}`);
  console.log('Your Question; ' + body.content);
  console.log('AI Reply; ' + body.reply);

})();