codenames/dist/words/animals-100.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", "tiger", "shark", "snake", "zebra", "camel", "monkey", "rabbit", "spider", "turtle", "donkey", "salmon", "beetle", "lizard", "pigeon", "turkey", "parrot", "oyster", "hippo", "panda", "koala", "otter", "rhino", "llama", "skunk", "moose", "sloth", "hyena", "gecko", "lemur", "beaver", "badger", "weasel", "jaguar", "cougar", "racoon", "giraffe", "penguin", "dolphin", "octopus", "lobster", "shrimp", "vulture", "peacock", "ostrich", "pelican", "termite", "cricket", "buffalo", "gorilla", "cheetah", "panther", "hamster", "gerbil", "falcon", "catfish", "grouper", "snapper", "herring", "halibut", "sardine", "anchovy", "sparrow", "swallow", "bluejay", "finch", "raven", "heron", "mole", "toad", "eel"];
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-100";
 * codename(1234) // "shrimp"
 * ```
 */
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" | "tiger" | "shark" | "snake" | "zebra" | "camel" | "monkey" | "rabbit" | "spider" | "turtle" | "donkey" | "salmon" | "beetle" | "lizard" | "pigeon" | "turkey" | "parrot" | "oyster" | "hippo" | "panda" | "koala" | "otter" | "rhino" | "llama" | "skunk" | "moose" | "sloth" | "hyena" | "gecko" | "lemur" | "beaver" | "badger" | "weasel" | "jaguar" | "cougar" | "racoon" | "giraffe" | "penguin" | "dolphin" | "octopus" | "lobster" | "shrimp" | "vulture" | "peacock" | "ostrich" | "pelican" | "termite" | "cricket" | "buffalo" | "gorilla" | "cheetah" | "panther" | "hamster" | "gerbil" | "falcon" | "catfish" | "grouper" | "snapper" | "herring" | "halibut" | "sardine" | "anchovy" | "sparrow" | "swallow" | "bluejay" | "finch" | "raven" | "heron" | "mole" | "toad" | "eel";
export default codename;
//# sourceMappingURL=animals-100.d.ts.map