api/json Functions
Functions exported from src/api/json.ts
addJsonToSheet
function addJsonToSheet(existingSheet: WorkSheet | null, jsonData: any[], opts?: JSON2SheetOpts): WorkSheetParameters
| Name | Type | Description |
|---|---|---|
| existingSheet | `WorkSheet | null` |
| jsonData | any[] | Array of plain objects whose keys map to column headers |
| opts (optional) | JSON2SheetOpts | Optional settings (header, origin, dense, skipHeader, cellDates, UTC, dateNF, nullError) |
Returns
WorkSheet
The updated or newly created worksheet
jsonToSheet
function jsonToSheet(js: any[], opts?: JSON2SheetOpts): WorkSheetParameters
| Name | Type | Description |
|---|---|---|
| js | any[] | Array of plain objects whose keys map to column headers |
| opts (optional) | JSON2SheetOpts | Optional settings (same as addJsonToSheet) |
Returns
WorkSheet
A new worksheet populated with the given data
sheetToJson
function sheetToJson<T>(sheet: WorkSheet, opts?: Sheet2JSONOpts): T[]Parameters
| Name | Type | Description |
|---|---|---|
| sheet | WorkSheet | The worksheet to convert |
| opts (optional) | Sheet2JSONOpts | Optional conversion options (header, range, raw, rawNumbers, defval, blankrows, skipHidden, dateNF, UTC) |
Returns
T[]
An array of row objects (or arrays when header: 1)