easy-spreadsheet-write

• easy-spreadsheet-write
  • Overview
  • Features
  • Usage
    • Install package
    • Import and use
    • More details
  • Notes
    • Sheets type inference constraining / limitation
    • Fork notice and credit
  • License

Overview

easy-spreadsheet-write's main goal is to help you easily create spreadsheet files, with modern DX and type safety.

This package currently wraps on top of sheetjs to provide the functionalities.

Features

• 👌 TypeScript

Usage

Install package

# npm
npm install easy-spreadsheet-write

# bun
bun add easy-spreadsheet-write

# pnpm
pnpm install easy-spreadsheet-write

Import and use

Basic usage:

import { constructWorkbook, writeFile } from 'easy-spreadsheet-write'

writeFile(
  constructWorkbook([{
    content: [{ id: 1, regExp: /a/ }],
    columns: [
      ['ID', 'id'],
      ['RegExp string', e => e.regExp.toString()],
    ],
  }]),
  {
    fileName: `Some-Magic-RegExps`,
  },
)

A more detailed sample:

// ESM
import { constructWorkbook, ESWOptions, write, writeFile } from 'easy-spreadsheet-write'

const options = {
  fileName: 'MyODS', // extension will be added automatically if not provided
  cellPadding: 3, // In formats that support styling, this is the padding between the cell contents and the cell border.
  RTL: undefined, // Display the columns from right-to-left (defaults `false`)

  // ...sheetjsOptions, // Write options of sheetjs: https://docs.sheetjs.com/docs/api/write-options
  bookType: 'ods', // Defaults to 'xlsx'
} satisfies ESWOptions

const workbook = constructWorkbook(
  [
    {
      sheet: 'Sheet1',
      content: [
        { user: 'Luis', ghUsername: 'LuisEnMarroquin', likes: 99 },
      ],
      // The resolver function `row => ...` will automatically infer the type from `content`
      columns: [
        ['User name', 'user'], // Array syntax
        ['User name (lowercase)', row => row.user.toLowerCase()],
        { label: 'Likes count', value: 'likes' }, // Object syntax
        { label: 'GitHub URL', value: row => `https://github.com/${row.ghUsername}` },
      ],
    },
  ],
  options
)

// Similar to SheetJS's writeFile, this will write the file to disk / trigger a browser download
writeFile(data, options)

// There is a `browserDownloadFile` helper in case you need to defer the download:
const ssData = write(data, options)
// You'll have to construct a File object and provide the fileName with extension.
browserDownloadFile(new File([ssData], 'fileName.ext'))

More details

You can check the , or simply just hover around the functions and read the hint in your IDE.

Notes

Sheets type inference constraining / limitation

If you use multiple sheets, or you want to constraint the type of the sheet, follow this example:

// Set `<any>` for constructWorkbook to allow different types for the sheets
const workbook = constructWorkbook<any>(
  [
    // Use `defineJsonSheet` to define the sheets
    defineJsonSheet({
      sheet: 'Sheet1',
      content: [
        { what: 'wut' },
      ],
      columns: [
        ['What', 'what'],
      ],
    }),
    // Constrain the type of the sheet to `string` content
    defineJsonSheet<string>({
      sheet: 'Sheet2',
      content: [
        '{"encoded":"sample"}',
      ],
      columns: [
        ['Subject type', row => JSON.parse(row).type],
      ],
    }),
  ],
)

Fork notice and credit

easy-spreadsheet-write is a fork of json-as-xlsx, which I've been using for a while, but it is a bit outdated and the DX isn't as modern as it could be, so I clicked the fork button, heavily rewrite it, updating the toolchain to modern standards, improving the types, adding features, and a new package name which better describes it.

Shoutout to Luis for the original work, I'd love to get this merged to upstream, will open a PR but idk if it would be accepted.

Sample for migration from json-as-xlsx:

// `json-as-xlsx`
xlsx(
  [{
    sheet: 'Main',
    // @ts-expect-error signature error
    content: [{ id: 1, regExp: /a/ }],
    columns: [
      { label: 'ID', value: e => e.id! },
      { label: 'RegExp string', value: (e: any) => e.regExp.toString() },
    ],
  }],
  {
    fileName: `${t('file.seatsReport.name')}`,
    writeOptions: {
      compression: true,
    },
  },
)

// `easy-spreadsheet-write`
// Type casting hacks and ignores are no longer needed and you get correct type inference DX
// compression is also enabled by default to not catch you off-guard and bloat your (client)'s disk
writeFile(
  constructWorkbook([{
    content: [{ id: 1, regExp: /a/ }],
    columns: [
      { label: 'ID', value: e => e.id },
      { label: 'RegExp string', value: e => e.regExp.toString() },
    ],
  }]),
  {
    fileName: `${t('file.seatsReport.name')}`,
  },
)

License