HTTP Specification Reference Data

Common errors

• TypeError: require is not a function

  cause Attempting to use `require()` in an ECMAScript Module (ESM) context without proper configuration or a `createRequire` helper.
  fix For ESM, change `const httpWell = require('know-your-http-well');` to `import * as httpWell from 'know-your-http-well';`. If you need CommonJS specifically in an ESM file, use `import { createRequire } from 'module'; const require = createRequire(import.meta.url);`.

• TypeError: Cannot read properties of undefined (reading 'NOT_FOUND')

  cause This usually occurs if the `know-your-http-well` package was not correctly imported, or the `statusPhrasesToCodes` (aliased as `statusWell` in the quickstart) object itself is undefined or lacks the 'NOT_FOUND' property. This can happen with incorrect ESM imports.
  fix Ensure you are importing the package correctly, especially in ESM environments. Use `import * as httpWell from 'know-your-http-well';` then access `httpWell.statusPhrasesToCodes.NOT_FOUND`. Verify the exact case ('NOT_FOUND' vs 'NotFound') for status codes.

Warnings

• gotcha This package is distributed as a CommonJS module. When using it in an ECMAScript Module (ESM) environment (e.g., Node.js with 'type: module' or modern frontend builds), standard named imports (`import { Name } from 'pkg'`) will not work directly. You must use `import * as pkg from 'pkg';` or rely on bundler/runtime interop.
  Fix: For ESM, use `import * as httpWell from 'know-your-http-well';` and access properties as `httpWell.statusPhrasesToCodes`. Alternatively, ensure your build setup correctly handles CommonJS interoperability.
• gotcha The package primarily provides data via JavaScript objects. While the data is derived from RFCs, its structure (e.g., property names for status codes like `NOT_FOUND`) might evolve slightly between minor versions to reflect new specifications or corrections. Always test after updates.
  Fix: Consult the changelog for each new version to understand any structural changes to the exported data objects, especially if you rely on specific keys or formats.

Install

• npm install know-your-http-well npm
• yarn add know-your-http-well yarn
• pnpm add know-your-http-well pnpm

Imports

• httpWell
  wrong:

  import httpWell from 'know-your-http-well';

  correct:

  const httpWell = require('know-your-http-well');

  This package is a CommonJS module. For ESM, use 'import * as httpWell from "know-your-http-well";' and access properties like 'httpWell.statusPhrasesToCodes'.
• statusPhrasesToCodes
  wrong:

  import { statusPhrasesToCodes } from 'know-your-http-well';

  correct:

  const { statusPhrasesToCodes } = require('know-your-http-well');

  Named imports from this CommonJS module directly are not supported without explicit interop configuration (e.g., in a bundler or 'type: module' with Node.js loaders).
• statusCodesToPhrases
  wrong:

  import { statusCodesToPhrases } from 'know-your-http-well';

  correct:

  const { statusCodesToPhrases } = require('know-your-http-well');

  As a CommonJS module, direct named imports (`import { ... } from 'pkg'`) are typically not functional. Use object destructuring with `require` or an aliased star import for ESM.

Quickstart

Demonstrates importing the package using CommonJS and accessing HTTP status code utilities for both numerical codes and their corresponding phrases.

const httpWell = require('know-your-http-well');
const statusWell = httpWell.statusPhrasesToCodes;
const phraseWell = httpWell.statusCodesToPhrases;

// Example: Server-side usage
// In a hypothetical Express-like response handler:
// res.statusCode = statusWell.NOT_FOUND;
// console.log(`Set status to ${statusWell.NOT_FOUND}`);

// Example: Client-side or common logic
const responseStatusCode = 404; // Simulate a response status

if (responseStatusCode !== statusWell.OK) {
    // Log 'Request returned 404 Not Found'
    console.log('Request returned ' + responseStatusCode + ' ' + phraseWell[responseStatusCode]);
}
// Expected output: Request returned 404 Not Found