sheet_to_row_object_array is not documented #424
Labels
No Label
DBF
Dates
Defined Names
Features
Formula
HTML
Images
Infrastructure
Integration
International
ODS
Operations
Performance
PivotTables
Pro
Protection
Read Bug
SSF
SYLK
Style
Write Bug
good first issue
No Milestone
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: sheetjs/sheetjs#424
Loading…
Reference in New Issue
Block a user
No description provided.
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Function needs proper documentation, including what options it takes and e.g. the behavior when a sheet contains multiple columns with the same name.
+1.
Only below utils are mentioned in the readme file.
sheet_to_json converts a workbook object to an array of JSON objects.
sheet_to_csv generates delimiter-separated-values output
sheet_to_formulae generates a list of the formulae (with value fallbacks)
sheet_to_row_object_array is a parser function of sheet_to_json which both of them given a 'sheet' plus 'options'( optional param) and returns an 'array of rows with w as value inside'
Looking at the history, originally there were separate functions to convert worksheets to different types of functions. As the use cases expanded, the complete function
sheet_to_json
took shape, but the original accessor was not removed. I am sure it will be removed in the future and the README will be updated to note that it is an alias.@sheetjsdev please add a note to README and close the issue
https://github.com/SheetJS/js-xlsx#json we included a section describing the sheet_to_* functions with some examples.
Awesome, thanks!
I had to specify the sheet I am interested in thus:
It is not clear in the docs. So is this the intended behaviour missing in the docs or I am missing something myself?
@gabeno there's one general line in the enclosing section:
https://github.com/SheetJS/js-xlsx#utility-functions
That line probably should be included in each of the subsections.
Aha! @SheetJSDev I guess it would be helpful to perhaps use in the examples to provide better context of the line: