@zsnout/ithkuil/parse/index.d.ts

A set of tools which can generate and parse romanized Ithkuil text and which can generate Ithkuil script from text and JSON data.

import type { PartialFormative, PartialReferential, PlainAdjunct } from "../generate/index.js";
export * from "./adjunct/index.js";
export * from "./formative/index.js";
export * from "./from-text.js";
export * from "./lex/index.js";
export * from "./referential/index.js";
export * from "./transform.js";
export * from "./vowel-form.js";
/**
 * Parses an Ithkuilic word into a JavaScript object.
 *
 * @param word The word to be parsed.
 * @returns Either a `PartialFormative`, `PartialReferential`, or `PlainAdjunct`
 *   representing a success or `undefined` representing a failed tokenization.
 *   Throws an error if the word was parsed successfully but had another error
 *   (e.g. invalid Vk slot, invalid Cn slot, etc.).
 */
export declare function parseWord(word: string): PartialFormative | PartialReferential | PlainAdjunct | undefined;