codenames/words/colors-20.ts

Converts numerical values into human-readable names following a specific theme (e.g., cities)

/**
 * Auto-generated from colors.txt. Do not edit manually.
 * Run 'bun run scripts/generate.ts colors Color' to regenerate.
 *
 * SPDX-FileCopyrightText: 2025-present Kriasoft
 * SPDX-License-Identifier: MIT
 */

import { createTypedCodename } from "../core/factory.js";

export const colors = [
  "red",
  "blue",
  "green",
  "yellow",
  "black",
  "white",
  "gray",
  "pink",
  "orange",
  "purple",
  "brown",
  "gold",
  "silver",
  "tan",
  "navy",
  "beige",
  "lime",
  "cyan",
  "coral",
  "violet",
] as const;

export type Color = (typeof colors)[number];

/**
 * Converts a number to a Color codename
 *
 * @param input - The number to convert
 * @returns A Color name
 *
 * @example
 * ```typescript
 * import codename from "codenames/colors-20";
 * codename(1234) // "brown"
 * ```
 */
export const codename = createTypedCodename(colors);

export default codename;