dolanmiu / docx

Easily generate and modify .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.

Home Page:https://docx.js.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NPM 8.5.0 Package / wrong types for patchDocument

chkch1 opened this issue · comments

Wrong version of from-docx.ts packaged for NPM 8.5.0 package?

I installed the docx 8.5.0 Package via NPM
"dependencies": {
"docx": "^8.5.0"
}
and wanted to run the Demos

  • 85-template-document.ts
  • 87-template-document.ts
  • 88-template-document.ts
  • 89-template-document.ts

but they are not working, because of the wrong type definition for the function "patchDocument".
image

When looking into build/patcher/from-docx.d.ts of the downloaded NPM package, it shows that the exported type for patchDocument has another parameter definition as used in the demos:
image

It's also explained on the pull requests page, that there had been breaking changes: #2497 but it seems that it did not get it into the NPM package.

On gitHub when looking into the source the type is defined that way that it is working with the demos.

same problem

Yes, this is not released as of yet

Will be part of the next major version as this is a breaking API change

Yes, this is not released as of yet

Will be part of the next major version as this is a breaking API change

@dolanmiu do you have an estimated date of when the next major version will be released? 😀