@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.
50 lines (49 loc) • 1.46 kB
TypeScript
/** A single root. */
export interface RootEntry {
/** The root's Cr form. */
readonly cr: string;
/** The root's stems. */
readonly stems: readonly [
(string | undefined)?,
(string | undefined)?,
(string | undefined)?,
(string | undefined)?
];
/** The root's stems (in CPT version). */
readonly CPT: readonly [
undefined?,
(string | undefined)?,
(string | undefined)?,
(string | undefined)?
];
/** The root's BSC meaning. */
readonly BSC?: string | undefined;
/** The root's CTE meaning. */
readonly CTE?: string | undefined;
/** The root's CSV meaning. */
readonly CSV?: string | undefined;
/** The root's OBJ meanings. */
readonly OBJ: readonly [
undefined?,
(string | undefined)?,
(string | undefined)?,
(string | undefined)?
];
/** The root's DYN meaning. */
readonly DYN?: string | undefined;
/** Additional information about each stem. */
readonly wikidata: readonly [
undefined?,
(string | undefined)?,
(string | undefined)?,
(string | undefined)?
];
}
/**
* Gets all roots 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 roots.
*/
export declare function getRoots(apiKey: string): Promise<RootEntry[]>;