docxmarks

2.3.0 • Public • Published

docxmarks npm version js-standard-style Dependency Status

Replace text in native bookmarks in Open XML Document Files (.docx).

Formatting will follow the initial style inside the bookmark. That is to say, if you have content inside the bookmark the first character defines the styling. This is the same behavior supplied in Microsoft Word's libraries.

This library will also only handle text, nothing else.

I say all of that to say if you need more advanced formatting and content options then you should be using docxtemplater.

Install

npm i docxmarks --save

Usage

const docxmarks = require('docxmarks')
const fs = require('fs')
const docx = fs.readFileSync('path/to/document.docx')

const replacements = {
  first: 'Andrew',
  last: (val) => val || 'Carpenter',
  maybeNoBookmark: {append: true, setter: 'There is one now'}
}
docxmarks(docx, replacements).then((data) => {
  fs.writeFileSync('path/to/newDocument.docx', data)
})

API

Takes docx data, replaces bookmarks, returns Promise resolving with new docx data in the same encoding as provided in input.

** omitting replacements will resolve with an object describing bookmarks currently in the document*

docxmarks(*docxData, *replacements)

  • docxData [base64 | Buffer | ArrayBuffer | Uint8Array - required]
  • replacements [object - optional]
    • key - Name of bookmark to replace, is case sensitive
    • value [string | function | object] - Bookmark replacement value
      • string - Replace bookmark with string's value
      • function - Receives current text of bookmark, bookmark set with return value
      • object - {*setter, *append}
        • setter [string | function - required] same as string / function above
        • append [boolean - optional - false] if bookmark not found append to document

Upgrading

Version 2.0.0 is a complete re-write with 100% different API. Use new API if upgrading from an old version, as there is no transitional API.

License

MIT © Andrew Carpenter

Package Sidebar

Install

npm i docxmarks

Weekly Downloads

22

Version

2.3.0

License

MIT

Unpacked Size

9.13 kB

Total Files

4

Last publish

Collaborators

  • doesdev