Skip to content

README.md

Latest commit

 

History

History
49 lines (34 loc) ยท 1.46 KB

README.md

File metadata and controls

49 lines (34 loc) ยท 1.46 KB
Raw

๐Ÿ‡ฐ๐Ÿ‡ท Hangul Search Js

It allows you to search for simple Korean characters in the most consistent order regardless of the character assembly order.

Github Workflow GitHub License Jest Coverage Gzip Size TypeScript NPM Version jsDelivr


๐Ÿ“ฆ Usage (ES5+)

npm i hangul-search-js
import { createSearch } from 'hangul-search-js'

const search = createSearch(['๋กฏ๋ฐ์‹œ๋„ค๋งˆ', '์œ ํŠœ๋ธŒ', 'ํ”„๋กœ๊ฒŒ์ด๋จธ'])
const result = search('์‹œใ„ด')
// result: ['๋กฏ๋ฐ์‹œ๋„ค๋งˆ', 'ํ”„๋กœ๊ฒŒ์ด๋จธ']

๐Ÿ“ฆ Usage (CDN)

<script src="https://cdn.jsdelivr.net/npm/hangul-search-js/export/hangul-search.js"></script>
var createSearch = window.hangulSearch

var search = createSearch(['๋กฏ๋ฐ์‹œ๋„ค๋งˆ', '์œ ํŠœ๋ธŒ', 'ํ”„๋กœ๊ฒŒ์ด๋จธ'])
var result = search('์‹œใ„ด')
// result: ['๋กฏ๋ฐ์‹œ๋„ค๋งˆ', 'ํ”„๋กœ๊ฒŒ์ด๋จธ']

๐Ÿ’ก License

MIT Licensed.