@runnerty/executor-excel2csv

Smart Processes Management

Executor for Runnerty: Excel2CSV (xlsx to csv)

Installation:

Through NPM

npm i @runnerty/executor-excel2csv

You can also add modules to your project with runnerty

npx runnerty add @runnerty/executor-excel2csv

This command installs the module in your project, adds example configuration in your config.json and creates an example plan of use.

If you have installed runnerty globally you can include the module with this command:

runnerty add @runnerty/executor-excel2csv

Configuration:

Add in config.json:

{
  "id": "excel2csv_default",
  "type": "@runnerty-executor-excel2csv"
}

Plan:

Add in plan.json:

{
  "id": "excel2csv_default",
  "inputPath": "./test.xlsx",
  "outputPath": "./test.csv"
}

{
  "id": "excel2csv_default",
  "inputPath": "./test.xlsx",
  "outputPath": "./test.csv",
  "options": {
    "sheetName": "SHEET_ONE",
    "dateFormat": "DD/MM/YYYY",
    "formatterOptions": {
      "quote": "'",
      "delimiter": ";"
    }
  }
}

Options:

Parameter	Type	Description
dateFormat	String	Specify the date encoding format of dayjs.
dateUTC	Boolean	Specify whether ExcelJS uses dayjs.utc () to convert time zone for parsing dates.
encoding	String	Specify file encoding format. (Only applies to .writeFile.)
includeEmptyRows	Boolean	Specifies whether empty rows can be written.
sheetName	String	Specify worksheet name.
sheetId	Number	Specify worksheet ID.
formatterOptions	Object	See below.

Options/formatterOptions:

Parameter	Description
headers	Type: boolean/string[]. The headers will be auto detected from the first row or you can to provide headers array: ['h1name','h2name',...].
delimiter	Alternate delimiter. (Default: ',')
quote	Alternate quote. (Default: '"')
alwaysWriteHeaders	Set to true if you always want headers written, even if no rows are written. (Default: false)
rowDelimiter	Specify an alternate row delimiter (i.e \r\n). (Default: '\n')
quoteHeaders	If true then all headers will be quoted. (Default: quoteColumns value)
quoteColumns	If true then columns and headers will be quoted (unless quoteHeaders is specified). (Default: false).
escape	Alternate escaping value. (Default: '"')
includeEndRowDelimiter	Set to true to include a row delimiter at the end of the csv. (Default: false)
writeBOM	Set to true if you want the first character written to the stream to be a utf-8 BOM character. (Default: false)

More info here.