@zsnout/ithkuil/script/register/index.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 RegisterAdjunct } from "../../generate/index.js";
/** The mode of a register character. */
export type RegisterMode = "standard" | "alphabetic" | "transcriptive" | "transliterative";
/** SVG paths for all register characters. */
export declare const REGISTERS: {
    readonly standard: {
        readonly NRR: string;
        readonly DSV: string;
        readonly PNT: string;
        readonly CGT: string;
        readonly EXM: string;
        readonly SPF: string;
    };
    readonly alphabetic: {
        readonly NRR: string;
        readonly DSV: string;
        readonly PNT: string;
        readonly CGT: string;
        readonly EXM: string;
        readonly SPF: string;
    };
    readonly transcriptive: {
        readonly NRR: string;
        readonly DSV: string;
        readonly PNT: string;
        readonly CGT: string;
        readonly EXM: string;
        readonly SPF: string;
    };
    readonly transliterative: {
        readonly NRR: string;
        readonly DSV: string;
        readonly PNT: string;
        readonly CGT: string;
        readonly EXM: string;
        readonly SPF: string;
    };
};
/** SVG paths for all handwritten register characters. */
export declare const HANDWRITTEN_REGISTERS: {
    readonly standard: {
        readonly NRR: string;
        readonly DSV: string;
        readonly PNT: string;
        readonly CGT: string;
        readonly EXM: string;
        readonly SPF: string;
    };
    readonly alphabetic: {
        readonly NRR: string;
        readonly DSV: string;
        readonly PNT: string;
        readonly CGT: string;
        readonly EXM: string;
        readonly SPF: string;
    };
    readonly transcriptive: {
        readonly NRR: string;
        readonly DSV: string;
        readonly PNT: string;
        readonly CGT: string;
        readonly EXM: string;
        readonly SPF: string;
    };
    readonly transliterative: {
        readonly NRR: string;
        readonly DSV: string;
        readonly PNT: string;
        readonly CGT: string;
        readonly EXM: string;
        readonly SPF: string;
    };
};
/** Information about a register character. */
export interface RegisterCharacter {
    /** Whether this character is handwritten. */
    readonly handwritten?: boolean | undefined;
    /** The type of this register adjunct. */
    readonly type?: Exclude<RegisterAdjunct, "END"> | undefined;
    /** The mode of this register adjunct. */
    readonly mode?: RegisterMode | undefined;
}
/**
 * Writes a register adjunct in Ithkuil script.
 *
 * @param props Properties modifying this register adjunct.
 * @returns The register adjunct as an SVG path.
 */
export declare function Register(props: RegisterCharacter): SVGPathElement;