Skip to content

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/core.ts
  • src/inspect.ts
  • src/node.ts
  • src/browser.ts
  • src/standalone.ts

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.

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.