README.md

Note This repository is automatically generated from the main parser monorepo. Please submit any issues or pull requests there.

texast-util-add-preamble

Add a preamble to a texast syntax tree.

Contents

• texast-util-add-preamble
  • Contents
  • What is this?
  • When should I use this?
  • Install
  • Use
  • API
  • Syntax tree
  • Types
  • Compatibility
  • Security
  • Related
  • Contribute
  • License

What is this?

When should I use this?

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as

pnpm add texast-util-add-preamble
# or with yarn
# yarn add texast-util-add-preamble
# or with npm
# npm install texast-util-add-preamble

Use

API

---

addPreamble()

Signature

addPreamble(tree: Root, commands: PreambleCommand[]): Root;

Parameters

Name	Type
tree	Root
commands	PreambleCommand[]

Returns

Root

Defined in: lib/texast-util-add-preamble.ts:11

---

PreambleCommand

Properties

args?

(string | PreambleCommand)[]

Defined in: lib/texast-util-add-preamble.ts:8

opts?

(string | PreambleCommand)[]

Defined in: lib/texast-util-add-preamble.ts:7

type

string

Defined in: lib/texast-util-add-preamble.ts:6

Syntax tree

Types

Compatibility

Security

Related

Contribute

License

GPL-3.0-or-later © Thomas F. K. Jorna