codenames/dist/words/animals-30.d.ts

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

/**
 * Auto-generated from animals.txt. Do not edit manually.
 * Run 'bun run scripts/generate.ts animals Animal' to regenerate.
 *
 * SPDX-FileCopyrightText: 2025-present Kriasoft
 * SPDX-License-Identifier: MIT
 */
export declare const animals: readonly ["cat", "dog", "fish", "bird", "cow", "pig", "bee", "ant", "bat", "fly", "rat", "fox", "owl", "bear", "duck", "hen", "frog", "crab", "goat", "lion", "wolf", "deer", "seal", "moth", "wasp", "sheep", "mouse", "horse", "eagle", "whale"];
export type Animal = (typeof animals)[number];
/**
 * Converts a number to a Animal codename
 *
 * @param input - The number to convert
 * @returns An Animal name
 *
 * @example
 * ```typescript
 * import codename from "codenames/animals-30";
 * codename(1234) // "rat"
 * ```
 */
export declare const codename: (input: number) => "cat" | "dog" | "fish" | "bird" | "cow" | "pig" | "bee" | "ant" | "bat" | "fly" | "rat" | "fox" | "owl" | "bear" | "duck" | "hen" | "frog" | "crab" | "goat" | "lion" | "wolf" | "deer" | "seal" | "moth" | "wasp" | "sheep" | "mouse" | "horse" | "eagle" | "whale";
export default codename;
//# sourceMappingURL=animals-30.d.ts.map