ts-pptx

Appearance

Reference ​

Use this area for stable public contracts. Implementation details such as internal XML generators stay out of the public API reference unless they are deliberately exposed through the package boundary.

Public API ​

The generated TypeDoc reference is built from public entry points:

  • src/index.ts
  • src/node.ts
  • src/browser.ts

src/inspect.ts, src/measure.ts, src/read.ts, src/script.ts, src/math.ts, and src/zip.ts are separate public subpaths (see Runtime And Package Support) not covered by the generated TypeDoc reference; they're documented by hand instead: PPTX Inspection, PPTX Read / Round-Trip, PPTX To Script, Measured Text Fit, and Math Equations. src/zip.ts has no dedicated page yet: it is internal OPC/zip plumbing shared by read and inspect.

After running pnpm run docs:api, read the generated reference at reference/api/index.md.

Object Identity ​

Object Identity documents the objectName contract for stable PowerPoint Selection Pane names and the current altText serialization contract for images and charts.

Layout Units ​

Layout Units documents standard slide-layout constants and unit helpers for converting inches, points, pixels-at-DPI, and EMUs.

PPTX Inspection ​

PPTX Inspection documents low-level package inspection, slide/object extraction, and geometry helpers for downstream tools.

PPTX To Script ​

PPTX To Script documents turning an existing deck into runnable TypeScript that rebuilds it through the public write API: the two output tiers, the deck IR they share, and the fidelity notes that state what a conversion drops.

Package Boundary ​

  • Supported import paths are declared in package.json exports.
  • Typed consumer contracts come from generated declarations.
  • Internal src/gen-*.ts generation primitives are not consumer import paths.

Commands ​

Stable verification commands are documented in Testing Guide. Development commands are documented in Development Guide.