codenames
Version:
Converts numerical values into human-readable names following a specific theme (e.g., cities)
27 lines • 835 B
JavaScript
import { codename } from "./index.js";
/**
* 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 function createCodename(words) {
return (input) => codename(input, words);
}
/**
* 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 function createTypedCodename(words) {
return (input) => codename(input, words);
}
//# sourceMappingURL=factory.js.map