json2sheet

json2sheet

json2sheet is a utility package to convert json objects to simple excel sheets in an easier and faster way. And, it is built on top of exceljs and you can check it if you want to create more complex excel sheets.

Table of Contents

• Installation
• Usage
  • File Buffer
  • Excel File
  • Function Values
  • Style
• Contributing

Installation

You can install the package via npm or yarn.

npm install json2sheet

or

yarn add json2sheet

Usage

There are two main functions you can use:

File Buffer

Create Excel file buffer from json object:

import { jsonToBuffer, Column } from "json2sheet";

async function createExcelBuffer() {
  const data: any[] = [
    {
      name: "John Doe",
      age: 24,
      user: {
        name: "johndoe",
      },
    },
    {
      name: "Doe John",
      age: 42,
      user: {
        name: "doejohn",
      },
    },
  ];

  const columns: Column[] = [
    {
      label: "User's name", // column name
      /*
       * value is a property name or a function which takes single object as parameter and returns desired value
       */
      value: "name",
      width: 40, // column width
      style: {
        // column style
        font: {
          italic: true,
        },
        alignment: {
          vertical: "middle",
          horizontal: "center",
        },
      },
    },
    {
      label: "User's age",
      value: "age",
      width: 10,
    },
    {
      label: "Username",
      value: "user.name", // supports inner objects
      width: 20,
    },
    {
      label: "Profile link",
      value: (person) => `https://example.com/${person.user.name}`,
      width: 20,
    },
  ];

  // jsonToBuffer is an async function and returns Promise<Buffer>
  return await jsonToBuffer("sheetname", columns, data);
}

jsonToBuffer is useful when you need to send Excel file to the user via API endpoint in Express or NestJS. You can do so like this:

const buffer = await createExcelBuffer();
const filename = "cool-file";

res.set({
  "Content-Type":
    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "Content-Disposition": `attachment; filename=${filename}.xlsx`,
});

res.send(buffer);

Excel File

Create Excel file itself:

import { jsonToFile, Column } from "json2sheet";

async function createExcelBuffer() {
  const columns: Column[] = [
    {
      label: "User's name", // column name
      value: "name", // property name
      width: 40, // column width
      style: {
        // creates italic text
        font: {
          italic: true,
        },
        // positions text in the middle of the cell
        alignment: {
          vertical: "middle",
          horizontal: "center",
        },
      },
    },
    {
      label: "User's age",
      value: "age",
      width: 10,
    },
    {
      label: "Username",
      value: "user.name", // supports inner objects
      width: 20,
    },
  ];

  const data: any[] = [
    {
      name: "John Doe",
      age: 24,
      user: {
        name: "johndoe",
      },
    },
    {
      name: "Doe John",
      age: 42,
      user: {
        name: "doejohn",
      },
    },
  ];

  // jsonToFile is an async void function and it creates xlsx file.
  return await jsonToFile("filename.xlsx", "sheetname", columns, data);
}

jsonToFile is useful when you want to create Excel files in your local disk or on your your server.

Function Values

Sometimes we need to modify the value from JSON a little bit as in the above example:

{
  label: "Profile link",
  value: (person) => `https://example.com/${person.user.name}`,
  width: 20,
}

Most of the time, it is a common need so package supports function values. With functions you can transform value according to your need without modifying JSON file or object.

However, function must take only one parameter which represents single object from your data array. If you have existing function you can also use that:

function generateLink(person) {
  return `https://example.com/${person.user.name}`
}

...

{
  label: "Profile link",
  value: generateLink,
  width: 20,
}

Style

If you want to give more style to your columns check these files! Currently package only supports font and alignment in column style!

Contributing

Contributions are welcome! Please create your PRs and send them for review!