add js types

Author: paiv

js/uklatn.d.ts

@@ -2,21 +2,23 @@
 * Transliterates a string of Ukrainian Cyrillic to Latin script.
 *
 * @param {string} text - the text to transliterate
-* @param {string} table - transliteration system, one of:
+* @param {string} [table] - transliteration system, one of:
 *  - "DSTU_9112_A": DSTU 9112:2021 System A
 *  - "DSTU_9112_B": DSTU 9112:2021 System B
 *  - "KMU_55": KMU 55:2010
+* @returns {string} transliterated text
 */
-export function encode(text: string, table: string): string;
+export function encode(text: string, table?: string): string;
 /**
 * Re-transliterates a string of Ukrainian Latin to Cyrillic script.
 *
 * @param {string} text - the text to transliterate
-* @param {string} table - transliteration system, one of:
+* @param {string} [table] - transliteration system, one of:
 *  - "DSTU_9112_A": DSTU 9112:2021 System A
 *  - "DSTU_9112_B": DSTU 9112:2021 System B
+* @returns {string} transliterated text
 */
-export function decode(text: string, table: string): string;
+export function decode(text: string, table?: string): string;
 declare namespace _default {
     export { encode };
     export { decode };

js/uklatn.js

@@ -221,10 +221,11 @@ const _UklatnTables = new Map([
 * Transliterates a string of Ukrainian Cyrillic to Latin script.
 *
 * @param {string} text - the text to transliterate
-* @param {string} table - transliteration system, one of:
+* @param {string} [table] - transliteration system, one of:
 *  - "DSTU_9112_A": DSTU 9112:2021 System A
 *  - "DSTU_9112_B": DSTU 9112:2021 System B
 *  - "KMU_55": KMU 55:2010
+* @returns {string} transliterated text
 */
 export function encode(text, table) {
     if (table === undefined) { table = 'DSTU_9112_A'; }
@@ -240,9 +241,10 @@ export function encode(text, table) {
 * Re-transliterates a string of Ukrainian Latin to Cyrillic script.
 *
 * @param {string} text - the text to transliterate
-* @param {string} table - transliteration system, one of:
+* @param {string} [table] - transliteration system, one of:
 *  - "DSTU_9112_A": DSTU 9112:2021 System A
 *  - "DSTU_9112_B": DSTU 9112:2021 System B
+* @returns {string} transliterated text
 */
 export function decode(text, table) {
     if (table === undefined) { table = 'DSTU_9112_A'; }

package.json

@@ -27,7 +27,7 @@
   "type": "module",
   "main": "js/uklatn.js",
   "bin": "js/cli.js",
-  "files": [],
+  "files": ["js/*.ts"],
   "scripts": {
     "postpack": "git checkout readme.md",
     "prepack": "cp js/readme.md readme.md",

tools/Makefile

@@ -47,6 +47,7 @@ js:
 	@$(PYTHON) gentables.py js >> "$(PROJECT_ROOT)/js/uklatn.js"
 	@echo "/* Generated by gentests.py, do not edit. */\n" > "$(PROJECT_ROOT)/js/testuklatn.js"
 	@$(PYTHON) gentests.py js >> "$(PROJECT_ROOT)/js/testuklatn.js"
+	# tsc --declaration "$(PROJECT_ROOT)/js/uklatn.js" --allowJs --emitDeclarationOnly
 
 php:
 	@$(PYTHON) gentables.py php > "$(PROJECT_ROOT)/php/src/UkrainianLatin.php"

tools/gen/gen_js.py

@@ -259,10 +259,11 @@ def _entries():
 * Transliterates a string of Ukrainian Cyrillic to Latin script.
 *
 * @param {string} text - the text to transliterate
-* @param {string} table - transliteration system, one of:
+* @param {string} [table] - transliteration system, one of:
 *  - "DSTU_9112_A": DSTU 9112:2021 System A
 *  - "DSTU_9112_B": DSTU 9112:2021 System B
 *  - "KMU_55": KMU 55:2010
+* @returns {string} transliterated text
 */
 export function encode(text, table) {
     if (table === undefined) { table = &{default_table}; }
@@ -278,9 +279,10 @@ def _entries():
 * Re-transliterates a string of Ukrainian Latin to Cyrillic script.
 *
 * @param {string} text - the text to transliterate
-* @param {string} table - transliteration system, one of:
+* @param {string} [table] - transliteration system, one of:
 *  - "DSTU_9112_A": DSTU 9112:2021 System A
 *  - "DSTU_9112_B": DSTU 9112:2021 System B
+* @returns {string} transliterated text
 */
 export function decode(text, table) {
     if (table === undefined) { table = &{default_table}; }