# export-to-csv-fix-source-map

> Easily create CSV data from json collection

Latest version **0.2.1** (published 2022-02-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install export-to-csv-fix-source-map
pnpm add export-to-csv-fix-source-map
yarn add export-to-csv-fix-source-map
bun add export-to-csv-fix-source-map
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2022-02-17 |
| First published | 2022-02-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 15.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | alexcaza |
| Maintainers | omerfarukaplak |
| Keywords | export-to-csv, export-to-excel, csv, excel, libreoffice, openoffice, angular2, typescript, react, ngx, angular4, angular5 |

## Links

- npm: https://www.npmjs.com/package/export-to-csv-fix-source-map
- Repository: https://github.com/alexcaza/export-to-csv
- Homepage: https://github.com/alexcaza/export-to-csv#readme
- Issues: https://github.com/alexcaza/export-to-csv/issues
- npm.io page: https://npm.io/package/export-to-csv-fix-source-map

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2022-02-17

## README

# export-to-csv | Export to CSV Mini Library
Based off of [this library](https://github.com/javiertelioz/angular2-csv) by Javier Telio

> Helper library to quickly and easily create a CSV file in browser or Node
> 

## Installation

```javascript
yarn add export-to-csv
// npm install --save export-to-csv
```

## Usage
```javascript

import { ExportToCsv } from 'export-to-csv';

var data = [
  {
    name: 'Test 1',
    age: 13,
    average: 8.2,
    approved: true,
    description: "using 'Content here, content here' "
  },
  {
    name: 'Test 2',
    age: 11,
    average: 8.2,
    approved: true,
    description: "using 'Content here, content here' "
  },
  {
    name: 'Test 4',
    age: 10,
    average: 8.2,
    approved: true,
    description: "using 'Content here, content here' "
  },
];

  const options = { 
    fieldSeparator: ',',
    quoteStrings: '"',
    decimalSeparator: '.',
    showLabels: true, 
    showTitle: true,
    title: 'My Awesome CSV',
    useTextFile: false,
    useBom: true,
    useKeysAsHeaders: true,
    // headers: ['Column 1', 'Column 2', etc...] <-- Won't work with useKeysAsHeaders present!
  };

const csvExporter = new ExportToCsv(options);

csvExporter.generateCsv(data);

```

## API


| Option        | Default           | Description  |
| :------------- |:-------------:| -----|
| **fieldSeparator**      | , | Defines the field separator character |
| **filename**      | 'generated' | Sets the name of the downloaded file. ".csv" will be appended to the value provided. |
| **quoteStrings**      | "      | If provided, will use this characters to "escape" fields, otherwise will use double quotes as deafult |
| **decimalSeparator** | .      | Defines the decimal separator character (default is .). If set to "locale", it uses the [language sensitive representation of the number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toLocaleString).|
| **showLabels** | false      | If true, the first row will be the `headers` option or object keys if `useKeysAsHeaders` is present|
| **showTitle** | false      | Includes the title as the first line in the generated file   |
| **title** | 'My Generated Report' | This string will be used as the report title |
| **useBom** | true      | If true, adds a BOM character at the start of the CSV to improve file compatibility |
| **useTextFile** | false      | If true, returns a `.txt` file instead of `.csv` |
| **useKeysAsHeaders** | false      | If true, this will use the keys of the first object in the collection as the column headers|
| **headers** | []      | Expects an array of strings, which if supplied, will be used as the column headers|


# Thanks!

|        Credits and Original Authors        |
| :------------- |
| **[javiertelioz](https://github.com/javiertelioz)** |
| **[sn123](https://github.com/sn123)** |
| **[arf1980](https://github.com/arf1980)** |

---
_Source: https://npm.io/package/export-to-csv-fix-source-map · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
