Package Exports

hangul-chosung-search-js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hangul-chosung-search-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

hangul-chosung-search-js

hangul.js를 활용한 한글 초성 검색 라이브러리입니다.

IE 지원

IE 9 이상부터 지원됩니다.

install

npm install hangul-chosung-search-js

CDN 방식 사용 방법

일반 웹페이지에서 사용하시려면 hangul.js를 먼저 로드해주셔야 합니다.

<script src="/path/to/hangul.js" type="text/script"></script>
<script src="/path/to/hangul-chosung-search.js" type="text/javascript"></script>

ChosungSearch라는 변수로 전역에 노출됩니다.

window.ChosungSearch

RequireJS 사용 방법

RequireJS 방식으로 이용하시면 일반 웹페이지에서 전역변수로 노출되지 않습니다.

// require.config.js
require.config({
  baseUrl: '/path/js',
  paths: {
    'hangul-js': 'subPath/hangul', // 반드시 모듈명을 hangul-js로 해야합니다.
    'hangul-chosung-search-js': 'subPath/hangul-chosung-search'
  },
  shim: {
    'hangul-chosung-search-js': {
      deps: ['hangul-js']
    }
  }
});

// example
require(['hangul-chosung-search-js'], function(ChosungSearch) {
  console.log(ChosungSearch.is('과', '광고주')); // true
})

node.js 사용 방법

var ChosungSearch = require('hangul-chosung-search-js')

명세

ChosungSearch.isSearch (alias `ChosungSearch.is`)

ChosungSearch.isSearch(searchStr:string, targetStr:string, jungsungExactlyMatch:boolean = false)은 문자열 searchStr의 초성을 targetStr의 초성(+중성+종성)과 비교하여 일치하는 문자열이 있을 경우 true를 반환. 아닐경우 false를 반환합니다.

3번째 parameter인 jungsungExactlyMatch는 중성(모음)을 정확히 일치시킬지의 여부입니다.

ChosungSearch.is처럼 짧은 이름으로 사용할 수도 있습니다.

ChosungSearch.isSearch('', '광고주') // true, 빈 문자열

ChosungSearch.isSearch('ㄱ', '광고주') // true, 초성 일치

ChosungSearch.isSearch('고', '광고주') // true, 중성까지 일치하는지 확인합니다.

ChosungSearch.isSearch('과', '광고주') // true, 중성까지 일치하는지 확인합니다.

ChosungSearch.isSearch('광', '광고주') // true, 종성 일치.

ChosungSearch.is('관', '광고주') // false, 종성 미일치.

ChosungSearch.is('ㅏ', '광고주') // false, 모음 검색 지원하지 않음.

ChosungSearch.is('리더', '캘린더', false) // true, '린더'를 분리하면 '리더'를 포함하므로 일치.

ChosungSearch.is('리더', '캘린더', true) // false, '리더'와 완벽히 일치하는 문자열이 없음.

ChosungSearch.searchList (alias `ChosungSearch.sl`)

ChosungSearch.searchList(searchStr:string, arr:array, jungsungExactlyMatch:boolean = false)은 문자열 searchStr의 초성을 arr의 각 문자열들의 초성(+중성+종성)과 비교하여 일치하는 문자열들을 배열로 반환해주는 함수입니다.

3번째 parameter인 jungsungExactlyMatch는 중성(모음)을 정확히 일치시킬지의 여부입니다.

ChosungSearch.sl처럼 짧은 이름으로 사용할 수도 있습니다.

ChosungSearch.searchList('', ['광고주', '엔피엠', '석관', '석궁']) // ['광고주', '석관', '석궁'], 빈 문자열은 배열 그대로 반환

ChosungSearch.searchList('ㄱ', ['광고주', '엔피엠', '석관', '석궁']) // ['광고주', '석관', '석궁']

ChosungSearch.searchList('고', ['광고주', '엔피엠', '석관', '석궁']) // ['광고주', '석관']

ChosungSearch.searchList('과', ['광고주', '엔피엠', '석관', '석궁']) // ['광고주', '석관']

ChosungSearch.searchList('광', ['광고주', '엔피엠', '석관', '석궁']) // ['광고주']

ChosungSearch.sl('관', ['광고주', '엔피엠', '석관', '석궁']) // ['석관']

ChosungSearch.sl('ㅏ', ['광고주', '엔피엠', '석관']) // [], 모음 검색 지원하지 않음.

ChosungSearch.sl('리더', ['캘린더', '더 리더'], false) // ['캘린더', '더 리더']

ChosungSearch.sl('리더', ['캘린더', '더 리더'], true) // ['더 리더']