📈 Convert JSON to Excel XLSX with offloading the constructing the data using a worker thread v2020.10.122
Bugs are evident™ - MATRIX️
NodeJs LTS Version Requirement
Built on NodeJs
await keywords are required. Only the latest LTS variant is supported.
Install NodeJs: https://nodejs.org/en/download/package-manager/
Utility to convert json to an excel file, based on Node-Excel-Export using a worker thread by not blocking the NodeJs event loop using
async functions and options.
This is a totally fork of the json2xls, but the XLSX constructing can be CPU intensive so we are offloading the XLSX constructing using a worker thread.
Of course, when using a worker thread, the execution is about 20-25ms longer, then when we are in the event loop, so the worker thread is valid when we are generating a big dataset.
npm install p3x-json2xls-worker-thread
Use to save as file:
const json2xls =const fs = promisesconst json =foo: 'bar'qux: 'moo'poo: 123stux:const executAsync = asynctry//let nodeExcelOptions = undefined/*The following options are supported:- style: a styles xml file, see <>- fields: either an array or map containing field configuration:- array: a list of names of fields to be exported, in that order- object: a map of names of fields to be exported and the types of those fields. Supported types are 'number','string','bool'*/if ifSomeConditionIsTruenodeExcelOptions =fields: 'poo'const options =output: 'binary' /* default */ || 'base64'nodeExcel: nodeExcelOptionsconst xlsBinary = awaitawait fs;catche// handle errorconsole
Or use as express middleware. It adds a convenience
xls method to the response object to immediately output an excel as download.
const json2xls =const jsonArr =foo: 'bar'qux: 'moo'poo: 123stux:foo: 'bar'qux: 'moo'poo: 345stux:;app;app;
It is possible to block the event loop by using the
sync function eg.:
const json2xls =const json =foo: 'bar'qux: 'moo'poo: 123stux:const xlsBinary = json2xlsconsole
🙏 This is an open-source project. Star this repository, if you like it, or even donate to maintain the servers and the development. Thank you so much!
Possible, this server, rarely, is down, please, hang on for 15-30 minutes and the server will be back up.
Note about versioning: Versions are cut in Major.Minor.Patch schema. Major is always the current year. Minor is either 4 (January - June) or 10 (July - December). Patch is incremental by every build. If there is a breaking change, it should be noted in the readme.
P3X-JSON2XLS-WORKER-THREAD Build v2020.10.122