UNPKG

codenames

Version:

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

41 lines (35 loc) 758 B
/** * Auto-generated from gems.txt. Do not edit manually. * Run 'bun run scripts/generate.ts gems Gem' to regenerate. * * SPDX-FileCopyrightText: 2025-present Kriasoft * SPDX-License-Identifier: MIT */ import { createTypedCodename } from "../core/factory.js"; export const gems = [ "ruby", "pearl", "jade", "opal", "amber", "diamond", "emerald", "gold", "silver", "topaz", ] as const; export type Gem = (typeof gems)[number]; /** * Converts a number to a Gem codename * * @param input - The number to convert * @returns A Gem name * * @example * ```typescript * import codename from "codenames/gems-10"; * codename(1234) // "ruby" * ``` */ export const codename = createTypedCodename(gems); export default codename;