UNPKG

codenames

Version:

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

24 lines 1.04 kB
/** * Auto-generated from cities.txt. Do not edit manually. * Run 'bun run scripts/generate.ts cities City' to regenerate. * * SPDX-FileCopyrightText: 2025-present Kriasoft * SPDX-License-Identifier: MIT */ export declare const cities: readonly ["paris", "london", "rome", "tokyo", "berlin", "madrid", "sydney", "moscow", "cairo", "dubai", "milan", "oslo", "seoul", "miami", "vegas", "vienna", "athens", "dublin", "zurich", "geneva"]; export type City = (typeof cities)[number]; /** * Converts a number to a City codename * * @param input - The number to convert * @returns A City name * * @example * ```typescript * import codename from "codenames/cities-20"; * codename(1234) // "milan" * ``` */ export declare const codename: (input: number) => "paris" | "london" | "rome" | "tokyo" | "berlin" | "madrid" | "sydney" | "moscow" | "cairo" | "dubai" | "milan" | "oslo" | "seoul" | "miami" | "vegas" | "vienna" | "athens" | "dublin" | "zurich" | "geneva"; export default codename; //# sourceMappingURL=cities-20.d.ts.map