katex/src/types/index.ts

Fast math typesetting for the web.

export type Mode = "math" | "text";

// LaTeX argument type.
//   - "size": A size-like thing, such as "1em" or "5ex"
//   - "color": An html color, like "#abc" or "blue"
//   - "url": An url string, in which "\" will be ignored
//   -        if it precedes [#$%&~_^\{}]
//   - "raw": A string, allowing single character, percent sign,
//            and nested braces
//   - "original": The same type as the environment that the
//                 function being parsed is in (e.g. used for the
//                 bodies of functions like \textcolor where the
//                 first argument is special and the second
//                 argument is parsed normally)
//   - Mode: Node group parsed in given mode.
export type ArgType = "color" | "size" | "url" | "raw" | "original" | "hbox" |
    "primitive" | Mode;

// LaTeX display style.
export type StyleStr = "text" | "display" | "script" | "scriptscript";

// Allowable token text for "break" arguments in parser.
export type BreakToken = "]" | "}" | "\\endgroup" | "$" | "\\)" | "\\\\" | "\\end" |
    "EOF";

export type DelimiterSize = 1 | 2 | 3 | 4;

export type Slice1<S extends string> =
    S extends `${string}${infer Rest}` ? Rest : "";

export type Slice4<S extends string> =
    S extends `${string}${string}${string}${string}${infer Rest}` ? Rest : "";

export type Slice5<S extends string> =
    S extends `${string}${string}${string}${string}${string}${infer Rest}` ? Rest : "";

export type Measurement = {number: number, unit: string};

export type MathClass = "mord" | "mop" | "mbin" | "mrel" | "mopen" | "mclose" | "mpunct" | "minner";

export type Side = "left" | "right";