feat: copied d.ts types from DefinitelyTyped

katex.js

@@ -158,7 +158,7 @@ export default {
      */
     ParseError,
     /**
-     * The shema of Settings
+     * The schema of Settings
      */
     SETTINGS_SCHEMA,
     /**

package.json

@@ -3,6 +3,7 @@
   "version": "0.16.8",
   "description": "Fast math typesetting for the web.",
   "main": "dist/katex.js",
+  "types": "types/katex.d.ts",
   "exports": {
     ".": {
       "require": "./dist/katex.js",
@@ -44,7 +45,8 @@
     "cli.js",
     "src/",
     "contrib/",
-    "dist/"
+    "dist/",
+    "types/"
   ],
   "license": "MIT",
   "packageManager": "yarn@3.2.2",

types/katex.d.ts

@@ -0,0 +1,162 @@
+// Type definitions for KaTeX 0.16
+// Project: https://katex.org/
+// Definitions by: Michael Randolph <https://github.com/mrand01>
+//                 Kevin Nguyen <https://github.com/knguyen0125>
+//                 bLue <https://github.com/dreamerblue>
+//                 Sebastian Weigand <https://github.com/s-weigand>
+//                 sapphi-red <https://github.com/sapphi-red>
+//                 Stefaans <https://github.com/Stefaans>
+// Definitions copied from: https://github.com/DefinitelyTyped/DefinitelyTyped
+// on 2023-08-07 by Kelvin Soh <https://github.com/kelvinsjk>
+
+export interface TrustContext {
+	command: string;
+	url: string;
+	protocol: string;
+}
+
+/** Documentation: https://katex.org/docs/options.html */
+export interface KatexOptions {
+	/**
+	 * If `true`, math will be rendered in display mode
+	 * (math in display style and center math on page)
+	 *
+	 * If `false`, math will be rendered in inline mode
+	 * @default false
+	 */
+	displayMode?: boolean | undefined;
+	/**
+	 * Determines the markup language of the output. The valid choices are:
+	 * - `html`: Outputs KaTeX in HTML only.
+	 * - `mathml`: Outputs KaTeX in MathML only.
+	 * - `htmlAndMathml`: Outputs HTML for visual rendering
+	 *   and includes MathML for accessibility.
+	 *
+	 * @default 'htmlAndMathml'
+	 */
+	output?: 'html' | 'mathml' | 'htmlAndMathml' | undefined;
+	/**
+	 * If `true`, display math has \tags rendered on the left
+	 * instead of the right, like \usepackage[leqno]{amsmath} in LaTeX.
+	 *
+	 * @default false
+	 */
+	leqno?: boolean | undefined;
+	/**
+	 * If `true`, display math renders flush left with a 2em left margin,
+	 * like \documentclass[fleqn] in LaTeX with the amsmath package.
+	 *
+	 * @default false
+	 */
+	fleqn?: boolean | undefined;
+	/**
+	 * If `true`, KaTeX will throw a `ParseError` when
+	 * it encounters an unsupported command or invalid LaTex
+	 *
+	 * If `false`, KaTeX will render unsupported commands as
+	 * text, and render invalid LaTeX as its source code with
+	 * hover text giving the error, in color given by errorColor
+	 * @default true
+	 */
+	throwOnError?: boolean | undefined;
+	/**
+	 * A Color string given in format `#XXX` or `#XXXXXX`
+	 */
+	errorColor?: string | undefined;
+	/**
+	 * A collection of custom macros.
+	 *
+	 * See `src/macros.js` for its usage
+	 */
+	macros?: any;
+	/**
+	 * Specifies a minimum thickness, in ems, for fraction lines,
+	 * \sqrt top lines, {array} vertical lines, \hline, \hdashline,
+	 * \underline, \overline, and the borders of \fbox, \boxed, and
+	 * \fcolorbox.
+	 */
+	minRuleThickness?: number | undefined;
+	/**
+	 * If `true`, `\color` will work like LaTeX's `\textcolor`
+	 * and takes 2 arguments
+	 *
+	 * If `false`, `\color` will work like LaTeX's `\color`
+	 * and takes 1 argument
+	 *
+	 * In both cases, `\textcolor` works as in LaTeX
+	 *
+	 * @default false
+	 */
+	colorIsTextColor?: boolean | undefined;
+	/**
+	 * All user-specified sizes will be caped to `maxSize` ems
+	 *
+	 * If set to Infinity, users can make elements and space
+	 * arbitrarily large
+	 *
+	 * @default Infinity
+	 */
+	maxSize?: number | undefined;
+	/**
+	 * Limit the number of macro expansions to specified number
+	 *
+	 * If set to `Infinity`, marco expander will try to fully expand
+	 * as in LaTex
+	 *
+	 * @default 1000
+	 */
+	maxExpand?: number | undefined;
+	/**
+	 * If `false` or `"ignore"`, allow features that make
+	 * writing in LaTex convenient but not supported by LaTex
+	 *
+	 * If `true` or `"error"`, throw an error for such transgressions
+	 *
+	 * If `"warn"`, warn about behavior via `console.warn`
+	 *
+	 * @default "warn"
+	 */
+	strict?: boolean | string | Function | undefined;
+	/**
+	 * If `false` (do not trust input), prevent any commands that could enable adverse behavior, rendering them instead in errorColor.
+	 *
+	 * If `true` (trust input), allow all such commands.
+	 *
+	 * @default false
+	 */
+	trust?: boolean | ((context: TrustContext) => boolean) | undefined;
+	/**
+	 * Place KaTeX code in the global group.
+	 *
+	 * @default false
+	 */
+	globalGroup?: boolean | undefined;
+}
+
+/**
+* KaTeX error, usually during parsing.
+*/
+export class ParseError implements Error {
+	constructor(message: string, lexer: any, position: number);
+
+	name: string;
+	message: string;
+	position: number;
+}
+
+/**
+* Renders a TeX expression into the specified DOM element
+* @param tex A TeX expression
+* @param element The DOM element to render into
+* @param options KaTeX options
+*/
+export function render(tex: string, element: HTMLElement, options?: KatexOptions): void;
+
+/**
+* Renders a TeX expression into an HTML string
+* @param tex A TeX expression
+* @param options KaTeX options
+*/
+export function renderToString(tex: string, options?: KatexOptions): string;
+
+export as namespace katex;