codenames/dist/core/factory.d.ts

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

/**
 * Creates a codename function for a specific word list.
 *
 * @param words - Array of words to use for codenames
 * @returns A function that converts numbers to codenames
 *
 * @example
 * ```typescript
 * import { createCodename } from "codenames/core";
 * const cityCodename = createCodename(["paris", "london", "tokyo"]);
 * cityCodename(1234) // "london"
 * ```
 */
export declare function createCodename(words: readonly string[]): (input: number) => string;
/**
 * Creates a typed codename function for a specific word list.
 *
 * @param words - Array of words to use for codenames
 * @returns A function that converts numbers to codenames with proper typing
 */
export declare function createTypedCodename<T extends readonly string[]>(words: T): (input: number) => T[number];
//# sourceMappingURL=factory.d.ts.map