Lifecycle
06createDocx({ paragraphs? }?) => DocxopenDocx(bytes: Uint8Array) => DocxfromBlob(blob: Blob) => Promise<Docx>toUint8Array(doc: Docx) => Uint8ArraytoBlob(doc: Docx) => Blobclone(doc: Docx) => Docx
§ 03 · API reference
Every public export, grouped by area.
@office-kit/docx exposes 121 standalone functions
and constants. Each one takes a Docx as its first argument (where
applicable) and is side-effect-free at the module level, so bundlers can tree-shake
anything you don't import. For full signatures and parameter shapes, see src/index.ts and the repository.
Paragraphs & blocks
09appendParagraphinsertParagraphAtremoveParagraphappendHeadingappendPageBreakappendLineBreakappendSectionBreakclearBodyparagraphs
Inline & text
20replaceTextreplaceTextEverywherefindTextfindTextEverywhereappendTextRunsetParagraphTextparagraphTextsetRunFormatclearRunFormatgetRunFormatsetParagraphAlignmentgetParagraphAlignmentsetParagraphIndentsetParagraphSpacingsetParagraphBorderssetParagraphShadinggetParagraphStylegetParagraphNumberingmergeAdjacentRunsmergeAdjacentRunsInBody
Styles & numbering
10addStyleremoveStylelistStylesensureHeadingStylesfindStyleIdByNamesetParagraphStyleaddBulletListaddNumberedListapplyListToParagraphmergeStylesFromTemplate
Tables
14addTabletablesremoveTableremoveAllTablesunwrapTableappendTableRowremoveTableRowsetTableRowAsHeadersetTableRowHeightsetTableBorderssetTableCellTextgetTableCellTextsetTableCellShadingsetTableCellVerticalAlign
Images
08addImageaddImageRuninsertImageIntoimagesimageReferencesreplaceImagereplaceImageByAltTextremoveAllImages
Headers, footers, sections
10addHeaderaddFooteraddPageNumberFootersetPageSizesetPageMarginssetPageOrientationheadersfootersremoveAllHeadersremoveAllFooters
Comments, notes, hyperlinks, bookmarks
15addCommentaddFootnoteaddEndnoteremoveAllCommentsremoveAllFootnotesremoveAllEndnotesaddHyperlinkaddInternalHyperlinkexternalHyperlinkssetHyperlinkUrlremoveAllHyperlinksaddBookmarkremoveBookmarkremoveAllBookmarksbookmarks
Fields & tracked changes
05appendFieldaddTableOfContentsappendMergeFieldacceptAllRevisionsrejectAllRevisions
Document properties
08corePropertiessetCorePropertiesappPropertiessetAppPropertiestitleauthorsetTitlesetAuthor
Diagnostics
06validatevalidatePackagestatisticsoutlinefieldstext
Low-level part access
05stylesPartnumberingPartcommentsPartfootnotesPartendnotesPart
Page-size & margin constants
04PAGE_SIZE_A4PAGE_SIZE_LETTERMARGINS_NORMALVERSION
Browser preview (@office-kit/docx-preview)
01previewToDOM(source, container, options?) => Promise<Handle>
Need usage shapes? Read the getting-started page or the type-checked recipes.