mirror of
https://github.com/borbann-platform/srs-document.git
synced 2025-12-23 14:34:03 +01:00
29 lines
1.8 KiB
Markdown
29 lines
1.8 KiB
Markdown
<!-- DO NOT MODIFY -->
|
|
<!-- This file was autogenerated by build-docs.ts -->
|
|
<!-- Edit the docstring in index.ts and regenerate -->
|
|
<!-- rather than editing this file directly. -->
|
|
# unified-latex-util-match
|
|
|
|
## What is this?
|
|
|
|
Functions to match different `Ast.Node` types in a `unified-latex` Abstract Syntax Tree (AST).
|
|
|
|
## When should I use this?
|
|
|
|
If you need a type-guard to ensure a node is of a certain type; for example, during a call to `unified-latex-until-visit`.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install @unified-latex/unified-latex-util-match
|
|
```
|
|
|
|
This package contains both esm and commonjs exports. To explicitly access the esm export,
|
|
import the `.js` file. To explicitly access the commonjs export, import the `.cjs` file.
|
|
|
|
# Constants
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------- |
|
|
| `match` | `{ macro(node: any, macroName?: string): node is Ast.Macro; anyMacro(node: any): node is Ast.Macro; environment(node: any, envName?: string): node is Ast.Environment; ... 12 more ...; createEnvironmentMatcher: (macros: string[] \| Record<string, unknown>) => Ast.TypeGuard<Ast.Environment>; }` | Functions to match different types of nodes. |
|