hangul-chosung-search-js
hangul.js를 활용한 한글 초성 검색 라이브러리입니다.
IE 지원
IE 9 이상부터 지원됩니다.
install
npm install hangul-chosung-search-js
CDN 방식 사용 방법
일반 웹페이지에서 사용하시려면 hangul.js를 먼저 로드해주셔야 합니다.
ChosungSearch라는 변수로 전역에 노출됩니다.
windowChosungSearch
RequireJS 사용 방법
RequireJS 방식으로 이용하시면 일반 웹페이지에서 전역변수로 노출되지 않습니다.
// require.config.jsrequire; // example
node.js 사용 방법
var ChosungSearch =
명세
ChosungSearch.is
)
ChosungSearch.isSearch (alias ChosungSearch.isSearch(searchStr:string, targetStr:string, jungsungExactlyMatch:boolean = false)
은 문자열 searchStr의 초성을 targetStr의 초성(+중성+종성)과 비교하여 일치하는 문자열이 있을 경우 true를 반환. 아닐경우 false를 반환합니다.
3번째 parameter인 jungsungExactlyMatch
는 중성(모음)을 정확히 일치시킬지의 여부입니다.
ChosungSearch.is
처럼 짧은 이름으로 사용할 수도 있습니다.
ChosungSearch // true, 빈 문자열 ChosungSearch // true, 초성 일치 ChosungSearch // true, 중성까지 일치하는지 확인합니다. ChosungSearch // true, 중성까지 일치하는지 확인합니다. ChosungSearch // true, 종성 일치. ChosungSearch // false, 종성 미일치. ChosungSearch // false, 모음 검색 지원하지 않음. ChosungSearch // true, '린더'를 분리하면 '리더'를 포함하므로 일치. ChosungSearch // false, '리더'와 완벽히 일치하는 문자열이 없음.
ChosungSearch.sl
)
ChosungSearch.searchList (alias ChosungSearch.searchList(searchStr:string, arr:array, jungsungExactlyMatch:boolean = false)
은 문자열 searchStr의 초성을 arr의 각 문자열들의 초성(+중성+종성)과 비교하여 일치하는 문자열들을 배열로 반환해주는 함수입니다.
3번째 parameter인 jungsungExactlyMatch
는 중성(모음)을 정확히 일치시킬지의 여부입니다.
ChosungSearch.sl
처럼 짧은 이름으로 사용할 수도 있습니다.
ChosungSearch // ['광고주', '석관', '석궁'], 빈 문자열은 배열 그대로 반환 ChosungSearch // ['광고주', '석관', '석궁'] ChosungSearch // ['광고주', '석관'] ChosungSearch // ['광고주', '석관'] ChosungSearch // ['광고주'] ChosungSearch // ['석관'] ChosungSearch // [], 모음 검색 지원하지 않음. ChosungSearch // ['캘린더', '더 리더'] ChosungSearch // ['더 리더']