sheet_get_cell is neither documented nor typed #3209

New Issue

yf-yang · 2024-09-11T09:56:06Z

yf-yang commented

2024-09-11 09:56:06 +00:00

Is it a stable utility? I find it has been there since 0.15. Should we declare it in the typescript signature file?

sheetjs commented

2024-09-11 17:59:42 +00:00

It was added to support some operations that needed to add to cells that may or may not exist. The original goal was to support both sparse and dense worksheets.

The type signature for the current implementation would be something like:

    /** Get cell object for specified address, creating a new stub cell if necessary */
    sheet_get_cell(worksheet: WorkSheet, addr: CellAddress | string): CellObject;
    sheet_get_cell(worksheet: WorkSheet, R: number, C: number): CellObject;

Before updating the types, we should probably discuss what this function should do. Should the default behavior (creating cell stubs) be the default? Should there be an option to throw an error or return null if the cell does not exist?

PS: In general, we try hard not to remove any methods (and if we do remove something, it will involve a major or minor version bump)

It was added to support some operations that needed to add to cells that may or may not exist. The original goal was to support both sparse and dense worksheets. The type signature for the current implementation would be something like: ```ts /** Get cell object for specified address, creating a new stub cell if necessary */ sheet_get_cell(worksheet: WorkSheet, addr: CellAddress | string): CellObject; sheet_get_cell(worksheet: WorkSheet, R: number, C: number): CellObject; ``` Before updating the types, we should probably discuss what this function should do. Should the default behavior (creating cell stubs) be the default? Should there be an option to throw an error or return `null` if the cell does not exist? PS: In general, we try hard not to remove any methods (and if we do remove something, it will involve a major or minor version bump)

Sign in to join this conversation.