@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.
28 lines (27 loc) • 1.15 kB
TypeScript
/**
* The type of a modular adjunct, indicating whether it has scope over the
* entire next formative, only the parent formative, or only the concatenated
* formative.
*/
export type ModularAdjunctType = "WHOLE" | "PARENT" | "CONCAT";
/** An array containing all modular adjunct types. */
export declare const ALL_MODULAR_ADJUNCT_TYPES: readonly ModularAdjunctType[];
/** An object mapping from modular adjunct types to their Ithkuilic translations. */
export declare const MODULAR_ADJUNCT_TYPE_TO_ITHKUIL_MAP: {
readonly WHOLE: "";
readonly PARENT: "w";
readonly CONCAT: "y";
};
/** An object mapping from modular adjunct types to what they apply to. */
export declare const MODULAR_ADJUNCT_TYPE_TO_DESCRIPTION_MAP: {
readonly WHOLE: "entire formative";
readonly PARENT: "parent formative only";
readonly CONCAT: "concatenated formative only";
};
/**
* Converts a modular adjunct type into Ithkuil.
*
* @param type The modular adjunct type to be converted.
* @returns Romanized Ithkuilic text representing the type.
*/
export declare function modularAdjunctTypeToIthkuil(type: ModularAdjunctType): "" | "w" | "y";