codenames
Version:
Converts numerical values into human-readable names following a specific theme (e.g., cities)
24 lines • 1.06 kB
TypeScript
/**
* Auto-generated from elements.txt. Do not edit manually.
* Run 'bun run scripts/generate.ts elements Element' to regenerate.
*
* SPDX-FileCopyrightText: 2025-present Kriasoft
* SPDX-License-Identifier: MIT
*/
export declare const elements: readonly ["gold", "iron", "lead", "zinc", "tin", "copper", "silver", "carbon", "oxygen", "helium", "neon", "argon", "sodium", "sulfur", "silicon", "boron", "lithium", "calcium", "mercury", "arsenic"];
export type Element = (typeof elements)[number];
/**
* Converts a number to a Element codename
*
* @param input - The number to convert
* @returns An Element name
*
* @example
* ```typescript
* import codename from "codenames/elements-20";
* codename(1234) // "neon"
* ```
*/
export declare const codename: (input: number) => "gold" | "silver" | "copper" | "iron" | "lead" | "zinc" | "tin" | "carbon" | "oxygen" | "helium" | "neon" | "argon" | "sodium" | "sulfur" | "silicon" | "boron" | "lithium" | "calcium" | "mercury" | "arsenic";
export default codename;
//# sourceMappingURL=elements-20.d.ts.map