diff --git a/.changeset/weak-walls-sniff.md b/.changeset/weak-walls-sniff.md new file mode 100644 index 00000000..975a6db5 --- /dev/null +++ b/.changeset/weak-walls-sniff.md @@ -0,0 +1,5 @@ +--- +"es-hangul": major +--- + +feat: 한글의 두음을 반환해주는 acronymizeHangul 함수를 제거합니다. diff --git a/docs/src/pages/docs/api/acronymizeHangul.en.mdx b/docs/src/pages/docs/api/acronymizeHangul.en.mdx deleted file mode 100644 index 9f2f9007..00000000 --- a/docs/src/pages/docs/api/acronymizeHangul.en.mdx +++ /dev/null @@ -1,16 +0,0 @@ -# acronymizeHangul - -It receives the Korean sentence and returns the first letter of that Korean sentence. -(We don't deal with non-Korean sentences; we don't deal with additional Korean + English sentences.) - -```typescript -function acronymizeHangul( - // String consisting of plural nouns (e.g. '버스 충전', '치킨과 맥주') - hangul: string -): string[]; -``` - -```typescript -acronymizeHangul('치킨과 맥주').join(''); //치맥 -acronymizeHangul('버스 충전 카드').join(''); //버충카 -``` diff --git a/docs/src/pages/docs/api/acronymizeHangul.ko.mdx b/docs/src/pages/docs/api/acronymizeHangul.ko.mdx deleted file mode 100644 index c1b576a4..00000000 --- a/docs/src/pages/docs/api/acronymizeHangul.ko.mdx +++ /dev/null @@ -1,16 +0,0 @@ -# acronymizeHangul - -한글 문장을 입력받아서, 해당 한글 문장의 첫글자를 리턴해줍니다. -(한글 문장이 아닌, 문장은 취급하지않습니다. 추가로 한글 문장 + 영어 문장의 경우에도 취급하지않습니다.) - -```typescript -function acronymizeHangul( - // 복수 명사로 이루어진 문자열 (e.g. '버스 충전', '치킨과 맥주') - hangul: string -): string[]; -``` - -```typescript -acronymizeHangul('치킨과 맥주').join(''); //치맥 -acronymizeHangul('버스 충전 카드').join(''); //버충카 -``` diff --git a/src/acronymizeHangul.spec.ts b/src/acronymizeHangul.spec.ts deleted file mode 100644 index a4d8b91e..00000000 --- a/src/acronymizeHangul.spec.ts +++ /dev/null @@ -1,18 +0,0 @@ -import { acronymizeHangul } from './acronymizeHangul'; - -describe('acronymizeHangul', () => { - it('한글 문장 단어중 첫 문자만 뽑은 리스트를 반환', () => { - expect(acronymizeHangul('치킨과 맥주')).toHaveLength(2); - expect(acronymizeHangul('치킨과 맥주').join('')).toBe('치맥'); - - expect(acronymizeHangul('버스 충전 카드')).toHaveLength(3); - expect(acronymizeHangul('버스 충전 카드').join('')).toBe('버충카'); - }); - it('한글이 아닌 문장 넣었을 때', () => { - expect(() => acronymizeHangul('test test')).toThrowError('"test test" is not a valid hangul string'); - }); - - it('한글과 영어가 섞인 문장을 넣었을 때', () => { - expect(() => acronymizeHangul('고기와 Cheese')).toThrowError('"고기와 Cheese" is not a valid hangul string'); - }); -}); diff --git a/src/acronymizeHangul.ts b/src/acronymizeHangul.ts deleted file mode 100644 index 9103ec40..00000000 --- a/src/acronymizeHangul.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { parseHangul } from './_internal/hangul'; - -/** - * - * @param getHangulAcronym - * @description - * 한글 문장을 입력받아서, 해당 한글 문장의 초성을을 리턴해줍니다. - * 한글 문장이 아닌, 문장은 취급하지않습니다. 추가로 한글 문장 + 영어 문장의 경우에도 취급하지않습니다. - */ -export function acronymizeHangul(hangul: string) { -return parseHangul(hangul).split(' ').map(word => word.charAt(0)); -} diff --git a/src/index.ts b/src/index.ts index d8cfe6f8..87b3cb4a 100644 --- a/src/index.ts +++ b/src/index.ts @@ -17,5 +17,4 @@ export { hasSingleBatchim, hasValueInReadOnlyStringList, } from './utils'; -export { acronymizeHangul } from './acronymizeHangul'; export { susa } from './susa';