@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.
37 lines (36 loc) • 1.26 kB
TypeScript
/** A valence. */
export type Valence = "MNO" | "PRL" | "CRO" | "RCP" | "CPL" | "DUP" | "DEM" | "CNG" | "PTI";
/** An array containing all valences. */
export declare const ALL_VALENCES: readonly Valence[];
/** An object mapping from valences to their Ithkuilic translations. */
export declare const VALENCE_TO_ITHKUIL_MAP: {
readonly MNO: "a";
readonly PRL: "ä";
readonly CRO: "e";
readonly RCP: "i";
readonly CPL: "ëi";
readonly DUP: "ö";
readonly DEM: "o";
readonly CNG: "ü";
readonly PTI: "u";
};
/** An object mapping from valences to their names. */
export declare const VALENCE_TO_NAME_MAP: {
readonly MNO: "Monoactive";
readonly PRL: "Parallel";
readonly CRO: "Corollary";
readonly RCP: "Reciprocal";
readonly CPL: "Complementary";
readonly DUP: "Duplicative";
readonly DEM: "Demonstrative";
readonly CNG: "Contingent";
readonly PTI: "Participatory";
};
/**
* Converts a valence into Ithkuil.
*
* @param valence The valence to be converted.
* @param omitDefaultValence Whether MNO valence should be omitted.
* @returns Romanized Ithkuilic text representing the valence.
*/
export declare function valenceToIthkuil(valence: Valence, omitDefaultValence: boolean): string;