starving-orange/dist/index.d.ts

Random nickname generator combining Korean adjectives and fruits

import { adjectives } from "./data/adjectives";
import { fruits, vegetables } from "./data/nouns";
declare const nouns: string[];
export interface NicknameOptions {
    /** 사용할 형용사 배열 (기본값: 내장 형용사 목록) */
    customAdjectives?: string[];
    /** 사용할 명사 배열 (기본값: 내장 명사 목록) */
    customNouns?: string[];
    /** 시드 값 (재현 가능한 랜덤 생성을 위해) */
    seed?: number;
    /** 띄어쓰기 없이 닉네임 생성 (기본값: false) */
    noSpacing?: boolean;
}
export interface GenerateResult {
    /** 생성된 닉네임 */
    nickname: string;
    /** 사용된 형용사 */
    adjective: string;
    /** 사용된 명사 */
    noun: string;
}
/**
 * 한글 형용사와 명사를 조합한 랜덤 닉네임을 생성합니다.
 *
 * @param options 닉네임 생성 옵션
 * @returns 생성된 닉네임 정보
 *
 * @example
 * ```typescript
 * import { generateNickname } from 'starving-orange';
 *
 * 1. 기본 사용법 (띄어쓰기 있음)
 * const result = generateNickname();
 * console.log(result.nickname); // "배고픈 귤"
 *
 * 2. 띄어쓰기 없는 닉네임
 * const noSpaceResult = generateNickname({ noSpacing: true });
 * console.log(noSpaceResult.nickname); // "배고픈귤"
 *
 * 3. 커스텀 옵션 사용
 * const customResult = generateNickname({
 *   customAdjectives: ["멋진", "귀여운"],
 *   customNouns: ["딸기", "바나나"],
 *   seed: 12345,
 *   noSpacing: true
 * });
 * ```
 */
export declare function generateNickname(options?: NicknameOptions): GenerateResult;
/**
 * 여러 개의 닉네임을 한번에 생성합니다.
 *
 * @param count 생성할 닉네임 개수
 * @param options 닉네임 생성 옵션
 * @returns 생성된 닉네임 정보 배열
 *
 * @example
 * ```typescript
 * import { generateMultipleNicknames } from 'starving-orange';
 *
 * const results = generateMultipleNicknames(5);
 * results.forEach(result => {
 *   console.log(result.nickname);
 * });
 * ```
 */
export declare function generateMultipleNicknames(count: number, options?: NicknameOptions): GenerateResult[];
/**
 * 사용 가능한 형용사 목록을 반환합니다.
 */
export declare function getAvailableAdjectives(): string[];
/**
 * 사용 가능한 명사 목록을 반환합니다.
 */
export declare function getAvailableNouns(): string[];
/**
 * 사용 가능한 과일 목록을 반환합니다.
 * @deprecated 대신 getAvailableNouns()를 사용하세요.
 */
export declare function getAvailableFruits(): string[];
/**
 * 사용 가능한 야채 목록을 반환합니다.
 */
export declare function getAvailableVegetables(): string[];
/**
 * 가능한 닉네임 조합의 총 개수를 반환합니다.
 */
export declare function getTotalCombinations(options?: NicknameOptions): number;
export default generateNickname;
export { adjectives, fruits, vegetables, nouns };
//# sourceMappingURL=index.d.ts.map