latex-utensils/out/types/src/latex/latex_parser.d.ts

A LaTeX parser, a BibTeX parser, and utilities

/**
 * LaTeX parser.
 *
 * @example
 * ```ts
 * import {latexParser as lp} from 'latex-utensils'
 *
 * const ast = lp.parse('a $b+c$ d')
 * const pat = lp.pattern(lp.isInlineMath)
 *               .child(lp.isMathCharacter)
 * const ret0 = pat.matchAll(ast.content)
 * const ret1 = lp.find(ast.content, lp.isInlineMath)
 * ```
 */
/** */
import * as lp from './latex_parser_types';
import { ParserOptions as ParserOptionsBase } from '../pegjs/pegjs_types';
export { find, findAll, findAllSequences, findNodeAt } from './find_all';
export type { FindResult, Position, PositionLc, PositionOs, SequenceResult, Typeguard } from './find_all';
export { pattern } from './matcher';
export type { MatchOptions, MatchResult, Pattern } from './matcher';
export { stringify } from './stringify';
export * from './latex_parser_types';
export { isSyntaxError } from '../pegjs/pegjs_types';
export type { Location, SyntaxError } from '../pegjs/pegjs_types';
/**
 * LaTeX parser options.
 */
export interface ParserOptions extends ParserOptionsBase {
    /**
     * Specifies a rule with which the parser begins. If `'Root'` is set, the whole document is parsed.
     * If `'Preamble'` is set, only the preamble is parsed.
     *
     * @default 'Root'
     */
    startRule?: 'Root' | 'Preamble';
    /**
     * All the comments in the LaTeX document will be extracted into a returned AST also.
     *
     * @default false
     */
    enableComment?: boolean;
    /**
     * The `location` property will be available for `MathCharacter`.
     *
     * @default false
     */
    enableMathCharacterLocation?: boolean;
}
/**
 * Parses a LaTeX document and returns a LaTeX AST.
 * @param texString LaTeX document to be parsed.
 * @param optArg Options.
 *
 * @example
 * ```ts
 * import {latexParser} from 'latex-utensils'
 *
 * const ast = latexParser.parse('a $b+c$ d')
 * ```
 */
export declare function parse(texString: string, optArg?: ParserOptions): lp.LatexAst;
/**
 *
 * @param texString
 * @param optArg
 */
export declare function parsePreamble(texString: string, optArg?: {
    timeout: number;
}): lp.AstPreamble;