smartprocure/csv-generator-client

[![npm version](https://badge.fury.io/js/csv-generator-client.svg)](https://badge.fury.io/js/csv-generator-client)
[![CircleCI](https://circleci.com/gh/smartprocure/csv-generator-client.svg?style=svg)](https://circleci.com/gh/smartprocure/csv-generator-client)
[![Coverage Status](https://coveralls.io/repos/github/smartprocure/csv-generator-client/badge.svg?branch=master)](https://coveralls.io/github/smartprocure/csv-generator-client?branch=master)
![dependencies](https://david-dm.org/smartprocure/csv-generator-client.svg)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/4de5e2d3d41d401d887d7db49d3a7e88)](https://www.codacy.com/app/geosp/csv-generator-client_2?utm_source=github.com&utm_medium=referral&utm_content=smartprocure/csv-generator-client&utm_campaign=Badge_Grade)
[![Maintainability](https://api.codeclimate.com/v1/badges/5f3b4045e0b8f003d424/maintainability)](https://codeclimate.com/github/smartprocure/csv-generator-client/maintainability)
[![Greenkeeper badge](https://badges.greenkeeper.io/smartprocure/csv-generator-client.svg)](https://greenkeeper.io/)
[![Build Status](https://saucelabs.com/buildstatus/csv-generator-client)](https://saucelabs.com/beta/builds/5f2b45811afb4465acb53754189485c4)
[![Sauce Test Status](https://saucelabs.com/browser-matrix/csv-generator-client.svg)](https://saucelabs.com/u/csv-generator-client)

# csv-generator-client
Library to generate downloadable csv files from client side data. 

# Installing
`npm install csv-generator-client`

This package requires `lodash/fp`, so make sure that's available in your app.

# Usage
```
import * as generator from 'csv-generator-client'

let settings = {separator: '|', addQuotes: true}
generator.download({settings, fileName, dataArray})

Or

var generator = require('csv-generator-client')
// In this case the default settings are used.
generator.download({fileName: fileName, dataArray: dataArray})

```
# API

### getLinkElement
`getLinkElement({settings: settings, fileName: fileName, dataArray: dataArray})`

Where settings can be:

```javascript
{
  separator: String,
  addQuotes: Boolean,
  autoDetectColumns: Boolean, // Requires an array of objects (e.g., [{name: 'Bob'}, {name: 'Joe'}])
  columnKeys: [String] // Each element is a key in the row object (e.g., 'name')
}
```

Default settings are:

```javascript
{
  separator: ',',
  addQuotes: false,
  autoDetectColumns: false,
}
```

`fileName` is required
`dataArray` is required to be an array of objects if `autoDetectColumns` is `true`, otherwise an array of arrays.

### download
`download({settings: settings, fileName: fileName, dataArray: dataArray})`

Where settings can be:

```javascript
{
  separator: String,
  addQuotes: Boolean,
  autoDetectColumns: Boolean, // Requires an array of objects (e.g., [{name: 'Bob'}, {name: 'Joe'}])
  columnKeys: [String] // Each element is a key in the row object (e.g., 'name')
}
```

Default settings are:

```javascript
{
  separator: ',',
  addQuotes: false,
  autoDetectColumns: false,
}
```

`fileName` is required
`dataArray` is required to be an array of objects if `autoDetectColumns` is `true`, otherwise an array of arrays.

# Credits
This implementation is based on [csv-repository-client](https://github.com/AlexLibs/client-side-csv-generator) by [AlexLibs](https://github.com/AlexLibs)