@zsnout/ithkuil
Version:
A set of tools which can generate and parse romanized Ithkuil text and which can generate Ithkuil script from text and JSON data.
25 lines (24 loc) • 1.08 kB
TypeScript
import { type Case } from "./case.js";
import { type IllocutionOrValidation } from "./illocution-and-validation.js";
export * from "./case.js";
export * from "./illocution-and-validation.js";
export * from "./illocution.js";
export * from "./validation.js";
/** The case or illocution+validation marked by Slot IX. */
export type SlotIX = Case | IllocutionOrValidation;
/** Additional information relevant to Slot IX. */
export interface SlotIXMetadata {
/** Whether THM case or ASR+OBS illocution+validation can be elided. */
elideIfPossible: boolean;
/** Whether this slot is part of a concatenated formative. */
isPartOfConcatenatedFormative: boolean;
}
/**
* Converts Slot IX to Ithkuil.
*
* @param slot The case or illocution+validation of this slot.
* @param metadata Additional information relevant to Slot IX.
* @returns A string or `WithWYAlternative` containing romanized Ithkuilic text
* representing Slot IX.
*/
export declare function slotIXToIthkuil(slot: SlotIX, metadata: SlotIXMetadata): string | import("../../index.js").WithWYAlternative;