Update doc comments

dist/fwew.d.ts

@@ -1,7 +1,7 @@
 import type { LanguageCode, Word } from './types';
 /**
  * Search 1 or more words in both directions (Na'vi first)
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} words words to search
  * @returns {Promise<Word[][]>}
  */
@@ -14,7 +14,7 @@ declare function search(lang: LanguageCode, words: string): Promise<Word[][]>;
 declare function fwew(navi: string): Promise<Word[][]>;
 /**
  * Search 1 or more words Local -> Na'vi
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} local local words to search
  * @returns {Promise<Word[][]>}
  */
@@ -27,7 +27,7 @@ declare function fwewReverse(lang: LanguageCode, local: string): Promise<Word[][
 declare function fwew1D(navi: string): Promise<Word[]>;
 /**
  * Search 1 or more words Local -> Na'vi, return only 1D array
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} local local words to search
  * @returns {Promise<Word[]>}
  */

dist/index.esm.js

@@ -21,7 +21,7 @@ const endpoints = {
 
 /**
  * Search 1 or more words in both directions (Na'vi first)
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} words words to search
  * @returns {Promise<Word[][]>}
  */
@@ -50,7 +50,7 @@ async function fwew(navi) {
 }
 /**
  * Search 1 or more words Local -> Na'vi
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} local local words to search
  * @returns {Promise<Word[][]>}
  */
@@ -79,7 +79,7 @@ async function fwew1D(navi) {
 }
 /**
  * Search 1 or more words Local -> Na'vi, return only 1D array
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} local local words to search
  * @returns {Promise<Word[]>}
  */
@@ -110,7 +110,7 @@ async function fwewSimple(navi) {
 
 /**
  * Get a list of all words or Get a list of words filtered by args
- * @param {string | undefined} args
+ * @param {string | undefined} args filter arguments e.g., 'word has kx' or 'word has kx and pos is vin.'
  * @returns {Promise<Word[]>}
  */
 async function list(args) {
@@ -124,9 +124,9 @@ async function list(args) {
 
 /**
  * Generate a single Na'vi first name
- * @param {string} n number of names to generate
- * @param {string} s number of syllables per name
- * @param {Dialect} dialect dialect to use
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s number of syllables per name [0-4]
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 async function nameSingle(n, s, dialect) {
@@ -141,11 +141,11 @@ async function nameSingle(n, s, dialect) {
 /**
  * Generate a Na'vi full name
  * @param {NameEnding} ending 'ite for female, 'itan for male
- * @param {string} n number of names to generate
- * @param {string} s1 number of syllables in first name
- * @param {string} s2 number of syllables in family name
- * @param {string} s3 number of syllables in parent's name
- * @param {Dialect} dialect dialect to use
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s1 number of syllables in first name [0-4]
+ * @param {string} s2 number of syllables in family name [0-4]
+ * @param {string} s3 number of syllables in parent's name [0-4]
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 async function nameFull(ending, n, s1, s2, s3, dialect) {
@@ -162,11 +162,11 @@ async function nameFull(ending, n, s1, s2, s3, dialect) {
 }
 /**
  * Generate a Na'vi name with alu
- * @param {string} n number of names to generate
- * @param {string} s number of syllables in first name
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s number of syllables in first name [0-4]
  * @param {NounMode} nm noun mode
  * @param {AdjectiveMode} am adjective mode
- * @param {Dialect} dialect dialect to use
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 async function nameAlu(n, s, nm, am, dialect) {
@@ -205,9 +205,9 @@ async function naviToNumber(word) {
 }
 
 /**
- * Get given number of random words
+ * Get given number of random words, optionally filtered by args
  * @param {number} n number of random words to get
- * @param {string | undefined} args arguments to filter by (e.g., "word has tx")
+ * @param {string | undefined} args filter arguments e.g., 'word has kx' or 'word has kx and pos is vin.'
  * @returns {Promise<Word[]>}
  */
 async function random(n, args) {

dist/index.js

@@ -23,7 +23,7 @@ const endpoints = {
 
 /**
  * Search 1 or more words in both directions (Na'vi first)
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} words words to search
  * @returns {Promise<Word[][]>}
  */
@@ -52,7 +52,7 @@ async function fwew(navi) {
 }
 /**
  * Search 1 or more words Local -> Na'vi
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} local local words to search
  * @returns {Promise<Word[][]>}
  */
@@ -81,7 +81,7 @@ async function fwew1D(navi) {
 }
 /**
  * Search 1 or more words Local -> Na'vi, return only 1D array
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} local local words to search
  * @returns {Promise<Word[]>}
  */
@@ -112,7 +112,7 @@ async function fwewSimple(navi) {
 
 /**
  * Get a list of all words or Get a list of words filtered by args
- * @param {string | undefined} args
+ * @param {string | undefined} args filter arguments e.g., 'word has kx' or 'word has kx and pos is vin.'
  * @returns {Promise<Word[]>}
  */
 async function list(args) {
@@ -126,9 +126,9 @@ async function list(args) {
 
 /**
  * Generate a single Na'vi first name
- * @param {string} n number of names to generate
- * @param {string} s number of syllables per name
- * @param {Dialect} dialect dialect to use
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s number of syllables per name [0-4]
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 async function nameSingle(n, s, dialect) {
@@ -143,11 +143,11 @@ async function nameSingle(n, s, dialect) {
 /**
  * Generate a Na'vi full name
  * @param {NameEnding} ending 'ite for female, 'itan for male
- * @param {string} n number of names to generate
- * @param {string} s1 number of syllables in first name
- * @param {string} s2 number of syllables in family name
- * @param {string} s3 number of syllables in parent's name
- * @param {Dialect} dialect dialect to use
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s1 number of syllables in first name [0-4]
+ * @param {string} s2 number of syllables in family name [0-4]
+ * @param {string} s3 number of syllables in parent's name [0-4]
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 async function nameFull(ending, n, s1, s2, s3, dialect) {
@@ -164,11 +164,11 @@ async function nameFull(ending, n, s1, s2, s3, dialect) {
 }
 /**
  * Generate a Na'vi name with alu
- * @param {string} n number of names to generate
- * @param {string} s number of syllables in first name
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s number of syllables in first name [0-4]
  * @param {NounMode} nm noun mode
  * @param {AdjectiveMode} am adjective mode
- * @param {Dialect} dialect dialect to use
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 async function nameAlu(n, s, nm, am, dialect) {
@@ -207,9 +207,9 @@ async function naviToNumber(word) {
 }
 
 /**
- * Get given number of random words
+ * Get given number of random words, optionally filtered by args
  * @param {number} n number of random words to get
- * @param {string | undefined} args arguments to filter by (e.g., "word has tx")
+ * @param {string | undefined} args filter arguments e.g., 'word has kx' or 'word has kx and pos is vin.'
  * @returns {Promise<Word[]>}
  */
 async function random(n, args) {

dist/list.d.ts

@@ -1,7 +1,7 @@
 import type { Word } from './types';
 /**
  * Get a list of all words or Get a list of words filtered by args
- * @param {string | undefined} args
+ * @param {string | undefined} args filter arguments e.g., 'word has kx' or 'word has kx and pos is vin.'
  * @returns {Promise<Word[]>}
  */
 export declare function list(args?: string): Promise<Word[]>;

dist/names.d.ts

@@ -1,30 +1,30 @@
 import type { AdjectiveMode, Dialect, NameEnding, NounMode } from './types';
 /**
  * Generate a single Na'vi first name
- * @param {string} n number of names to generate
- * @param {string} s number of syllables per name
- * @param {Dialect} dialect dialect to use
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s number of syllables per name [0-4]
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 export declare function nameSingle(n: string, s: string, dialect: Dialect): Promise<string>;
 /**
  * Generate a Na'vi full name
  * @param {NameEnding} ending 'ite for female, 'itan for male
- * @param {string} n number of names to generate
- * @param {string} s1 number of syllables in first name
- * @param {string} s2 number of syllables in family name
- * @param {string} s3 number of syllables in parent's name
- * @param {Dialect} dialect dialect to use
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s1 number of syllables in first name [0-4]
+ * @param {string} s2 number of syllables in family name [0-4]
+ * @param {string} s3 number of syllables in parent's name [0-4]
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 export declare function nameFull(ending: NameEnding, n: string, s1: string, s2: string, s3: string, dialect: string): Promise<string>;
 /**
  * Generate a Na'vi name with alu
- * @param {string} n number of names to generate
- * @param {string} s number of syllables in first name
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s number of syllables in first name [0-4]
  * @param {NounMode} nm noun mode
  * @param {AdjectiveMode} am adjective mode
- * @param {Dialect} dialect dialect to use
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 export declare function nameAlu(n: string, s: string, nm: NounMode, am: AdjectiveMode, dialect: Dialect): Promise<string>;

dist/random.d.ts

@@ -1,8 +1,8 @@
 import type { Word } from './types';
 /**
- * Get given number of random words
+ * Get given number of random words, optionally filtered by args
  * @param {number} n number of random words to get
- * @param {string | undefined} args arguments to filter by (e.g., "word has tx")
+ * @param {string | undefined} args filter arguments e.g., 'word has kx' or 'word has kx and pos is vin.'
  * @returns {Promise<Word[]>}
  */
 export declare function random(n: number, args?: string): Promise<Word[]>;

dist/types.d.ts

@@ -39,7 +39,7 @@ export type Dialect = 'forest' | 'reef';
 export type NounMode = 'normal noun' | 'verb-er';
 export type AdjectiveMode = 'none' | 'any' | 'normal adjective' | 'genitive noun' | 'origin noun' | 'participle verb' | 'active participle verb' | 'passive participle verb';
 export type NameEnding = "'ite" | "'itan";
-export type LanguageCode = 'DE' | 'EN' | 'ET' | 'FR' | 'HU' | 'NL' | 'PL' | 'RU' | 'SV' | 'TR';
+export type LanguageCode = 'de' | 'en' | 'et' | 'fr' | 'hu' | 'nl' | 'pl' | 'ru' | 'sv' | 'tr';
 export type LenitionTable = {
     kx: string;
     px: string;

src/fwew.ts

@@ -3,7 +3,7 @@ import type { LanguageCode, Word } from './types'
 
 /**
  * Search 1 or more words in both directions (Na'vi first)
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} words words to search
  * @returns {Promise<Word[][]>}
  */
@@ -32,7 +32,7 @@ async function fwew(navi: string) {
 
 /**
  * Search 1 or more words Local -> Na'vi
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} local local words to search
  * @returns {Promise<Word[][]>}
  */
@@ -61,7 +61,7 @@ async function fwew1D(navi: string) {
 
 /**
  * Search 1 or more words Local -> Na'vi, return only 1D array
- * @param {LanguageCode} lang language code
+ * @param {LanguageCode} lang language code ("de" | "en" | "et" | "fr" | "hu" | "nl" | "pl" | "ru" | "sv" | "tr")
  * @param {string} local local words to search
  * @returns {Promise<Word[]>}
  */

src/list.ts

@@ -3,7 +3,7 @@ import type { Word } from './types'
 
 /**
  * Get a list of all words or Get a list of words filtered by args
- * @param {string | undefined} args
+ * @param {string | undefined} args filter arguments e.g., 'word has kx' or 'word has kx and pos is vin.'
  * @returns {Promise<Word[]>}
  */
 export async function list(args?: string) {

src/names.ts

@@ -3,9 +3,9 @@ import type { AdjectiveMode, Dialect, NameEnding, NounMode } from './types'
 
 /**
  * Generate a single Na'vi first name
- * @param {string} n number of names to generate
- * @param {string} s number of syllables per name
- * @param {Dialect} dialect dialect to use
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s number of syllables per name [0-4]
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 export async function nameSingle(n: string, s: string, dialect: Dialect) {
@@ -21,11 +21,11 @@ export async function nameSingle(n: string, s: string, dialect: Dialect) {
 /**
  * Generate a Na'vi full name
  * @param {NameEnding} ending 'ite for female, 'itan for male
- * @param {string} n number of names to generate
- * @param {string} s1 number of syllables in first name
- * @param {string} s2 number of syllables in family name
- * @param {string} s3 number of syllables in parent's name
- * @param {Dialect} dialect dialect to use
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s1 number of syllables in first name [0-4]
+ * @param {string} s2 number of syllables in family name [0-4]
+ * @param {string} s3 number of syllables in parent's name [0-4]
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 export async function nameFull(
@@ -50,11 +50,11 @@ export async function nameFull(
 
 /**
  * Generate a Na'vi name with alu
- * @param {string} n number of names to generate
- * @param {string} s number of syllables in first name
+ * @param {string} n number of names to generate [1-50]
+ * @param {string} s number of syllables in first name [0-4]
  * @param {NounMode} nm noun mode
  * @param {AdjectiveMode} am adjective mode
- * @param {Dialect} dialect dialect to use
+ * @param {Dialect} dialect dialect to use ('forest' | 'reef')
  * @returns {Promise<string>}
  */
 export async function nameAlu(

src/random.ts

@@ -2,9 +2,9 @@ import { endpoints } from './constants'
 import type { Word } from './types'
 
 /**
- * Get given number of random words
+ * Get given number of random words, optionally filtered by args
  * @param {number} n number of random words to get
- * @param {string | undefined} args arguments to filter by (e.g., "word has tx")
+ * @param {string | undefined} args filter arguments e.g., 'word has kx' or 'word has kx and pos is vin.'
  * @returns {Promise<Word[]>}
  */
 export async function random(n: number, args?: string) {