@zsnout/ithkuil/generate/affix/affixes.d.ts

A set of tools which can generate and parse romanized Ithkuil text and which can generate Ithkuil script from text and JSON data.

import { type Affix, type AffixShortcut, type Case, type CaseScope, type Illocution, type Mood, type PartialCA, type VN, type Validation } from "../index.js";
/** The Cs form for the Valence affix. */
export declare const VAL = "\u017Ck";
/** The Cs form for the Phase affix. */
export declare const PHS = "b\u017E";
/** The Cs form for the Effect affix. */
export declare const EFE = "m";
/**
 * The Cs form for the Level affix. Type-1 denotes relative levels, type-2
 * denotes absolute levels.
 */
export declare const LVL = "\u0159\u017E";
/** The Cs form for the Aspects 1 affix. */
export declare const AP1 = "mc";
/** The Cs form for the Aspects 2 affix. */
export declare const AP2 = "m\u010D";
/** The Cs form for the Aspects 3 affix. */
export declare const AP3 = "m\u017C";
/** The Cs form for the Aspects 4 affix. */
export declare const AP4 = "mj";
/**
 * The Cs form for the Mood/Case-Scope affix. 1-5 are moods, 6-9 are
 * case-scopes, and 0 is CCV.
 */
export declare const MCS = "b\u017C";
/**
 * The Cs form for the Illocution/Validation affix. Type-1 = illocution, type-2
 * = validation.
 */
export declare const IVL = "n\u013C";
/**
 * Converts a Vn form into an affix.
 *
 * @param vn The Vn form to be converted.
 * @returns The Vn form as an affix.
 */
export declare function vnToAffix(vn: VN): Affix;
/**
 * Converts a Ca, Vn, Cn, Vc, Vk, or Vf form into an affix.
 *
 * @param item The Ca, Vn, Cn, Vc, Vk, or Vf form to be converted.
 * @returns The Ca, Vn, Cn, Vc, Vk, or Vf form as an affix, or undefined if no
 *   affix is needed. `undefined` is only returned for FAC mood and CCN
 *   case-scope, which are not specifiable via affixes.
 */
export declare function toAffix(item: PartialCA | VN | Mood | CaseScope | Case | Illocution | Validation | AffixShortcut): Affix | undefined;