/file-exporter

A utility to export pdf and csv files from your web app.

Primary LanguageJavaScriptMIT LicenseMIT

File Exporter

A utility to export pdf and csv files from your web app. File Exporter allows you to download pdf and csv files from strings or base64 encodings on your client.

Installation

Using npm

$ npm install file-exporter --save

Using yarn

$ yarn add file-exporter

Usage

Require

const fileExporter = require('file-exporter');

ES6 import

import fileExporter from 'file-exporter';

Named imports

import { downloadCSV, downloadCSVFromBase64, downloadPDFromBase64, downloadCSVFromArray } from 'file-exporter';

Examples

// Exporting CSV from string
downloadCSV(data, fileName);

// Example format of data for downloadCSV function
Name,Address
John Smith,New York
John Doe,Mississippi

// Exporting CSV from array of objects
downloadCSVFromArray(data, fileName);

// Example format of data for downloadCSVFromArray function
[{name: 'John Smith', address: 'New York'}, {name: 'John Doe', address: 'Mississippi'}]

// Exporting CSV from base64
downloadCSVFromBase64(data, fileName);

// Exporting PDF from base64
downloadPDFFromBase64(data, fileName);

Contributing

Your inputs to the project are welcome. You can create an issue or send in a PR. Please see here.

License

MIT