Literal HTTP Codes & Statuses

Common errors

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

  cause Attempting to access `status.OK` before the module is correctly imported, or if the `status` object is undefined.
  fix Ensure the import statement `import { status } from 'ltrl-http';` is at the top of your file and that your environment supports ES Modules. If using CommonJS, consider transpiling or using dynamic import if available.

• TS2307: Cannot find module 'ltrl-http' or its corresponding type declarations.

  cause TypeScript compiler cannot locate the package or its declaration files (`.d.ts`).
  fix Ensure `ltrl-http` is installed (`npm install ltrl-http` or `pnpm add ltrl-http`) and that `moduleResolution` in your `tsconfig.json` is set to a suitable value like `Node16` or `Bundler` for modern module resolution.

Warnings

• breaking The internal structure of 'congruents' has changed from using 'key' and 'label' fields to a single 'id' field. While `ltrl-http`'s direct exports like `status` are unaffected, custom integrations or direct access to the configuration via `useHTTPCodeConfig()` that rely on the previous field names will break.
  Fix: Review any code that directly accesses the configuration object returned by `useHTTPCodeConfig()` and update field names from `key` or `label` to `id` as appropriate.
• gotcha The `ltrl` project, including `ltrl-http`, is actively developed with frequent minor versions and patches. While this indicates active maintenance, it also means that internal structures and features might evolve rapidly. It's advisable to pin exact versions in production to avoid unexpected behavior changes from sub-minor updates.
  Fix: Use exact version numbers (e.g., `"ltrl-http": "0.0.20"`) in `package.json` and regularly review changelogs before upgrading.

Install

• npm install ltrl-http npm
• yarn add ltrl-http yarn
• pnpm add ltrl-http pnpm

Imports

• status
  wrong:

  const { status } = require('ltrl-http');

  correct:

  import { status } from 'ltrl-http';

  The library primarily uses ES module syntax. CommonJS `require` might not work directly without transpilation or specific Node.js configuration.
• isHTTPCode

  import { isHTTPCode } from 'ltrl-http';

  Used for runtime validation of a number against known HTTP status codes.
• HTTPCode

  import type { HTTPCode } from 'ltrl-http';

  This is a TypeScript type union of all available HTTP status code literals, useful for type checking functions that accept HTTP codes.
• useHTTPStatus

  import { useHTTPStatus } from 'ltrl-http';

  Utility function to get an HTTP code from a status string.

Quickstart

Demonstrates importing `status` for direct code access, `isHTTPCode` for validation, and `HTTPCode` for type safety.

import { status, isHTTPCode, HTTPCode } from 'ltrl-http';

// Accessing HTTP status codes directly
console.log(`OK: ${status.OK}`); // Output: OK: 200
console.log(`Forbidden: ${status.FORBIDDEN}`); // Output: Forbidden: 403

// Using utility functions
const codeToCheck: unknown = 200;
if (isHTTPCode(codeToCheck)) {
  console.log(`${codeToCheck} is a valid HTTP code.`);
} else {
  console.log(`${codeToCheck} is not a valid HTTP code.`);
}

// Type usage example
function handleResponse(code: HTTPCode) {
  switch (code) {
    case status.OK:
      console.log('Request successful!');
      break;
    case status.NOT_FOUND:
      console.log('Resource not found.');
      break;
    default:
      console.log(`Unhandled HTTP code: ${code}`);
  }
}

handleResponse(status.INTERNAL_SERVER_ERROR);
// Expected output: Unhandled HTTP code: 500