codenames/dist/core/index.d.ts

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

/**
 * Converts a number to a human-readable codename using the provided word list.
 *
 * @param input - The number to convert
 * @param words - Array of words to use for codenames
 * @returns A string codename
 *
 * @example
 * ```typescript
 * import { codename } from "codenames/core";
 * codename(123, ["one", "two", "three"]) // "two"
 * ```
 */
export declare function codename(input: number, words: readonly string[]): string;
export default codename;
//# sourceMappingURL=index.d.ts.map