@zsnout/ithkuil/data/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.

/** A single affix. */
export interface AffixEntry {
    /** The affix's Cs form. */
    readonly cs: string;
    /** The affix's abbreviation. */
    readonly abbreviation: string;
    /** The affix's degrees. */
    readonly degrees: readonly [
        undefined?,
        (string | undefined)?,
        (string | undefined)?,
        (string | undefined)?,
        (string | undefined)?,
        (string | undefined)?,
        (string | undefined)?,
        (string | undefined)?,
        (string | undefined)?,
        (string | undefined)?
    ];
    /** A description of the affix. */
    readonly description?: string | undefined;
}
/**
 * Gets all affixes described in the Collaborative Ithkuil IV Roots and Affixes
 * Spreadsheet.
 *
 * @param apiKey The Google Sheets API key to use when fetching data.
 * @returns An array of affixes.
 */
export declare function getAffixes(apiKey: string): Promise<AffixEntry[]>;