node-fetch-native

This package provides proxy support for both Node.js versions with and without native fetch.

By default, it checks the following environment variables for proxy configuration (in order):

• https_proxy
• http_proxy
• HTTPS_PROXY
• HTTP_PROXY

It also respects no_proxy and NO_PROXY for host exclusion. You can override these using the url and noProxy options in the utility functions.

To ensure all project dependencies benefit from node-fetch-native and to prevent conflicts between node-fetch@2 and node-fetch@3, you can alias node-fetch in your package.json using your package manager's override feature.

// npm (overrides)
{
  "overrides": {
    "node-fetch": "npm:node-fetch-native@latest"
  }
}

// yarn (resolutions)
{
  "resolutions": {
    "node-fetch": "npm:node-fetch-native@latest"
  }
}

// pnpm (pnpm.overrides)
{
  "pnpm": {
    "overrides": {
      "node-fetch": "npm:node-fetch-native@latest"
    }
  }
}

You can ensure fetch is available globally across your entire environment by importing the polyfill. Note: This is not recommended for library authors; prefer explicit imports instead.

// ESM
import "node-fetch-native/polyfill";

// CJS
require("node-fetch-native/polyfill");

// You can now use fetch() without any import!

Install node-fetch-native using your preferred package manager to gain improved compatibility for node-fetch in both ESM and CommonJS environments.

# npm
npm i node-fetch-native

# yarn
yarn add node-fetch-native

# pnpm
pnpm i node-fetch-native

If you encounter issues with the native/polyfill globalThis.fetch in your runtime, you can explicitly use the node-fetch implementation via one of two methods:

1. Set the FORCE_NODE_FETCH environment variable before starting your application.
2. Import directly from node-fetch-native/node.

You can import the default fetch or specific web API globals like Blob, FormData, Headers, Request, Response, and AbortController using either ESM or CommonJS syntax.

// ESM
import fetch from "node-fetch-native";
// or
import {
  fetch,
  Blob,
  FormData,
  Headers,
  Request,
  Response,
  AbortController,
} from "node-fetch-native";

// CommonJS
const fetch = require("node-fetch-native");
// or
const {
  fetch,
  Blob,
  FormData,
  Headers,
  Request,
  Response,
  AbortController,
} = require("node-fetch-native");

If you want to bypass the native globalThis.fetch and ensure the node-fetch-native implementation is used (for example, to ensure consistent behavior across different Node.js versions or environments), set the FORCE_NODE_FETCH environment variable to true in your process environment.

# Example for running a script with the forced implementation
FORCE_NODE_FETCH=true node your-script.js

This project uses eslint-config-unjs for its linting configuration. You can extend this configuration in your own eslint.config.mjs by importing the unjs config function and passing an options object to customize ignores and rules.

import unjs from "eslint-config-unjs";

export default unjs({
  ignores: [
    "path/to/file.mjs"
  ],
  rules: {
    "rule-name": 0,
  },
});

The createFetch utility allows you to create a pre-configured fetch function that automatically applies proxy settings to every request. This is the easiest way to use node-fetch-native with a proxy.

Pass a ProxyOptions object to createFetch to specify the proxy URL and bypass list.

import { createFetch } from 'node-fetch-native';

const fetchWithProxy = createFetch({
  url: 'http://my-proxy.com:8080',
  noProxy: ['localhost']
});

// Use it just like the standard fetch API
const response = await fetchWithProxy('https://api.example.com/data');
const data = await response.json();