Basic Auth Header Generator

Common errors

• ReferenceError: require is not defined

  cause Attempting to use `require()` in an ECMAScript Module (ESM) file without a compatible loader or transpilation. This package is a CommonJS module.
  fix If your project is ESM-only, use `import * as header from 'basic-auth-header';` or `import header from 'basic-auth-header';`. Alternatively, ensure your build system (e.g., Webpack, Rollup) is configured to handle CommonJS imports into ESM, or switch the file to CommonJS if possible.

Warnings

• breaking This package is an older CommonJS (CJS) module and does not natively support ECMAScript Modules (ESM). Attempting to use `import` syntax in a pure ESM environment without proper tooling or configuration may lead to import errors.
  Fix: For CommonJS projects, use `const header = require('basic-auth-header');`. For ESM projects, consider a bundler that handles CJS interop, or use dynamic import `import('basic-auth-header').then(m => m.default || m)` (if it's a default export) or `import * as header from 'basic-auth-header'` (if it's an object with a default property or named exports).
• gotcha The `basic-auth-header` package has not been updated since its `1.0.1` release in 2016. This means it is unmaintained and may not receive security patches for potential vulnerabilities, bug fixes, or compatibility updates for newer Node.js versions or web standards.
  Fix: Evaluate whether a more actively maintained library or a direct implementation (using `Buffer.from('user:pass').toString('base64')` in Node.js, or `btoa('user:pass')` in browsers) is more suitable for your project to ensure ongoing security and compatibility.
• gotcha Basic Authentication itself transmits credentials in a Base64-encoded (not encrypted) format, making it vulnerable to interception and replay attacks if not used exclusively over HTTPS. Modern authentication often prefers more robust token-based mechanisms (e.g., Bearer tokens, OAuth).
  Fix: Always use Basic Authentication over HTTPS. For APIs requiring higher security, consider implementing or migrating to token-based authentication (e.g., JWT, OAuth 2.0 Bearer tokens) which provide stronger security properties and greater flexibility.

Install

• npm install basic-auth-header npm
• yarn add basic-auth-header yarn
• pnpm add basic-auth-header pnpm

Imports

• header
  wrong:

  import header from 'basic-auth-header';

  correct:

  const header = require('basic-auth-header');

  This package is an older CommonJS module. While Node.js ESM allows `import header from 'basic-auth-header'`, direct `require` is the intended and safest way to import in a CJS context. For pure ESM, this typically requires a build step or careful loader configuration for CJS interop.

Quickstart

Demonstrates how to generate a Basic Authorization header string using a username and password, with an example of its potential use in an HTTP request.

const header = require('basic-auth-header');

const username = 'myuser';
const password = process.env.BASIC_AUTH_PASSWORD ?? 'mypassword'; // Use environment variable for sensitive data

const authHeader = header(username, password);

console.log(`Generated Basic Auth Header: ${authHeader}`);
// Example of how to use it in a fetch request (Node.js 18+):
// async function fetchData() {
//   try {
//     const response = await fetch('https://api.example.com/data', {
//       headers: {
//         'Authorization': authHeader
//       }
//     });
//     if (!response.ok) {
//       throw new Error(`HTTP error! status: ${response.status}`);
//     }
//     const data = await response.json();
//     console.log('Fetched Data:', data);
//   } catch (error) {
//     console.error('Error fetching data:', error);
//   }
// }
// fetchData();