@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.09 kB
TypeScript
/** An affiliation. */
export type Affiliation = "CSL" | "COA" | "ASO" | "VAR";
/** An array containing all affiliations. */
export declare const ALL_AFFILIATIONS: readonly Affiliation[];
/** An object mapping affiliations to their names. */
export declare const AFFILIATION_TO_NAME_MAP: {
readonly CSL: "Consolidative";
readonly COA: "Coalescent";
readonly ASO: "Associative";
readonly VAR: "Variative";
};
/** An object mapping affiliations to their Ithkuilic translations. */
export declare const AFFILIATION_TO_ITHKUIL_MAP: {
readonly CSL: readonly ["", ""];
readonly COA: readonly ["r", "rļ"];
readonly ASO: readonly ["l", "nļ"];
readonly VAR: readonly ["ř", "ň"];
};
/**
* Converts an affiliation into Ithkuil.
*
* @param affiliation The affiliation to be converted.
* @param isStandalone Whether the affiliation is the only affix present in the
* Ca affix complex.
* @returns Romanized Ithkuilic text representing the affiliation.
*/
export declare function affiliationToIthkuil(affiliation: Affiliation, isStandalone: boolean): string;