Updates

WaniKani · Nov 19, 2023 · a981945 · a981945
1 parent 9002609
commit a981945
Show file tree

Hide file tree

Showing 20 changed files with 160 additions and 82 deletions.
diff --git a/assets/js/wanakana.min.js b/assets/js/wanakana.min.js
diff --git a/assets/js/wanakana.min.js.map b/assets/js/wanakana.min.js.map
diff --git a/docs/bind.js.html b/docs/bind.js.html
@@ -75,7 +75,7 @@ <h3 class="reference-title">
 
 
 
-    <h3 id="global-nav">Global</h3><ul><li><a href="global.html#bind">bind</a></li><li><a href="global.html#defaultOptions">defaultOptions</a></li><li><a href="global.html#isHiragana">isHiragana</a></li><li><a href="global.html#isJapanese">isJapanese</a></li><li><a href="global.html#isKana">isKana</a></li><li><a href="global.html#isKanji">isKanji</a></li><li><a href="global.html#isKatakana">isKatakana</a></li><li><a href="global.html#isMixed">isMixed</a></li><li><a href="global.html#isRomaji">isRomaji</a></li><li><a href="global.html#stripOkurigana">stripOkurigana</a></li><li><a href="global.html#toHiragana">toHiragana</a></li><li><a href="global.html#toKana">toKana</a></li><li><a href="global.html#toKatakana">toKatakana</a></li><li><a href="global.html#tokenize">tokenize</a></li><li><a href="global.html#toRomaji">toRomaji</a></li><li><a href="global.html#unbind">unbind</a></li></ul>
+    <h3 id="global-nav">Global</h3><ul><li><a href="global.html#bind">bind</a></li><li><a href="global.html#DefaultOptions">DefaultOptions</a></li><li><a href="global.html#isHiragana">isHiragana</a></li><li><a href="global.html#isJapanese">isJapanese</a></li><li><a href="global.html#isKana">isKana</a></li><li><a href="global.html#isKanji">isKanji</a></li><li><a href="global.html#isKatakana">isKatakana</a></li><li><a href="global.html#isMixed">isMixed</a></li><li><a href="global.html#isRomaji">isRomaji</a></li><li><a href="global.html#stripOkurigana">stripOkurigana</a></li><li><a href="global.html#toHiragana">toHiragana</a></li><li><a href="global.html#toKana">toKana</a></li><li><a href="global.html#toKatakana">toKatakana</a></li><li><a href="global.html#tokenize">tokenize</a></li><li><a href="global.html#toRomaji">toRomaji</a></li><li><a href="global.html#unbind">unbind</a></li></ul>
   </nav>
 
   <div id="main">
@@ -104,7 +104,7 @@ <h1 class="page-title">
 /**
  * Binds eventListener for 'input' events to an input field to automagically replace values with kana
  * Can pass `{ IMEMode: 'toHiragana' || 'toKatakana' }` to enforce kana conversion type
- * @param  {HTMLElement} element textarea, input[type="text"] etc
+ * @param  {HTMLInputElement | HTMLTextAreaElement} element textarea, input[type="text"] etc
  * @param  {DefaultOptions} [options=defaultOptions] defaults to { IMEMode: true } using `toKana`
  * @example
  * bind(document.querySelector('#myInput'));
@@ -158,7 +158,7 @@ <h1 class="page-title">
   <br class="clear">
 
   <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
   </footer>
 
   <script src="scripts/linenumber.js"></script>

diff --git a/docs/constants.js.html → docs/constants.ts.html b/docs/constants.js.html → docs/constants.ts.html
@@ -8,7 +8,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
   <title>
-      constants.js - Documentation
+      constants.ts - Documentation
   </title>
 
   <link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">
@@ -75,13 +75,13 @@ <h3 class="reference-title">
 
 
 
-    <h3 id="global-nav">Global</h3><ul><li><a href="global.html#bind">bind</a></li><li><a href="global.html#defaultOptions">defaultOptions</a></li><li><a href="global.html#isHiragana">isHiragana</a></li><li><a href="global.html#isJapanese">isJapanese</a></li><li><a href="global.html#isKana">isKana</a></li><li><a href="global.html#isKanji">isKanji</a></li><li><a href="global.html#isKatakana">isKatakana</a></li><li><a href="global.html#isMixed">isMixed</a></li><li><a href="global.html#isRomaji">isRomaji</a></li><li><a href="global.html#stripOkurigana">stripOkurigana</a></li><li><a href="global.html#toHiragana">toHiragana</a></li><li><a href="global.html#toKana">toKana</a></li><li><a href="global.html#toKatakana">toKatakana</a></li><li><a href="global.html#tokenize">tokenize</a></li><li><a href="global.html#toRomaji">toRomaji</a></li><li><a href="global.html#unbind">unbind</a></li></ul>
+    <h3 id="global-nav">Global</h3><ul><li><a href="global.html#bind">bind</a></li><li><a href="global.html#DefaultOptions">DefaultOptions</a></li><li><a href="global.html#isHiragana">isHiragana</a></li><li><a href="global.html#isJapanese">isJapanese</a></li><li><a href="global.html#isKana">isKana</a></li><li><a href="global.html#isKanji">isKanji</a></li><li><a href="global.html#isKatakana">isKatakana</a></li><li><a href="global.html#isMixed">isMixed</a></li><li><a href="global.html#isRomaji">isRomaji</a></li><li><a href="global.html#stripOkurigana">stripOkurigana</a></li><li><a href="global.html#toHiragana">toHiragana</a></li><li><a href="global.html#toKana">toKana</a></li><li><a href="global.html#toKatakana">toKatakana</a></li><li><a href="global.html#tokenize">tokenize</a></li><li><a href="global.html#toRomaji">toRomaji</a></li><li><a href="global.html#unbind">unbind</a></li></ul>
   </nav>
 
   <div id="main">
 
       <h1 class="page-title">
-        constants.js
+        constants.ts
       </h1>
 
 
@@ -92,19 +92,33 @@ <h1 class="page-title">
   <article>
     <pre class="prettyprint source linenums"><code>export const VERSION = '5.2.0';
 
-export const TO_KANA_METHODS = {
+export const TO_KANA_METHODS: {
+  HIRAGANA: 'toHiragana',
+  KATAKANA: 'toKatakana',
+} = {
   HIRAGANA: 'toHiragana',
   KATAKANA: 'toKatakana',
 };
 
-export const ROMANIZATIONS = {
+export const ROMANIZATIONS: { HEPBURN: 'hepburn' } = {
   HEPBURN: 'hepburn',
 };
 
+export type DefaultOptions = {
+  useObsoleteKana?: boolean,
+  passRomaji?: boolean,
+  convertLongVowelMark?: boolean,
+  upcaseKatakana?: boolean,
+  IMEMode?: boolean | 'toHiragana' | 'toKatakana',
+  romanization?: 'hepburn',
+  customKanaMapping?: { [index: string]: string }
+  customRomajiMapping?: { [index: string]: string }
+};
+
 /**
  * Default config for WanaKana, user passed options will be merged with these
  * @type {DefaultOptions}
- * @name defaultOptions
+ * @name DefaultOptions
  * @property {Boolean} [useObsoleteKana=false] - Set to true to use obsolete characters, such as ゐ and ゑ.
  * @example
  * toHiragana('we', { useObsoleteKana: true })
@@ -113,31 +127,31 @@ <h1 class="page-title">
  * @example
  * toHiragana('only convert the katakana: ヒラガナ', { passRomaji: true })
  * // => "only convert the katakana: ひらがな"
- * @property {Object} [convertLongVowelMark=true] - Set to false to prevent conversions of 'ー' to extended vowels with toHiragana()
+ * @property {Boolean} [convertLongVowelMark=true] - Set to false to prevent conversions of 'ー' to extended vowels with toHiragana()
  * @example
  * toHiragana('ラーメン', { convertLongVowelMark: false });
  * // => 'らーめん
  * @property {Boolean} [upcaseKatakana=false] - Set to true to convert katakana to uppercase using toRomaji()
  * @example
  * toRomaji('ひらがな カタカナ', { upcaseKatakana: true })
  * // => "hiragana KATAKANA"
- * @property {Boolean|String} [IMEMode=false] - Set to true, 'toHiragana', or 'toKatakana' to handle conversion while it is being typed.
- * @property {String} [romanization='hepburn'] - choose toRomaji() romanization map (currently only 'hepburn')
- * @property {Object} [customKanaMapping] - custom map will be merged with default conversion
+ * @property {Boolean | 'toHiragana' | 'toKatakana'} [IMEMode=false] - Set to true, 'toHiragana', or 'toKatakana' to handle conversion while it is being typed.
+ * @property {'hepburn'} [romanization='hepburn'] - choose toRomaji() romanization map (currently only 'hepburn')
+ * @property {Object.&lt;String, String>} [customKanaMapping] - custom map will be merged with default conversion
  * @example
  * toKana('wanakana', { customKanaMapping: { na: 'に', ka: 'Bana' }) };
  * // => 'わにBanaに'
- * @property {Object} [customRomajiMapping] - custom map will be merged with default conversion
+ * @property {Object.&lt;String, String>} [customRomajiMapping] - custom map will be merged with default conversion
  * @example
  * toRomaji('つじぎり', { customRomajiMapping: { じ: 'zi', つ: 'tu', り: 'li' }) };
  * // => 'tuzigili'
  */
-export const DEFAULT_OPTIONS = {
+export const DEFAULT_OPTIONS: DefaultOptions = {
   useObsoleteKana: false,
   passRomaji: false,
+  convertLongVowelMark: true,
   upcaseKatakana: false,
   IMEMode: false,
-  convertLongVowelMark: true,
   romanization: ROMANIZATIONS.HEPBURN,
 };
 
@@ -246,7 +260,7 @@ <h1 class="page-title">
   <br class="clear">
 
   <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
   </footer>
 
   <script src="scripts/linenumber.js"></script>