codenames
Version:
Converts numerical values into human-readable names following a specific theme (e.g., cities)
41 lines (35 loc) • 774 B
text/typescript
/**
* 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",
] 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-10";
* codename(1234) // "red"
* ```
*/
export const codename = createTypedCodename(colors);
export default codename;