korean-gotong/dist/hanjaNumberTools.d.ts

한글이 인생에 고통을 선사할 때마다 기능이 추가될 예정입니다.

/**
 * 숫자 읽기 실행 시 부가 설정
 */
export declare type KoreanNumeralSettings = {
    /**
     * 일만 단위로 띄어쓰기를 시행할지 지정
     *
     * @see {@link https://kornorms.korean.go.kr/m/m_regltn.do | 한글 맞춤법} 제44항
     * @defaultValue `true`
     */
    useSpaceEvery10K: boolean;
    /**
     * 십의 자리 이상에서 자릿수가 1인 경우 `"일백"`, `"일십"` 등에서 `"일"`을 생략할지 지정
     *
     * @defaultValue `true`
     */
    omitOneInDigits: boolean;
    /**
     * 소수점 아래의 0을 `"공"` 대신 한자 `"영"`으로 읽을지 지정
     *
     * @defaultValue `true`
     */
    fractionLeadingZeroInHanja: boolean;
    /**
     * 음수 표기 `"-"`를 `"마이너스"` 대신 한자어 `"음수"`로 읽을지 지정
     * @defaultValue `false`
     */
    minusInHanja: boolean;
};
/**
 * 숫자를 한국어 한자 기수법으로 읽은 결과를 반환하는 함수
 *
 * @param number 변환할 숫자
 * @param settings 부가 설정 (선택 항목)
 * @returns 한글 및 공백으로 이루어진 문자열
 *
 * @remark 숫자 6은 위치에 무관히 `"륙"`이 아닌 `"육"`으로 읽음
 * @see {@link https://kornorms.korean.go.kr/m/m_regltn.do | 한글 맞춤법} 제11항 [붙임 4] 및 [붙임 5]
 */
export declare const getKoreanHanjaNumeral: (number: number, settings?: Partial<KoreanNumeralSettings>) => string;