@zsnout/ithkuil/parse/adjunct/modular.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 { ModularAdjunct } from "../../generate/adjunct/modular/index.js";
import { DCWord } from "../decompose.js";
import type { Stress } from "../transform.js";
/**
 * Builds a modular adjunct.
 *
 * @param word The word to be built.
 * @param stress The stress of the adjunct.
 * @returns Either a parsed `ModularAdjunct` indicating a success, or
 *   `undefined` indicating a tokenization failure. Throws if the adjunct was
 *   successfully tokenized but had another error in it (e.g. invalid Vn slot,
 *   etc.).
 */
export declare function buildModularAdjunct(word: string, stress: Stress): ModularAdjunct | undefined;
/**
 * Builds a modular adjunct.
 *
 * @param word The word to be decomposed.
 * @param stress The stress of the adjunct.
 * @returns Either a parsed array of decompositions indicating a success, or
 *   `undefined` indicating a tokenization failure. Throws if the adjunct was
 *   successfully tokenized but had another error in it (e.g. invalid Vn slot,
 *   etc.).
 */
export declare function dcModularAdjunct(word: string, stress: Stress): DCWord<"adjModular"> | undefined;