@zsnout/ithkuil/generate/formative/slot-5/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 Affix } from "../../affix/index.js";
import { WithWYAlternative } from "../../helpers/with-wy-alternative.js";
/** Information directly pertaining to Slot V. */
export type SlotV = readonly Affix[];
/** Additional information relevant to Slot V. */
export type SlotVMetadata = {
    /** Whether Slot VI is elided. */
    readonly isSlotVIElided: boolean;
    /** Whether Slot V is at the end of the word. */
    readonly isAtEndOfWord: boolean;
};
/**
 * Converts Slot V into Ithkuil.
 *
 * @param slot The Slot V affixes of the formative.
 * @param metadata Additional information relevant to Slot V.
 * @returns A `WithWYAlternative` containing romanized Ithkuilic text
 *   representing Slot V.
 */
export declare function slotVToIthkuil(slot: SlotV, metadata: SlotVMetadata): WithWYAlternative;