[{"data":1,"prerenderedAt":1339},["ShallowReactive",2],{"navigation_docs_en":3,"-en-docx-export":335,"-en-docx-export-surround":1334},[4,31,61,91,175,256],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":30},"Getting Started","i-lucide-rocket","\u002Fen\u002Fgetting-started","en\u002F01.getting-started",[10,14,18,22,26],{"title":11,"path":12,"stem":13},"Introduction","\u002Fen\u002Fgetting-started\u002Fintroduction","en\u002F01.getting-started\u002F01.introduction",{"title":15,"path":16,"stem":17},"Installation","\u002Fen\u002Fgetting-started\u002Finstallation","en\u002F01.getting-started\u002F02.installation",{"title":19,"path":20,"stem":21},"Command Line Interface (CLI)","\u002Fen\u002Fgetting-started\u002Fcommand-line-interface","en\u002F01.getting-started\u002F03.command-line-interface",{"title":23,"path":24,"stem":25},"AI Tools","\u002Fen\u002Fgetting-started\u002Fai-tools","en\u002F01.getting-started\u002F04.ai-tools",{"title":27,"path":28,"stem":29},"AI Integration","\u002Fen\u002Fgetting-started\u002Fai-integration","en\u002F01.getting-started\u002F05.ai-integration",false,{"title":32,"icon":33,"path":34,"stem":35,"children":36,"page":30},"CORE","i-lucide-box","\u002Fen\u002Fcore","en\u002F02.core",[37,41,45,49,53,57],{"title":38,"path":39,"stem":40},"@office-open\u002Fcore","\u002Fen\u002Fcore\u002Foverview","en\u002F02.core\u002F01.overview",{"title":42,"path":43,"stem":44},"Descriptor System","\u002Fen\u002Fcore\u002Fdescriptors","en\u002F02.core\u002F02.descriptors",{"title":46,"path":47,"stem":48},"Values and Validation","\u002Fen\u002Fcore\u002Fvalues","en\u002F02.core\u002F03.values",{"title":50,"path":51,"stem":52},"Unit Converters","\u002Fen\u002Fcore\u002Fconverters","en\u002F02.core\u002F04.converters",{"title":54,"path":55,"stem":56},"Charts","\u002Fen\u002Fcore\u002Fcharts","en\u002F02.core\u002F05.charts",{"title":58,"path":59,"stem":60},"Parser","\u002Fen\u002Fcore\u002Fparser","en\u002F02.core\u002F06.parser",{"title":62,"icon":63,"path":64,"stem":65,"children":66,"page":30},"XML","i-lucide-code-xml","\u002Fen\u002Fxml","en\u002F03.xml",[67,71,75,79,83,87],{"title":68,"path":69,"stem":70},"@office-open\u002Fxml","\u002Fen\u002Fxml\u002Foverview","en\u002F03.xml\u002F01.overview",{"title":72,"path":73,"stem":74},"Parsing","\u002Fen\u002Fxml\u002Fparsing","en\u002F03.xml\u002F02.parsing",{"title":76,"path":77,"stem":78},"Serialization","\u002Fen\u002Fxml\u002Fserialization","en\u002F03.xml\u002F03.serialization",{"title":80,"path":81,"stem":82},"Query Utilities","\u002Fen\u002Fxml\u002Fquery-utilities","en\u002F03.xml\u002F04.query-utilities",{"title":84,"path":85,"stem":86},"XML Escape","\u002Fen\u002Fxml\u002Fescape","en\u002F03.xml\u002F05.escape",{"title":88,"path":89,"stem":90},"Type Reference","\u002Fen\u002Fxml\u002Ftypes","en\u002F03.xml\u002F06.types",{"title":92,"icon":93,"path":94,"stem":95,"children":96,"page":30},"DOCX","i-lucide-file-text","\u002Fen\u002Fdocx","en\u002F04.docx",[97,101,105,109,113,117,121,124,128,132,136,140,144,148,152,156,160,164,168,171],{"title":98,"path":99,"stem":100},"@office-open\u002Fdocx","\u002Fen\u002Fdocx\u002Foverview","en\u002F04.docx\u002F01.overview",{"title":102,"path":103,"stem":104},"Quick Start","\u002Fen\u002Fdocx\u002Fquickstart","en\u002F04.docx\u002F02.quickstart",{"title":106,"path":107,"stem":108},"Text and Paragraphs","\u002Fen\u002Fdocx\u002Ftext-and-paragraphs","en\u002F04.docx\u002F03.text-and-paragraphs",{"title":110,"path":111,"stem":112},"Tables","\u002Fen\u002Fdocx\u002Ftables","en\u002F04.docx\u002F04.tables",{"title":114,"path":115,"stem":116},"Images","\u002Fen\u002Fdocx\u002Fimages","en\u002F04.docx\u002F05.images",{"title":118,"path":119,"stem":120},"Text Boxes","\u002Fen\u002Fdocx\u002Ftextbox","en\u002F04.docx\u002F06.textbox",{"title":54,"path":122,"stem":123},"\u002Fen\u002Fdocx\u002Fcharts","en\u002F04.docx\u002F07.charts",{"title":125,"path":126,"stem":127},"SmartArt","\u002Fen\u002Fdocx\u002Fsmartart","en\u002F04.docx\u002F08.smartart",{"title":129,"path":130,"stem":131},"Media","\u002Fen\u002Fdocx\u002Fmedia","en\u002F04.docx\u002F09.media",{"title":133,"path":134,"stem":135},"Links","\u002Fen\u002Fdocx\u002Flinks","en\u002F04.docx\u002F10.links",{"title":137,"path":138,"stem":139},"Headers and Footers","\u002Fen\u002Fdocx\u002Fheaders-and-footers","en\u002F04.docx\u002F11.headers-and-footers",{"title":141,"path":142,"stem":143},"Equations and Symbols","\u002Fen\u002Fdocx\u002Fequations-and-symbols","en\u002F04.docx\u002F12.equations-and-symbols",{"title":145,"path":146,"stem":147},"Styles and Themes","\u002Fen\u002Fdocx\u002Fstyles-and-themes","en\u002F04.docx\u002F13.styles-and-themes",{"title":149,"path":150,"stem":151},"Page Layout","\u002Fen\u002Fdocx\u002Fpage-layout","en\u002F04.docx\u002F14.page-layout",{"title":153,"path":154,"stem":155},"References","\u002Fen\u002Fdocx\u002Freferences","en\u002F04.docx\u002F15.references",{"title":157,"path":158,"stem":159},"Comments and Revisions","\u002Fen\u002Fdocx\u002Fcomments-and-revisions","en\u002F04.docx\u002F16.comments-and-revisions",{"title":161,"path":162,"stem":163},"Document Properties","\u002Fen\u002Fdocx\u002Fproperties","en\u002F04.docx\u002F17.properties",{"title":165,"path":166,"stem":167},"Export","\u002Fen\u002Fdocx\u002Fexport","en\u002F04.docx\u002F18.export",{"title":72,"path":169,"stem":170},"\u002Fen\u002Fdocx\u002Fparsing","en\u002F04.docx\u002F19.parsing",{"title":172,"path":173,"stem":174},"Patching","\u002Fen\u002Fdocx\u002Fpatch","en\u002F04.docx\u002F20.patch",{"title":176,"icon":177,"path":178,"stem":179,"children":180,"page":30},"PPTX","i-lucide-presentation","\u002Fen\u002Fpptx","en\u002F05.pptx",[181,185,188,192,195,198,201,204,207,210,214,217,220,224,227,231,235,239,243,247,250,253],{"title":182,"path":183,"stem":184},"@office-open\u002Fpptx","\u002Fen\u002Fpptx\u002Foverview","en\u002F05.pptx\u002F01.overview",{"title":102,"path":186,"stem":187},"\u002Fen\u002Fpptx\u002Fquickstart","en\u002F05.pptx\u002F02.quickstart",{"title":189,"path":190,"stem":191},"Shapes and Text","\u002Fen\u002Fpptx\u002Fshapes-and-text","en\u002F05.pptx\u002F03.shapes-and-text",{"title":110,"path":193,"stem":194},"\u002Fen\u002Fpptx\u002Ftables","en\u002F05.pptx\u002F04.tables",{"title":114,"path":196,"stem":197},"\u002Fen\u002Fpptx\u002Fimages","en\u002F05.pptx\u002F05.images",{"title":54,"path":199,"stem":200},"\u002Fen\u002Fpptx\u002Fcharts","en\u002F05.pptx\u002F06.charts",{"title":125,"path":202,"stem":203},"\u002Fen\u002Fpptx\u002Fsmartart","en\u002F05.pptx\u002F07.smartart",{"title":129,"path":205,"stem":206},"\u002Fen\u002Fpptx\u002Fmedia","en\u002F05.pptx\u002F08.media",{"title":133,"path":208,"stem":209},"\u002Fen\u002Fpptx\u002Flinks","en\u002F05.pptx\u002F09.links",{"title":211,"path":212,"stem":213},"Lines and Connectors","\u002Fen\u002Fpptx\u002Flines-and-connectors","en\u002F05.pptx\u002F10.lines-and-connectors",{"title":137,"path":215,"stem":216},"\u002Fen\u002Fpptx\u002Fheaders-and-footers","en\u002F05.pptx\u002F11.headers-and-footers",{"title":141,"path":218,"stem":219},"\u002Fen\u002Fpptx\u002Fequations-and-symbols","en\u002F05.pptx\u002F12.equations-and-symbols",{"title":221,"path":222,"stem":223},"Slide Layout","\u002Fen\u002Fpptx\u002Fslide-layout","en\u002F05.pptx\u002F13.slide-layout",{"title":145,"path":225,"stem":226},"\u002Fen\u002Fpptx\u002Fstyles-and-themes","en\u002F05.pptx\u002F14.styles-and-themes",{"title":228,"path":229,"stem":230},"Effects and Fills","\u002Fen\u002Fpptx\u002Feffects-and-fills","en\u002F05.pptx\u002F15.effects-and-fills",{"title":232,"path":233,"stem":234},"Transitions","\u002Fen\u002Fpptx\u002Ftransitions","en\u002F05.pptx\u002F16.transitions",{"title":236,"path":237,"stem":238},"Animations","\u002Fen\u002Fpptx\u002Fanimations","en\u002F05.pptx\u002F17.animations",{"title":240,"path":241,"stem":242},"Comments","\u002Fen\u002Fpptx\u002Fcomments","en\u002F05.pptx\u002F18.comments",{"title":244,"path":245,"stem":246},"Presentation Properties","\u002Fen\u002Fpptx\u002Fproperties","en\u002F05.pptx\u002F19.properties",{"title":165,"path":248,"stem":249},"\u002Fen\u002Fpptx\u002Fexport","en\u002F05.pptx\u002F20.export",{"title":72,"path":251,"stem":252},"\u002Fen\u002Fpptx\u002Fparsing","en\u002F05.pptx\u002F21.parsing",{"title":172,"path":254,"stem":255},"\u002Fen\u002Fpptx\u002Fpatch","en\u002F05.pptx\u002F22.patch",{"title":257,"icon":258,"path":259,"stem":260,"children":261,"page":30},"XLSX","i-lucide-table-2","\u002Fen\u002Fxlsx","en\u002F06.xlsx",[262,266,269,273,277,281,285,289,292,295,299,303,307,311,314,318,322,326,329,332],{"title":263,"path":264,"stem":265},"@office-open\u002Fxlsx","\u002Fen\u002Fxlsx\u002Foverview","en\u002F06.xlsx\u002F01.overview",{"title":102,"path":267,"stem":268},"\u002Fen\u002Fxlsx\u002Fquickstart","en\u002F06.xlsx\u002F02.quickstart",{"title":270,"path":271,"stem":272},"Cells & Data","\u002Fen\u002Fxlsx\u002Fcells","en\u002F06.xlsx\u002F03.cells",{"title":274,"path":275,"stem":276},"Styles","\u002Fen\u002Fxlsx\u002Fstyles","en\u002F06.xlsx\u002F04.styles",{"title":278,"path":279,"stem":280},"Merge, Columns & Rows","\u002Fen\u002Fxlsx\u002Fmerge-col-row","en\u002F06.xlsx\u002F05.merge-col-row",{"title":282,"path":283,"stem":284},"Hyperlinks","\u002Fen\u002Fxlsx\u002Flinks","en\u002F06.xlsx\u002F06.links",{"title":286,"path":287,"stem":288},"Pivot Tables","\u002Fen\u002Fxlsx\u002Fpivot-tables","en\u002F06.xlsx\u002F07.pivot-tables",{"title":114,"path":290,"stem":291},"\u002Fen\u002Fxlsx\u002Fimages","en\u002F06.xlsx\u002F08.images",{"title":54,"path":293,"stem":294},"\u002Fen\u002Fxlsx\u002Fcharts","en\u002F06.xlsx\u002F09.charts",{"title":296,"path":297,"stem":298},"Page Setup & Headers\u002FFooters","\u002Fen\u002Fxlsx\u002Fpage-setup","en\u002F06.xlsx\u002F10.page-setup",{"title":300,"path":301,"stem":302},"Formulas","\u002Fen\u002Fxlsx\u002Fformulas","en\u002F06.xlsx\u002F11.formulas",{"title":304,"path":305,"stem":306},"Freeze Panes & Auto Filter","\u002Fen\u002Fxlsx\u002Ffreeze-filter","en\u002F06.xlsx\u002F12.freeze-filter",{"title":308,"path":309,"stem":310},"Data Validation","\u002Fen\u002Fxlsx\u002Fvalidation","en\u002F06.xlsx\u002F13.validation",{"title":240,"path":312,"stem":313},"\u002Fen\u002Fxlsx\u002Fcomments","en\u002F06.xlsx\u002F14.comments",{"title":315,"path":316,"stem":317},"Protection","\u002Fen\u002Fxlsx\u002Fprotection","en\u002F06.xlsx\u002F15.protection",{"title":319,"path":320,"stem":321},"Shared Workbook Revisions","\u002Fen\u002Fxlsx\u002Frevisions","en\u002F06.xlsx\u002F16.revisions",{"title":323,"path":324,"stem":325},"Workbook Properties","\u002Fen\u002Fxlsx\u002Fproperties","en\u002F06.xlsx\u002F17.properties",{"title":165,"path":327,"stem":328},"\u002Fen\u002Fxlsx\u002Fexport","en\u002F06.xlsx\u002F18.export",{"title":72,"path":330,"stem":331},"\u002Fen\u002Fxlsx\u002Fparsing","en\u002F06.xlsx\u002F19.parsing",{"title":172,"path":333,"stem":334},"\u002Fen\u002Fxlsx\u002Fpatch","en\u002F06.xlsx\u002F20.patch",{"id":336,"title":165,"body":337,"description":1328,"extension":1329,"links":1330,"meta":1331,"navigation":437,"path":166,"seo":1332,"stem":167,"__hash__":1333},"docs_en\u002Fen\u002F04.docx\u002F18.export.md",{"type":338,"value":339,"toc":1320},"minimark",[340,357,362,365,505,509,512,702,790,794,800,852,856,861,994,998,1001,1110,1157,1161,1316],[341,342,343,344,348,349,352,353,356],"p",{},"The ",[345,346,347],"code",{},"generateDocument()"," function generates a .docx file from options and returns the result in the requested format. Use ",[345,350,351],{},"generateDocumentSync()"," for synchronous generation and ",[345,354,355],{},"generateDocumentStream()"," for streaming.",[358,359,361],"h2",{"id":360},"generatedocument","generateDocument",[341,363,364],{},"Returns a Buffer (default in Node.js). Best for file I\u002FO.",[366,367,372],"pre",{"className":368,"code":369,"language":370,"meta":371,"style":371},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","import { generateDocument } from \"@office-open\u002Fdocx\";\nimport { writeFileSync } from \"node:fs\";\n\n\u002F\u002F Async (non-blocking)\nconst buffer = await generateDocument({\u002F* options *\u002F});\nwriteFileSync(\"output.docx\", buffer);\n","ts","",[345,373,374,409,432,439,446,482],{"__ignoreMap":371},[375,376,379,383,387,391,394,397,400,403,406],"span",{"class":377,"line":378},"line",1,[375,380,382],{"class":381},"s7zQu","import",[375,384,386],{"class":385},"sMK4o"," {",[375,388,390],{"class":389},"sTEyZ"," generateDocument",[375,392,393],{"class":385}," }",[375,395,396],{"class":381}," from",[375,398,399],{"class":385}," \"",[375,401,98],{"class":402},"sfazB",[375,404,405],{"class":385},"\"",[375,407,408],{"class":385},";\n",[375,410,412,414,416,419,421,423,425,428,430],{"class":377,"line":411},2,[375,413,382],{"class":381},[375,415,386],{"class":385},[375,417,418],{"class":389}," writeFileSync",[375,420,393],{"class":385},[375,422,396],{"class":381},[375,424,399],{"class":385},[375,426,427],{"class":402},"node:fs",[375,429,405],{"class":385},[375,431,408],{"class":385},[375,433,435],{"class":377,"line":434},3,[375,436,438],{"emptyLinePlaceholder":437},true,"\n",[375,440,442],{"class":377,"line":441},4,[375,443,445],{"class":444},"sHwdD","\u002F\u002F Async (non-blocking)\n",[375,447,449,453,456,459,462,465,468,471,474,477,480],{"class":377,"line":448},5,[375,450,452],{"class":451},"spNyl","const",[375,454,455],{"class":389}," buffer ",[375,457,458],{"class":385},"=",[375,460,461],{"class":381}," await",[375,463,390],{"class":464},"s2Zo4",[375,466,467],{"class":389},"(",[375,469,470],{"class":385},"{",[375,472,473],{"class":444},"\u002F* options *\u002F",[375,475,476],{"class":385},"}",[375,478,479],{"class":389},")",[375,481,408],{"class":385},[375,483,485,488,490,492,495,497,500,503],{"class":377,"line":484},6,[375,486,487],{"class":464},"writeFileSync",[375,489,467],{"class":389},[375,491,405],{"class":385},[375,493,494],{"class":402},"output.docx",[375,496,405],{"class":385},[375,498,499],{"class":385},",",[375,501,502],{"class":389}," buffer)",[375,504,408],{"class":385},[358,506,508],{"id":507},"output-types","Output Types",[341,510,511],{},"Control the output format with the second argument:",[366,513,515],{"className":368,"code":514,"language":370,"meta":371,"style":371},"\u002F\u002F Uint8Array (cross-platform)\nconst bytes = await generateDocument(opts, { type: \"uint8array\" });\n\n\u002F\u002F Blob (browser)\nconst blob = await generateDocument(opts, { type: \"blob\" });\n\n\u002F\u002F Base64 string (API payloads)\nconst base64 = await generateDocument(opts, { type: \"base64\" });\n\n\u002F\u002F ArrayBuffer\nconst ab = await generateDocument(opts, { type: \"arraybuffer\" });\n",[345,516,517,522,562,566,571,607,611,617,654,659,665],{"__ignoreMap":371},[375,518,519],{"class":377,"line":378},[375,520,521],{"class":444},"\u002F\u002F Uint8Array (cross-platform)\n",[375,523,524,526,529,531,533,535,538,540,542,546,549,551,554,556,558,560],{"class":377,"line":411},[375,525,452],{"class":451},[375,527,528],{"class":389}," bytes ",[375,530,458],{"class":385},[375,532,461],{"class":381},[375,534,390],{"class":464},[375,536,537],{"class":389},"(opts",[375,539,499],{"class":385},[375,541,386],{"class":385},[375,543,545],{"class":544},"swJcz"," type",[375,547,548],{"class":385},":",[375,550,399],{"class":385},[375,552,553],{"class":402},"uint8array",[375,555,405],{"class":385},[375,557,393],{"class":385},[375,559,479],{"class":389},[375,561,408],{"class":385},[375,563,564],{"class":377,"line":434},[375,565,438],{"emptyLinePlaceholder":437},[375,567,568],{"class":377,"line":441},[375,569,570],{"class":444},"\u002F\u002F Blob (browser)\n",[375,572,573,575,578,580,582,584,586,588,590,592,594,596,599,601,603,605],{"class":377,"line":448},[375,574,452],{"class":451},[375,576,577],{"class":389}," blob ",[375,579,458],{"class":385},[375,581,461],{"class":381},[375,583,390],{"class":464},[375,585,537],{"class":389},[375,587,499],{"class":385},[375,589,386],{"class":385},[375,591,545],{"class":544},[375,593,548],{"class":385},[375,595,399],{"class":385},[375,597,598],{"class":402},"blob",[375,600,405],{"class":385},[375,602,393],{"class":385},[375,604,479],{"class":389},[375,606,408],{"class":385},[375,608,609],{"class":377,"line":484},[375,610,438],{"emptyLinePlaceholder":437},[375,612,614],{"class":377,"line":613},7,[375,615,616],{"class":444},"\u002F\u002F Base64 string (API payloads)\n",[375,618,620,622,625,627,629,631,633,635,637,639,641,643,646,648,650,652],{"class":377,"line":619},8,[375,621,452],{"class":451},[375,623,624],{"class":389}," base64 ",[375,626,458],{"class":385},[375,628,461],{"class":381},[375,630,390],{"class":464},[375,632,537],{"class":389},[375,634,499],{"class":385},[375,636,386],{"class":385},[375,638,545],{"class":544},[375,640,548],{"class":385},[375,642,399],{"class":385},[375,644,645],{"class":402},"base64",[375,647,405],{"class":385},[375,649,393],{"class":385},[375,651,479],{"class":389},[375,653,408],{"class":385},[375,655,657],{"class":377,"line":656},9,[375,658,438],{"emptyLinePlaceholder":437},[375,660,662],{"class":377,"line":661},10,[375,663,664],{"class":444},"\u002F\u002F ArrayBuffer\n",[375,666,668,670,673,675,677,679,681,683,685,687,689,691,694,696,698,700],{"class":377,"line":667},11,[375,669,452],{"class":451},[375,671,672],{"class":389}," ab ",[375,674,458],{"class":385},[375,676,461],{"class":381},[375,678,390],{"class":464},[375,680,537],{"class":389},[375,682,499],{"class":385},[375,684,386],{"class":385},[375,686,545],{"class":544},[375,688,548],{"class":385},[375,690,399],{"class":385},[375,692,693],{"class":402},"arraybuffer",[375,695,405],{"class":385},[375,697,393],{"class":385},[375,699,479],{"class":389},[375,701,408],{"class":385},[703,704,705,721],"table",{},[706,707,708],"thead",{},[709,710,711,715,718],"tr",{},[712,713,714],"th",{},"type",[712,716,717],{},"Returns",[712,719,720],{},"Use Case",[722,723,724,736,747,758,769,779],"tbody",{},[709,725,726,730,733],{},[727,728,729],"td",{},"\"nodebuffer\"",[727,731,732],{},"Buffer",[727,734,735],{},"Node.js file I\u002FO",[709,737,738,741,744],{},[727,739,740],{},"\"uint8array\"",[727,742,743],{},"Uint8Array",[727,745,746],{},"Cross-platform raw bytes",[709,748,749,752,755],{},[727,750,751],{},"\"blob\"",[727,753,754],{},"Blob",[727,756,757],{},"Browser downloads",[709,759,760,763,766],{},[727,761,762],{},"\"base64\"",[727,764,765],{},"string",[727,767,768],{},"Data URLs, API payloads",[709,770,771,774,776],{},[727,772,773],{},"\"string\"",[727,775,765],{},[727,777,778],{},"Debugging, inspection",[709,780,781,784,787],{},[727,782,783],{},"\"arraybuffer\"",[727,785,786],{},"ArrayBuffer",[727,788,789],{},"Memory handling",[358,791,793],{"id":792},"sync-variant","Sync Variant",[341,795,796,797,799],{},"Use ",[345,798,351],{}," for synchronous generation — blocks the main thread but avoids async overhead:",[366,801,803],{"className":368,"code":802,"language":370,"meta":371,"style":371},"import { generateDocumentSync } from \"@office-open\u002Fdocx\";\n\nconst buffer = generateDocumentSync({\u002F* options *\u002F});\n",[345,804,805,826,830],{"__ignoreMap":371},[375,806,807,809,811,814,816,818,820,822,824],{"class":377,"line":378},[375,808,382],{"class":381},[375,810,386],{"class":385},[375,812,813],{"class":389}," generateDocumentSync",[375,815,393],{"class":385},[375,817,396],{"class":381},[375,819,399],{"class":385},[375,821,98],{"class":402},[375,823,405],{"class":385},[375,825,408],{"class":385},[375,827,828],{"class":377,"line":411},[375,829,438],{"emptyLinePlaceholder":437},[375,831,832,834,836,838,840,842,844,846,848,850],{"class":377,"line":434},[375,833,452],{"class":451},[375,835,455],{"class":389},[375,837,458],{"class":385},[375,839,813],{"class":464},[375,841,467],{"class":389},[375,843,470],{"class":385},[375,845,473],{"class":444},[375,847,476],{"class":385},[375,849,479],{"class":389},[375,851,408],{"class":385},[358,853,855],{"id":854},"streaming","Streaming",[341,857,796,858,860],{},[345,859,355],{}," for large documents — returns a ReadableStream without buffering the entire file:",[366,862,864],{"className":368,"code":863,"language":370,"meta":371,"style":371},"import { generateDocumentStream } from \"@office-open\u002Fdocx\";\nimport { createWriteStream } from \"node:fs\";\nimport { Readable } from \"node:stream\";\n\nconst stream = generateDocumentStream({\u002F* options *\u002F});\nReadable.fromWeb(stream).pipe(createWriteStream(\"output.docx\"));\n",[345,865,866,887,908,930,934,957],{"__ignoreMap":371},[375,867,868,870,872,875,877,879,881,883,885],{"class":377,"line":378},[375,869,382],{"class":381},[375,871,386],{"class":385},[375,873,874],{"class":389}," generateDocumentStream",[375,876,393],{"class":385},[375,878,396],{"class":381},[375,880,399],{"class":385},[375,882,98],{"class":402},[375,884,405],{"class":385},[375,886,408],{"class":385},[375,888,889,891,893,896,898,900,902,904,906],{"class":377,"line":411},[375,890,382],{"class":381},[375,892,386],{"class":385},[375,894,895],{"class":389}," createWriteStream",[375,897,393],{"class":385},[375,899,396],{"class":381},[375,901,399],{"class":385},[375,903,427],{"class":402},[375,905,405],{"class":385},[375,907,408],{"class":385},[375,909,910,912,914,917,919,921,923,926,928],{"class":377,"line":434},[375,911,382],{"class":381},[375,913,386],{"class":385},[375,915,916],{"class":389}," Readable",[375,918,393],{"class":385},[375,920,396],{"class":381},[375,922,399],{"class":385},[375,924,925],{"class":402},"node:stream",[375,927,405],{"class":385},[375,929,408],{"class":385},[375,931,932],{"class":377,"line":441},[375,933,438],{"emptyLinePlaceholder":437},[375,935,936,938,941,943,945,947,949,951,953,955],{"class":377,"line":448},[375,937,452],{"class":451},[375,939,940],{"class":389}," stream ",[375,942,458],{"class":385},[375,944,874],{"class":464},[375,946,467],{"class":389},[375,948,470],{"class":385},[375,950,473],{"class":444},[375,952,476],{"class":385},[375,954,479],{"class":389},[375,956,408],{"class":385},[375,958,959,962,965,968,971,973,976,978,981,983,985,987,989,992],{"class":377,"line":484},[375,960,961],{"class":389},"Readable",[375,963,964],{"class":385},".",[375,966,967],{"class":464},"fromWeb",[375,969,970],{"class":389},"(stream)",[375,972,964],{"class":385},[375,974,975],{"class":464},"pipe",[375,977,467],{"class":389},[375,979,980],{"class":464},"createWriteStream",[375,982,467],{"class":389},[375,984,405],{"class":385},[375,986,494],{"class":402},[375,988,405],{"class":385},[375,990,991],{"class":389},"))",[375,993,408],{"class":385},[358,995,997],{"id":996},"compression-options","Compression Options",[341,999,1000],{},"All functions accept compression control. Default matches Microsoft Office: XML uses DEFLATE level 1 (SuperFast); media is split by type — already-compressed formats (PNG\u002FJPEG\u002FGIF) use STORE, the rest (EMF\u002FWMF\u002FBMP\u002FTIFF\u002F…) use DEFLATE level 6 \u002F Normal.",[366,1002,1004],{"className":368,"code":1003,"language":370,"meta":371,"style":371},"\u002F\u002F Default (MS Office)\nawait generateDocument(opts);\n\n\u002F\u002F Maximum XML compression\nawait generateDocument(opts, { compression: { xml: 9 } });\n\n\u002F\u002F No compression\nawait generateDocument(opts, { compression: { xml: 0 } });\n",[345,1005,1006,1011,1023,1027,1032,1068,1072,1077],{"__ignoreMap":371},[375,1007,1008],{"class":377,"line":378},[375,1009,1010],{"class":444},"\u002F\u002F Default (MS Office)\n",[375,1012,1013,1016,1018,1021],{"class":377,"line":411},[375,1014,1015],{"class":381},"await",[375,1017,390],{"class":464},[375,1019,1020],{"class":389},"(opts)",[375,1022,408],{"class":385},[375,1024,1025],{"class":377,"line":434},[375,1026,438],{"emptyLinePlaceholder":437},[375,1028,1029],{"class":377,"line":441},[375,1030,1031],{"class":444},"\u002F\u002F Maximum XML compression\n",[375,1033,1034,1036,1038,1040,1042,1044,1047,1049,1051,1054,1056,1060,1062,1064,1066],{"class":377,"line":448},[375,1035,1015],{"class":381},[375,1037,390],{"class":464},[375,1039,537],{"class":389},[375,1041,499],{"class":385},[375,1043,386],{"class":385},[375,1045,1046],{"class":544}," compression",[375,1048,548],{"class":385},[375,1050,386],{"class":385},[375,1052,1053],{"class":544}," xml",[375,1055,548],{"class":385},[375,1057,1059],{"class":1058},"sbssI"," 9",[375,1061,393],{"class":385},[375,1063,393],{"class":385},[375,1065,479],{"class":389},[375,1067,408],{"class":385},[375,1069,1070],{"class":377,"line":484},[375,1071,438],{"emptyLinePlaceholder":437},[375,1073,1074],{"class":377,"line":613},[375,1075,1076],{"class":444},"\u002F\u002F No compression\n",[375,1078,1079,1081,1083,1085,1087,1089,1091,1093,1095,1097,1099,1102,1104,1106,1108],{"class":377,"line":619},[375,1080,1015],{"class":381},[375,1082,390],{"class":464},[375,1084,537],{"class":389},[375,1086,499],{"class":385},[375,1088,386],{"class":385},[375,1090,1046],{"class":544},[375,1092,548],{"class":385},[375,1094,386],{"class":385},[375,1096,1053],{"class":544},[375,1098,548],{"class":385},[375,1100,1101],{"class":1058}," 0",[375,1103,393],{"class":385},[375,1105,393],{"class":385},[375,1107,479],{"class":389},[375,1109,408],{"class":385},[703,1111,1112,1128],{},[706,1113,1114],{},[709,1115,1116,1119,1122,1125],{},[712,1117,1118],{},"Option",[712,1120,1121],{},"Type",[712,1123,1124],{},"Default",[712,1126,1127],{},"Description",[722,1129,1130,1144],{},[709,1131,1132,1135,1138,1141],{},[727,1133,1134],{},"compression.xml",[727,1136,1137],{},"number",[727,1139,1140],{},"1",[727,1142,1143],{},"DEFLATE level 0–9",[709,1145,1146,1149,1151,1154],{},[727,1147,1148],{},"compression.media",[727,1150,1137],{},[727,1152,1153],{},"6",[727,1155,1156],{},"compressible media only; PNG\u002FJPEG\u002FGIF always STORE",[358,1158,1160],{"id":1159},"browser-download-example","Browser Download Example",[366,1162,1164],{"className":368,"code":1163,"language":370,"meta":371,"style":371},"const blob = await generateDocument(opts, { type: \"blob\" });\nconst url = URL.createObjectURL(blob);\nconst a = document.createElement(\"a\");\na.href = url;\na.download = \"output.docx\";\na.click();\nURL.revokeObjectURL(url);\n",[345,1165,1166,1200,1222,1252,1268,1287,1301],{"__ignoreMap":371},[375,1167,1168,1170,1172,1174,1176,1178,1180,1182,1184,1186,1188,1190,1192,1194,1196,1198],{"class":377,"line":378},[375,1169,452],{"class":451},[375,1171,577],{"class":389},[375,1173,458],{"class":385},[375,1175,461],{"class":381},[375,1177,390],{"class":464},[375,1179,537],{"class":389},[375,1181,499],{"class":385},[375,1183,386],{"class":385},[375,1185,545],{"class":544},[375,1187,548],{"class":385},[375,1189,399],{"class":385},[375,1191,598],{"class":402},[375,1193,405],{"class":385},[375,1195,393],{"class":385},[375,1197,479],{"class":389},[375,1199,408],{"class":385},[375,1201,1202,1204,1207,1209,1212,1214,1217,1220],{"class":377,"line":411},[375,1203,452],{"class":451},[375,1205,1206],{"class":389}," url ",[375,1208,458],{"class":385},[375,1210,1211],{"class":389}," URL",[375,1213,964],{"class":385},[375,1215,1216],{"class":464},"createObjectURL",[375,1218,1219],{"class":389},"(blob)",[375,1221,408],{"class":385},[375,1223,1224,1226,1229,1231,1234,1236,1239,1241,1243,1246,1248,1250],{"class":377,"line":434},[375,1225,452],{"class":451},[375,1227,1228],{"class":389}," a ",[375,1230,458],{"class":385},[375,1232,1233],{"class":389}," document",[375,1235,964],{"class":385},[375,1237,1238],{"class":464},"createElement",[375,1240,467],{"class":389},[375,1242,405],{"class":385},[375,1244,1245],{"class":402},"a",[375,1247,405],{"class":385},[375,1249,479],{"class":389},[375,1251,408],{"class":385},[375,1253,1254,1256,1258,1261,1263,1266],{"class":377,"line":441},[375,1255,1245],{"class":389},[375,1257,964],{"class":385},[375,1259,1260],{"class":389},"href ",[375,1262,458],{"class":385},[375,1264,1265],{"class":389}," url",[375,1267,408],{"class":385},[375,1269,1270,1272,1274,1277,1279,1281,1283,1285],{"class":377,"line":448},[375,1271,1245],{"class":389},[375,1273,964],{"class":385},[375,1275,1276],{"class":389},"download ",[375,1278,458],{"class":385},[375,1280,399],{"class":385},[375,1282,494],{"class":402},[375,1284,405],{"class":385},[375,1286,408],{"class":385},[375,1288,1289,1291,1293,1296,1299],{"class":377,"line":484},[375,1290,1245],{"class":389},[375,1292,964],{"class":385},[375,1294,1295],{"class":464},"click",[375,1297,1298],{"class":389},"()",[375,1300,408],{"class":385},[375,1302,1303,1306,1308,1311,1314],{"class":377,"line":613},[375,1304,1305],{"class":389},"URL",[375,1307,964],{"class":385},[375,1309,1310],{"class":464},"revokeObjectURL",[375,1312,1313],{"class":389},"(url)",[375,1315,408],{"class":385},[1317,1318,1319],"style",{},"html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":371,"searchDepth":411,"depth":411,"links":1321},[1322,1323,1324,1325,1326,1327],{"id":360,"depth":411,"text":361},{"id":507,"depth":411,"text":508},{"id":792,"depth":411,"text":793},{"id":854,"depth":411,"text":855},{"id":996,"depth":411,"text":997},{"id":1159,"depth":411,"text":1160},"Export documents to buffer, blob, base64, or stream","md",null,{},{"title":165,"description":1328},"imZQu0kqFqeVCkSgzEtwHJkLYkJ0DqLPwsSd4-m9Sss",[1335,1337],{"title":161,"path":162,"stem":163,"description":1336,"children":-1},"Set core, extended (app), and custom document properties",{"title":72,"path":169,"stem":170,"description":1338,"children":-1},"Parse, inspect, and round-trip .docx files",1787501494265]