TypeScript Character Code Enumeration

Common errors

• Error: Cannot find module 'typescript-char'

  cause This error occurs if TypeScript cannot locate the module's declaration file, often due to incorrect `tsconfig.json` paths or if the package is not installed correctly.
  fix Ensure `typescript-char` is listed in your `devDependencies` and `node_modules` is accessible. Verify your `tsconfig.json` includes `node_modules` in `typeRoots` or `include` paths, and `moduleResolution` is set appropriately (e.g., `NodeNext` or `Node`).

• TypeError: Cannot read properties of undefined (reading 'OpenBrace') at runtime

  cause This error arises when you try to access `Char.OpenBrace` in JavaScript at runtime after TypeScript compilation, but `typescript-char` is a type-only library and provides no runtime values.
  fix This library only provides types. If you need runtime character codes, you must either define them as `const` enums (which are inlined) or use direct magic numbers in your JavaScript output, which defeats the purpose of this library for runtime values. This library is for compile-time type safety.

Warnings

• breaking The package version is 0.0.0, indicating it is pre-release and not considered stable. Future updates (if any) could introduce breaking changes without following semantic versioning practices.
  Fix: Use with caution in production environments. Consider vendoring the `.d.ts` file or pinning to a specific commit if stability is critical.
• gotcha This is a 'header-only' library, meaning it provides only TypeScript type definitions (`.d.ts` file) and no runtime JavaScript code. Attempting to `require()` it in a CommonJS environment or expecting a runtime class will result in errors.
  Fix: Do not attempt to instantiate `Char` at runtime or use `require()`. It is purely for type-checking and compile-time constant resolution. Use `import Char from 'typescript-char'` in TypeScript files.
• gotcha The library has not been updated since 2017. This indicates it is likely abandoned and will not receive new features, bug fixes, or compatibility updates for newer TypeScript versions or Unicode characters.
  Fix: Evaluate alternatives if active maintenance, broader character support (e.g., full Unicode), or compatibility with very recent TypeScript features are required.

Install

• npm install typescript-char npm
• yarn add typescript-char yarn
• pnpm add typescript-char pnpm

Imports

• Char
  wrong:

  import { Char } from 'typescript-char'

  correct:

  import Char from 'typescript-char'

  The library exports a default enum-like object named `Char`.
• Char
  wrong:

  const Char = require('typescript-char')

  correct:

  /// <reference types="typescript-char" />
  
  const x: Char = Char.OpenBrace

  Being a type-only library, it's typically used with `import` statements or global type references, and has no CommonJS runtime equivalent.

Quickstart

Demonstrates importing the `Char` enumeration and using its constants for character codes, including converting a code back to its string representation.

import Char from 'typescript-char';

// Use a character code from the enumeration
const openBraceCode: Char = Char.OpenBrace;
console.log(`Open Brace Code: ${openBraceCode}`); // Expected output: 123

// Convert the character code back to a string character
console.log(`Character from code: ${String.fromCharCode(openBraceCode)}`); // Expected output: {

// Example in a simple parser context (conceptual, as it's types only)
function processInput(input: string) {
  if (input.charCodeAt(0) === Char.OpenParen) {
    console.log('Input starts with an opening parenthesis.');
  } else if (input.charCodeAt(0) === Char.A) {
    console.log('Input starts with an 'A'.');
  } else {
    console.log('Input starts with another character.');
  }
}

processInput('(');
processInput('Apple');
processInput('Banana');