add comments to hira2kana

boarwell · Mar 24, 2022 · e1ad847 · e1ad847
1 parent a4292df
commit e1ad847
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/src/main.ts b/src/main.ts
@@ -1,5 +1,24 @@
 const BETWEEN_KATAKANA_HIRAGANA = 96;
 
+/**
+ * converts the first character to a Katakana (if it is Hiragana).
+ *
+ * if the argument is not Hiragane, it would return unexpected value.
+ * to avoid this, use isHiragana().
+ *
+ * @example
+ * // returns 'ア'
+ * hira2kata('あ')
+ *
+ * @example
+ * // returns '吷'
+ * hira2kata('受')
+ *
+ * @example
+ * // returns '受'
+ * const c = '受';
+ * isHiragana(c) ? hira2kana(c) : c;
+ */
 export const hira2kata = (c: string): string =>
  String.fromCodePoint(c.codePointAt(0)! + BETWEEN_KATAKANA_HIRAGANA);