Referencia
Puntos de entrada del paquete
Cada ruta importable y lo que hay detrás.
El paquete distribuye salida compilada con declaraciones de tipos. Todos los
puntos de entrada de abajo están declarados en exports, así que se resuelven en
Node y en los bundlers sin necesidad de importar en profundidad dentro de
dist/.
docxcelerate
La superficie principal: el compilador de documentos, los helpers de artefactos, los derivadores, los tipos de runtime y todos los tipos del dominio del documento.
import {
buildDocument,
buildProjectPreviewDocument,
cleanMinimalDocumentStyle,
dataRef,
derive,
type DocumentModel,
type ParagraphNode,
} from "docxcelerate";docxcelerate/document
La definición de un proyecto de documento — el punto de entrada que usa un
document.project.ts generado. La CLI y los nombres de archivo generados siguen
diciendo document; la API, no.
import { defineDocumentProject } from "docxcelerate/document";docxcelerate/template
La superficie de autoría: los elementos, los hooks y template mismo. Esto es
lo que importa un archivo de componente.
import {
Document,
Graph,
Image,
Paragraph,
Section,
TableOfContents,
template,
useAvailableTokens,
useFormat,
usePlaceholderData,
useSetPlaceholders,
useSetPrompts,
useShared,
useState,
} from "docxcelerate/template";Cada nombre de elemento es también un tipo de componente, de modo que const Greeting: Paragraph = () => <Paragraph … /> nombra lo que produce un componente
y rechaza devolver el tipo equivocado.
Su runtime de JSX está expuesto en docxcelerate/template/jsx-runtime (y
.../jsx-dev-runtime), que es a donde resuelve jsxImportSource.
docxcelerate/docx
Construcción de DOCX.
import { createDocxBlob, createDocxDocument, renderDocxBytes } from "docxcelerate/docx";Hay un solo renderizador y escribe archivos de Word. Para mostrar un documento en
pantalla, empaquétalo y vuelve a leer el archivo con un visor DOCX: eso es lo que
hace la app de vista previa de tu workspace mediante docx-preview, y también
las vistas previas de este sitio. Un segundo renderizador que maquetara el modelo
en HTML sería una segunda respuesta a qué aspecto tiene un documento, y la que
nadie abre en Word es la que se desvía.
docxcelerate/scaffold y /cli
El generador de workspaces y su interfaz de línea de comandos, para construir tus propias herramientas encima.
import { scaffoldWorkspace } from "docxcelerate/scaffold";