codenames
Version:
Converts numerical values into human-readable names following a specific theme (e.g., cities)
24 lines • 813 B
TypeScript
/**
* Auto-generated from nature.txt. Do not edit manually.
* Run 'bun run scripts/generate.ts nature Nature' to regenerate.
*
* SPDX-FileCopyrightText: 2025-present Kriasoft
* SPDX-License-Identifier: MIT
*/
export declare const nature: readonly ["tree", "sun", "sky", "rain", "moon", "star", "wind", "sea", "water", "rock"];
export type Nature = (typeof nature)[number];
/**
* Converts a number to a Nature codename
*
* @param input - The number to convert
* @returns A Nature name
*
* @example
* ```typescript
* import codename from "codenames/nature-10";
* codename(1234) // "tree"
* ```
*/
export declare const codename: (input: number) => "sky" | "water" | "rock" | "tree" | "sun" | "rain" | "moon" | "star" | "wind" | "sea";
export default codename;
//# sourceMappingURL=nature-10.d.ts.map