html-docx-js-typescript
Version:
Convert HTML documents to docx format.
83 lines (64 loc) • 1.75 kB
Markdown
[![NPM version][npm-image]][npm-url]
> Rewrite [html-docx-js](https://www.npmjs.com/package/html-docx-js) with Typescript.
Convert HTML documents to docx format.
```
npm install html-docx-js-typescript --save-dev
```
Support node.js and browser enviroment, including vue/react/angular.
```js
import { asBlob } from 'html-docx-js-typescript'
// if you want to save the docx file, you need import 'file-saver'
import { saveAs } from 'file-saver'
const htmlString = `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
</head>
<body>
<h1>Welcome</h1>
</body>
</html>`
export default {
methods: {
saveDocx() {
asBlob(htmlString).then(data => {
saveAs(data, 'file.docx') // save as docx file
}) // asBlob() return Promise<Blob|Buffer>
},
},
}
```
And you can set options including margins and orientation.
```js
const data = await asBlob(htmlString, { orientation: 'landscape', margins: { top: 100 } })
```
If you use this package in a Typescript file and declare the options to an independent `Object` like:
``` js
import { asBlob } from 'html-docx-js-typescript'
const opt = {
margin: {
top: 100
},
orientation: 'landscape' // type error: because typescript automatically widen this type to 'string' but not 'Orient' - 'string literal type'
}
await asBlob(html, opt)
```
You can use `as const` to avoid type widening.
``` js
const opt = {
margin: {
top: 100
},
orientation: 'landscape' as const
}
```
MIT
[]: https://img.shields.io/npm/v/html-docx-js-typescript
[]: https://npmjs.com/package/html-docx-js-typescript