codenames
Version:
Converts numerical values into human-readable names following a specific theme (e.g., cities)
24 lines • 815 B
TypeScript
/**
* 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
*/
export declare const gems: readonly ["ruby", "pearl", "jade", "opal", "amber", "diamond", "emerald", "gold", "silver", "topaz"];
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 declare const codename: (input: number) => "gold" | "silver" | "amber" | "ruby" | "jade" | "pearl" | "emerald" | "topaz" | "opal" | "diamond";
export default codename;
//# sourceMappingURL=gems-10.d.ts.map