Export
@flatfile/plugin-export-workbook
A plugin for exporting data in Flatfile to Workbooks.
When embedding Flatfile, this plugin should be deployed in a server-side listener. Learn more
Parameters
debug
boolean
The debug
parameter lets you toggle on/off helpful debugging messages for
development purposes.
Imported NPM Packages
@flatfile/api@1.5.14+
@flatfile/hooks@1.3.1+
@flatfile/listener@0.3.15+
remeda@1.14.0+
offers a set of utility functions for functional programming and data manipulation in JavaScript, providing a convenient way to work with arrays and objects.xlsx@0.20.0
allows for reading, writing, and manipulating Microsoft Excel files in JavaScript applications.
Usage
An action with the operation name of “downloadExcelWorkbook” must be configured on a Workbook (not a Sheet) in order to the plugin to be triggered.
install
npm i @flatfile/plugin-export-workbook
import
import { exportWorkbookPlugin } from "@flatfile/plugin-export-workbook";
workbook.config.json
// ... inside Workbook configuration
"actions": [
{
"operation": "downloadExcelWorkbook",
"mode": "foreground",
"label": "Download Excel Workbook",
"description": "Downloads Excel Workbook of Data",
"primary": true
}
]
// ...
listener.js
listener.use(exportWorkbookPlugin());