codenames/dist/core/codename.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.
 * This function is used internally by themed word files.
 *
 * @param words - Array of words to use for codenames
 * @param input - The number to convert
 * @returns A string codename
 *
 * @example
 * ```typescript
 * const cities = ["paris", "london", "tokyo"];
 * codename(cities, 1234) // "london"
 * ```
 */
export declare function codename(words: readonly string[], input: number): string;
export type CodenameFunction = typeof codename;
export default codename;
//# sourceMappingURL=codename.d.ts.map