@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.
30 lines (29 loc) • 1.52 kB
TypeScript
import { type AffixualAdjunct } from "./affixual/index.js";
import { type BiasAdjunct } from "./bias.js";
import { type ModularAdjunct } from "./modular/index.js";
import { type NumericAdjunct } from "./numeric.js";
import { type ParsingAdjunct } from "./parsing.js";
import { type RegisterAdjunct, type SingleRegisterAdjunct } from "./register.js";
import { type SuppletiveAdjunct } from "./suppletive/index.js";
export * from "./affixual/index.js";
export * from "./bias.js";
export * from "./modular/index.js";
export * from "./numeric.js";
export * from "./parsing.js";
export * from "./register.js";
export * from "./suppletive/index.js";
/** A general adjunct. */
export type Adjunct = AffixualAdjunct | BiasAdjunct | ModularAdjunct | NumericAdjunct | ParsingAdjunct | RegisterAdjunct | SingleRegisterAdjunct | SuppletiveAdjunct;
/** An adjunct other than a non-single {@link RegisterAdjunct}. */
export type PlainAdjunct = AffixualAdjunct | BiasAdjunct | ModularAdjunct | NumericAdjunct | ParsingAdjunct | SingleRegisterAdjunct | SuppletiveAdjunct;
/**
* Converts an adjunct into Ithkuil.
*
* @param adjunct The adjunct to be converted.
* @returns Romanized Ithkuilic text representing the adjunct.
*
* Note that for non-single register adjuncts, this returns a string of the form
* "X ... Y", "... X", or "...", depending on the adjunct type. For all other
* adjuncts, this function returns exactly what you would expect.
*/
export declare function adjunctToIthkuil(adjunct: Adjunct): string;