README

Korean Libs

npm node NPM
The project of Korean process module.

This project was generated by Vessel. For a simple and quick reference, click here.

About

한글/공휴일 처리 라이브러리.

Installation

해당 모듈을 사용할 프로젝트에서는 아래와 같이 설치한다.

$ npm install --save @mornya/korean-libs
or
$ yarn add @mornya/korean-libs

Usage

아래와 같이 사용 할 모듈을 import 하여 사용한다.

import { Convert, Extract, Hangul, Holidays } from '@mornya/korean-libs';
...

Methods

`Convert`

Convert.digit2Korean

소수점을 포함한 숫자를 한글로 변환한다. delimiter는 단위 사이를 구분하는 문자열.

정수는 무량대수까지만 표현 가능하다.

Convert.digit2Korean (value: BigInteger | number, delimiter: string): string;

Convert.percent2Korean

0과 1 사이의 값을 할푼리로 변환하여 문자열을 리턴한다. delimiter는 단위 사이를 구분하는 문자열.

BigInteger형을 입력받지만 일반적으로 number를 사용하므로 소수점 17자리까지 처리된다.

Convert.percent2Korean (value: BigInteger | number, delimiter: string): string;

`Extract`

Extract.getPhonemes

입력한 한글을 초/중/종성을 추출하여 리턴한다.

UTF-8로 인코딩 된 문자열만 처리 가능.

Extract.getPhonemes (value: string): IExtractedPhoneme[];

`Hangul`

Hangul.isContainsKorean

입력한 텍스트에 한글 문자가 포함되어 있는지 여부를 체크한다.

UTF-8로 인코딩 된 문자열만 처리 가능.

Hangul.isContainsKorean (value: string): boolean;

Hangul.hasJongseong

한글 텍스트의 마지막 글자가 종성(받침)을 갖고 있는지 여부를 체크.

Hangul.hasJongseong (value: string): boolean;

Hangul.getAppendedJosa

입력한 한글의 조사를 판별하여 결과 값을 리턴한다.

텍스트의 마지막 글자가 영문(aeiou) 혹은 한글 종성(받침)을 가지고 있을 때 0번 인덱스의 주어진 조사를 붙여 리턴.
종성을 갖고 있지 않으면 1번 인덱스의 조사를 붙여 리턴.
ex) '한글', ['은','는'] => '한글은'

Hangul.getAppendedJosa (value: string, josa: string[], isFullText: boolean): string;

`Holidays`

Holidays.getList

대한민국 공휴일 및 휴일 정보를 배열로 매핑하여 전체 공휴일 정보를 리턴한다.
yearly 파라미터는 문자열 형태의 휴일 및 기타 휴일 정보를 배열로 전달할 수 있으며, 기본 공휴일 정보에 추가(merge)된다.
(ex. ['2018-09-24', ...])

현재 2018년~2025년 까지의 공휴일 및 휴일 정보가 기본적으로 등록되어 있음.

Holidays.getList (yearly?: string[]): string[];

Change Log

해당 프로젝트의 CHANGELOG.md 파일 참조.

License

해당 프로젝트의 LICENSE 파일 참조.

Usage no npm install needed!