@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.
36 lines (35 loc) • 1.18 kB
TypeScript
/** A phase. */
export type Phase = "PUN" | "ITR" | "REP" | "ITM" | "RCT" | "FRE" | "FRG" | "VAC" | "FLC";
/** An array containing all phases. */
export declare const ALL_PHASES: readonly Phase[];
/** An object mapping phases to their Ithkuilic translations. */
export declare const PHASE_TO_ITHKUIL_MAP: {
readonly PUN: "ai";
readonly ITR: "au";
readonly REP: "ei";
readonly ITM: "eu";
readonly RCT: "ëu";
readonly FRE: "ou";
readonly FRG: "oi";
readonly VAC: "iu";
readonly FLC: "ui";
};
/** An object mapping phases to their names. */
export declare const PHASE_TO_NAME_MAP: {
readonly PUN: "Punctual";
readonly ITR: "Iterative";
readonly REP: "Repetitive";
readonly ITM: "Intermittent";
readonly RCT: "Recurrent";
readonly FRE: "Frequentative";
readonly FRG: "Fragmentative";
readonly VAC: "Vacillitative";
readonly FLC: "Fluctuative";
};
/**
* Converts a phase into Ithkuil.
*
* @param phase The phase to be converted.
* @returns Romanized Ithkuilic text representing the phase.
*/
export declare function phaseToIthkuil(phase: Phase): "ai" | "ei" | "oi" | "ui" | "au" | "eu" | "ëu" | "ou" | "iu";