Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arslanameer/csv-exporter

CSV Exporter Utility is a simple, yet powerful package that allows you to easily convert a JSON array of data into a CSV file and download it in a user-friendly way. This utility is highly useful when you need to export data from a web application or API to a CSV file format, which can then be imported into other tools or processed further.
https://github.com/arslanameer/csv-exporter

arslanameer csv csv-converter csv-export data-conversion data-export file-download json-to-csv typescript typescript-utility utility

Last synced: 26 days ago
JSON representation

Host: GitHub
URL: https://github.com/arslanameer/csv-exporter
Owner: ArslanAmeer
License: mit
Created: 2023-04-21T21:08:37.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-07T20:44:23.000Z (2 months ago)
Last Synced: 2024-10-07T22:36:53.650Z (about 1 month ago)
Topics: arslanameer, csv, csv-converter, csv-export, data-conversion, data-export, file-download, json-to-csv, typescript, typescript-utility, utility
Language: TypeScript
Homepage: https://www.npmjs.com/package/csv-exporter-utility
Size: 84 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        


     

     



# CSV Exporter Utility

## Description

CSV Exporter Utility is a simple, yet powerful package that allows you to easily convert a JSON array of data into a CSV file and download it in a user-friendly way. This utility is highly useful when you need to export data from a web application or API to a CSV file format, which can then be imported into other tools or processed further.

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/arslanameer)

## Why use CSV Exporter Utility

- Easy to integrate into your existing projects

- Lightweight with no external dependencies

- Handles complex JSON data structures and nested objects

- Automatically generates CSV headers from JSON keys

- Allows omission of specific properties from the CSV export

- Supports nested properties omission with dot notation

- Cross-browser compatibility

- User-friendly file download experience

## How to use CSV Exporter Utility

1. Install the package using npm or yarn:

```bash

npm install csv-exporter-utility

```

2. Import the `downloadCSVFile` function from the package:

```typescript

import { downloadCSVFile } from "csv-exporter-utility";

```

3. Use the `downloadCSVFile` function in your application to convert and download JSON data as a CSV file. You can also pass an array of property names to omit certain fields from the CSV:

```typescript

const jsonData = [

  { id: 1, name: "John Doe", email: "[email protected]" },

  { id: 2, name: "Jane Doe", email: "[email protected]" },

];

// Omit the "email" field from the CSV

downloadCSVFile(jsonData, "users", ["email"]);

```

In the above example, the `email` field is omitted from the downloaded `users.csv` file.

### Additional support: Dot notation for nested properties

You can also omit nested properties using dot notation:

```typescript

// Omit the "user.age" field from the CSV

downloadCSVFile(jsonData, "users", ["user.age"]);

```

This will omit the `age` field inside the `user` object, allowing more control over complex JSON data structures.

## When to use CSV Exporter Utility

Use CSV Exporter Utility when you need to:

- Export data from your web application to a CSV file

- Provide users with a simple way to download data in a structured format

- Convert JSON data to CSV for further processing or analysis

- Omit specific properties (including nested ones) from the CSV output

- Integrate a lightweight CSV export solution without external dependencies

## Requirements and dependencies

CSV Exporter Utility is written in TypeScript and has no external dependencies. However, you need to ensure that your project uses TypeScript and has the necessary TypeScript configuration in place.

To use this package, your project should have the following:

- TypeScript version 4.x or higher

- A properly configured `tsconfig.json` file

- Node.js version 12.x or higher (if using the package in a Node.js environment)

For more information on setting up TypeScript in your project, please refer to the [official TypeScript documentation](https://www.typescriptlang.org/docs/).

## License

This project is licensed under the [MIT License](https://opensource.org/licenses/MIT). You are free to use, modify, and distribute this package, provided that you include the copyright notice and the license text. For more information, please see the [LICENSE](./LICENSE) file.

## Author

CSV Exporter Utility is developed and maintained by [Arslan Ameer](https://github.com/arslanameer). If you have any questions or need help, feel free to open an issue on the [GitHub repository](https://github.com/arslanameer/csv-exporter-utility).

## Contributing

Contributions to CSV Exporter Utility are welcome and greatly appreciated! If you would like to contribute, please follow these steps:

1. Fork the repository on GitHub.

2. Clone your fork and create a new branch for your changes.

3. Commit and push your changes to your fork.

4. Create a Pull Request on the original repository, describing your changes and referencing any related issues.

Please make sure to follow the existing coding style and add tests for any new features or bug fixes. Your contributions will be reviewed and, if approved, merged into the main repository.

Thank you for your interest in contributing to CSV Exporter Utility!

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/arslanameer)

# Changelog

### v1.1.0 - [September 7, 2024]

- **New Features**:

  - Added support to omit specific properties from CSV output using the `omitProperties` parameter.

  - Enhanced functionality to omit nested properties using dot notation (e.g., `"user.age"` will omit the `age` field from the `user` object).

  

- **Improvements**:

  - Refined CSV formatting logic to handle omitted properties more efficiently.

  - Improved error handling for scenarios with missing or invalid property paths in dot notation.

- **Bug Fixes**:

  - Resolved an issue where certain fields with nested structures were not properly converted to CSV.