@zsnout/ithkuil/parse/referential/referent-list.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 { ReferentList } from "../../generate/referential/referent/list.js";
/**
 * Parses a referent list (e.g. `"sml"`).
 *
 * @param list The referent list to be parsed.
 * @returns The parsed `ReferentList`.
 */
export declare function parseReferentList(list: string): ReferentList;
/**
 * Parses a referent list along with an optional perspective (e.g. `"smlx"`).
 *
 * @param list The referent list and perspective to be parsed.
 * @param isReferentialAffix Whether the referent list is from a referential
 *   affix.
 * @returns An array containing two items: an array of parsed referents, and an
 *   optional perspective.
 */
export declare function parseReferentListAndPerspective(list: string, isReferentialAffix: true): [referentList: ReferentList, perspective: "G" | "N" | undefined];
/**
 * Parses a referent list along with an optional perspective (e.g. `"smlx"`).
 *
 * @param list The referent list and perspective to be parsed.
 * @param isReferentialAffix Whether the referent list is from a referential
 *   affix.
 * @returns An array containing two items: an array of parsed referents, and an
 *   optional perspective.
 */
export declare function parseReferentListAndPerspective(list: string, isReferentialAffix: boolean): [referentList: ReferentList, perspective: "G" | "N" | "A" | undefined];