{"id":15323771,"url":"https://github.com/StudyResearchProjects/node-xml-xlsx","last_synced_at":"2025-10-09T10:31:35.989Z","repository":{"id":104133753,"uuid":"199947923","full_name":"StudyResearchProjects/node-xml-xlsx","owner":"StudyResearchProjects","description":"📋 XLSX file generator for NodeJS","archived":true,"fork":false,"pushed_at":"2020-09-02T16:22:01.000Z","size":499,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-10T20:37:25.064Z","etag":null,"topics":["excel","node","node-xlsx","xlm","xlsx"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StudyResearchProjects.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-01T00:31:38.000Z","updated_at":"2025-05-27T00:09:47.000Z","dependencies_parsed_at":"2023-05-22T23:30:51.899Z","dependency_job_id":null,"html_url":"https://github.com/StudyResearchProjects/node-xml-xlsx","commit_stats":null,"previous_names":["leoborai/node-xml-xlsx","estebanborai/node-xml-xlsx","valhallaban/node-xml-xlsx","studyresearchprojects/node-xml-xlsx"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/StudyResearchProjects/node-xml-xlsx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StudyResearchProjects%2Fnode-xml-xlsx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StudyResearchProjects%2Fnode-xml-xlsx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StudyResearchProjects%2Fnode-xml-xlsx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StudyResearchProjects%2Fnode-xml-xlsx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StudyResearchProjects","download_url":"https://codeload.github.com/StudyResearchProjects/node-xml-xlsx/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StudyResearchProjects%2Fnode-xml-xlsx/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001275,"owners_count":26083040,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["excel","node","node-xlsx","xlm","xlsx"],"created_at":"2024-10-01T09:21:56.590Z","updated_at":"2025-10-09T10:31:35.983Z","avatar_url":"https://github.com/StudyResearchProjects.png","language":"TypeScript","readme":"# node-xml-xlsx\n📋 XLSX file generator for NodeJS\n\n## Installation\n```bash\nnpm i node-xml-xlsx\n```\n\n## Usage\n```javascript\nconst fs = require('fs');\nconst Xlsx = require('node-xml-xlsx');\n\nconst xlsx = new Xlsx();\nconst xlsxFileStream = xlsx.getStream();\n\n// Pipe xlsx file to a writeable stream\nxlsxFileStream.pipe(fs.createWriteStream('./new-workbook.xlsx'));\n\n// Append rows to the Xlsx file\nxlsx.addRow([\n\t'id',\n\t'first name',\n\t'last name',\n\t'age',\n\t'country',\n\t'date'\n]);\n\nxlsx.addRow([\n\t1,\n\t'John',\n\t'Appleseed',\n\t42,\n\t'EE.UU.',\n]);\n\n// Invoke build to finalize workbook writting\nxlsx.build();\n```\n\n## API\n- Xlsx\n\t- [Xlsx](https://github.com/estebanborai/node-xml-xlsx#xlsx)\n\t- [getStream](https://github.com/estebanborai/node-xml-xlsx#xlsxgetstream-archiver)\n\t- [addRow](https://github.com/estebanborai/node-xml-xlsx#xlsxaddrowvalues-xlsxvalue-void)\n\t- [build](https://github.com/estebanborai/node-xml-xlsx#xlsxbuild-promise)\n\n- Sheet\n\t- [Sheet](https://github.com/estebanborai/node-xml-xlsx#sheet)\n\t- [XLSXValue](https://github.com/estebanborai/node-xml-xlsx#sheet---xlsxvalue)\n\n### Xlsx\nCreates an instance of `Xlsx` object in order to write a new XLSX workbook.\n\n```javascript\nconst Xlsx = require('node-xml-xlsx');\n\nconst xlsx = new Xlsx();\n```\n\n### Xlsx.getStream(): Archiver\n`node-xml-xlsx` uses [Archiver](https://github.com/archiverjs/node-archiver) internally to create a **zip** file.\nAn **xlsx** file is basically a **zip** file with an specific structure based on **xml** files.\n\nReturns an [Archiver](https://github.com/archiverjs/node-archiver) instance that can be used to pipe the file\ncontents to a writeable stream while writting the xlsx file.\n\n```javascript\nconst fs = require('fs');\nconst Xlsx = require('node-xml-xlsx');\n\nconst xlsx = new Xlsx();\nconst xlsxFileStream = xlsx.getStream();\n\nxlsxFileStream.pipe(fs.createWriteStream('./workbook.xlsx'));\n```\n\n### Xlsx.addRow(values: XLSXValue[]): void\nAppends a new row to the xlsx file based on the array values.\nEach element of the array represents a column of the xlsx file.\n\n```javascript\n// Append rows to the Xlsx file\nxlsx.addRow([\n\t'id',\n\t'first name',\n\t'last name',\n\t'age',\n\t'country',\n\t'date'\n]);\n\nxlsx.addRow([\n\t1,\n\t'John',\n\t'Appleseed',\n\t42,\n\t'EE.UU.',\n]);\n```\n\n### Xlsx.build(): Promise\u003cvoid\u003e\nFinalizes writting process and write footters to the **zip** file.\n\n```javascript\n// Invoke build to finish workbook writting\nxlsx.build();\n```\n\n### Sheet\nA `Sheet` implements the capabilities of an **xlsx** file's sheet.\n\n\u003e Sheet's API is exported but its usage is internal, in the current version `node-xml-xlsx` is capable of creating single sheet workbooks only.\n\n### Sheet - XLSXValue\n`Sheet`'s type `XLSXValue` enumerates available types to be written in\na sheet.\n\nThe current types are:\n- String\n- Number\n\nSupport for more types could be added further based on Issues/Requests.\n\n## Contributions\nAny contribution is welcome, feel free to open either a pull request or issue (also both), and remember\nto write out your name, email and website in the *Authors* file.\n\n## License\nLicensed under the [MIT License](https://github.com/estebanborai/node-xml-xlsx/blob/master/LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStudyResearchProjects%2Fnode-xml-xlsx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FStudyResearchProjects%2Fnode-xml-xlsx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStudyResearchProjects%2Fnode-xml-xlsx/lists"}