-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
31 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,38 @@ | ||
# xlsx-to-csv | ||
Fastest xlsx to csv converter based on Rust package [Calamine](https://github.com/tafia/calamine). It faster than [SheetJs][https://github.com/SheetJS/sheetjs] at least 3 times and eats 5 times smaller memory, | ||
# XLSX-to-CSV Converter written in Rust | ||
|
||
### Install | ||
`npm install xlsx-to-csv` | ||
The ultra-fast XLSX to CSV converter package, built leveraging the power of the Rust package - [Calamine](https://github.com/tafia/calamine). | ||
It outperforms [SheetJs](https://github.com/SheetJS/sheetjs), | ||
delivering **at least 3 times the speed** and **using only one-fifth of the memory**, making it ideal for processing large XLSX files. | ||
|
||
## Installation | ||
|
||
This package is available via NPM. To install, simply run the following command: | ||
|
||
``` | ||
npm install xlsx-to-csv | ||
``` | ||
|
||
## Usage | ||
|
||
The package accepts both .xlsx and .csv file types. Here's a quick example illustrating the usage: | ||
|
||
### Usage | ||
It accepts .xlsx and .csv file types. | ||
```typescript | ||
import fs from 'fs' | ||
import { convertFile } from 'xlsx-to-csv' | ||
|
||
// Convert your file | ||
const { filePath } = convertFile('./file.xlsx') | ||
|
||
// Output the path of the converted file | ||
console.log(filePath) | ||
|
||
// Read the converted file | ||
const csvData = fs.readFileSync(filePath).toString() | ||
|
||
// Display the data | ||
console.log(csvData) | ||
``` | ||
|
||
### Licence | ||
MIT | ||
## License | ||
|
||
This project is licensed under the MIT License, providing a high degree of freedom for both personal and commercial use. For more details, please refer to the LICENSE file in the repository. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters