node.js html to xlsx transformation
Transformation only supports html table and several basic style properties. No images or charts are currently supported.
const util = require('util')
const fs = require('fs')
const conversionFactory = require('html-to-xlsx')
const puppeteer = require('puppeteer')
const chromeEval = require('chrome-page-eval')({ puppeteer })
const writeFileAsync = util.promisify(fs.writeFile)
const conversion = conversionFactory({
extract: async ({ html, ...restOptions }) => {
const tmpHtmlPath = path.join('/path/to/temp', 'input.html')
await writeFileAsync(tmpHtmlPath, html)
const result = await chromeEval({
...restOptions,
html: tmpHtmlPath,
scriptFn: conversionFactory.getScriptFn()
})
const tables = Array.isArray(result) ? result : [result]
return tables.map((table) => ({
name: table.name,
getRows: async (rowCb) => {
table.rows.forEach((row) => {
rowCb(row)
})
},
rowsCount: table.rows.length
}))
}
})
async function run () {
const stream = await conversion(`<table><tr><td>cell value</td></tr></table>`)
stream.pipe(fs.createWriteStream('/path/to/output.xlsx'))
}
run()background-color- cell background colorcolor- cell foreground colorborder-left-style- as well as positions will be transformed into excel cells borderstext-align- text horizontal align in the excel cellvertical-align- vertical align in the excel cellwidth- the excel column will get the highest width, it can be little bit inaccurate because of pixel to excel points conversionheight- the excel row will get the highest heightfont-size- font sizecolspan- numeric value that merges current column with columns to the rightrowspan- numeric value that merges current row with rows below.overflow- the excel cell will have text wrap enabled if this is set toscrollorauto.
const conversionFactory = require('html-to-xlsx')
const puppeteer = require('puppeteer')
const chromeEval = require('chrome-page-eval')({ puppeteer })
const conversion = conversionFactory({ /*[constructor options here]*/})extractfunction [required] - a function that receives some input (an html file path and a script) and should return some data after been evaluated the html passed. the input that the function receives is:{ html: <file path to a html file>, scriptFn: <string that contains a javascript function to evaluate in the html>, timeout: <time in ms to wait for the function to complete, the function should use this value to abort any execution when the time has passed>, /*options passed to `conversion` will be propagated to the input of this function too*/ }
tmpDirstring - the directory path that the module is going to use to save temporary files needed during the conversion. defaults torequire('os').tmpdir()timeoutnumber - time in ms to wait for the conversion to complete, when the timeout is reached the conversion is cancelled. defaults to10000
const fs = require('fs')
const conversionFactory = require('html-to-xlsx')
const puppeteer = require('puppeteer')
const chromeEval = require('chrome-page-eval')({ puppeteer })
const conversion = conversionFactory({
extract: async ({ html, ...restOptions }) => {
const tmpHtmlPath = path.join('/path/to/temp', 'input.html')
await writeFileAsync(tmpHtmlPath, html)
const result = await chromeEval({
...restOptions,
html: tmpHtmlPath,
scriptFn: conversionFactory.getScriptFn()
})
const tables = Array.isArray(result) ? result : [result]
return tables.map((table) => ({
name: table.name,
getRows: async (rowCb) => {
table.rows.forEach((row) => {
rowCb(row)
})
},
rowsCount: table.rows.length
}))
}
})
async function main () {
const stream = await conversion(/* html */, /* extract options */)
}
main()htmlstring - the html source that will be transformed to an xlsx, the html should contain a table elementextractOptionsobject - additional options to pass to the specifiedextractfunction
See license
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent