UNPKG

@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.

29 lines (28 loc) 1.22 kB
/** The scope of a modular adjunct. */ export type ModularAdjunctScope = "CASE/MOOD+ILL/VAL" | "CASE/MOOD" | "FORMATIVE" | "ADJACENT"; /** An array containing all modular adjunct scopes. */ export declare const ALL_MODULAR_ADJUNCT_SCOPES: readonly ModularAdjunctScope[]; /** * An object mapping from modular adjunct scopes to their Ithkuilic * translations. */ export declare const MODULAR_ADJUNCT_SCOPE_TO_ITHKUIL_MAP: { readonly "CASE/MOOD+ILL/VAL": "a"; readonly "CASE/MOOD": "e"; readonly FORMATIVE: "i"; readonly ADJACENT: "o"; }; /** An object mapping from modular adjunct scopes to what they have scope over. */ export declare const MODULAR_ADJUNCT_SCOPE_TO_DESCRIPTION_MAP: { readonly "CASE/MOOD+ILL/VAL": "Case/Mood and Validation + Illocution"; readonly "CASE/MOOD": "Case/Mood"; readonly FORMATIVE: "the formative as a whole"; readonly ADJACENT: "the formative and adjacent adjuncts"; }; /** * Converts a modular adjunct scope into Ithkuil. * * @param scope The modular adjunct scope to be converted. * @returns Romanized Ithkuilic text representing the adjunct. */ export declare function modularAdjunctScopeToIthkuil(scope: ModularAdjunctScope): "a" | "e" | "i" | "o";