npm.io
1.1.1 • Published 5 years ago

@shujo/excel-export

Licence
ISC
Version
1.1.1
Deps
3
Size
4 kB
Vulns
0
Weekly
0

export-excel

A simple node module for exporting data set to excel file or excel buffer.

Install

npm i @shujo/export-excel --save 

Usage

const { generateExcelFile, generateExcelBuffer } = require('@shujo/export-excel')
//or
import { generateExcelFile, generateExcelBuffer } from '@shujo/export-excel'

Generate Excel File

import { generateExcelFile } from '@shujo/export-excel'

(async() => {
    try{
        const options = {
            filename: "sample-filename"
            sheet: "Sheet1",
            columns: [
                { header: "ID" , key: "id", width: 10 },
                { header: "Name" , key: "id", width: 10 }
            ],
            rows: [
                { id: 1, name: "Foo" },
                { id: 2, name: "Bar" },
            ]
        }
        await generateExcelFile(options);
    }catch(error){
        console.log(error);
    }
})

Generate Excel Buffer

import { generateExcelBuffer } from '@shujo/export-excel'

(async() => {
    try{
        const options = {
            sheet: "Sheet1",
            columns: [
                { key: "id", header: "ID", width: 10 },
                { key: "name", header: "Name", width: 10 }
            ],
            rows: [
                { id: 1, name: "Foo" },
                { id: 2, name: "Bar" },
            ]
        }
        let bufferData = await generateExcelBuffer(options);
        console.log(bufferData);
    }catch(error){
        console.log(error);
    }
})

Keywords