Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

spreadsheet: Reconfigure readSheet function #14

Merged
2 commits merged into from
Dec 7, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ export {
clearSheet,
updateSheet,
writeToSheet,
readGoogleSheetTab,
readSheet,
} from './spreadsheet';
51 changes: 40 additions & 11 deletions lib/spreadsheet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,44 @@ export function writeToSheet(
.setValues(writeArray);
}

/**
* Generic function for reading content of tab in Google Sheet.
* @param tabName Name of tab in Google Sheet.
* @returns Raw sheet content as nested array.
*/
export function readGoogleSheetTab(tabName: string): any[][] {
const tab = SpreadsheetApp.getActiveSpreadsheet().getSheetByName(tabName);
const rawData = tab
?.getRange(1, 1, tab.getMaxRows(), tab.getMaxColumns())
?.getValues();
return rawData || [];
export function readSheet(
sheetName: string,
{
range,
spreadSheet,
}: {
range?: string | [number, number, number, number];
spreadSheet?: GoogleAppsScript.Spreadsheet.Spreadsheet;
} = {},
): any[][] {
// If no spreadsheet provided, read the currently active spreadsheet:
if (!spreadSheet) {
spreadSheet = SpreadsheetApp.getActiveSpreadsheet();
}
const spreadSheetName = spreadSheet.getName();
const sheet = spreadSheet.getSheetByName(sheetName);

// Check for existence of sheet in spreadsheet:
if (!sheet) {
throw new Error(
`Sheet "${sheetName}" does not exist in spreadsheet "${spreadSheetName}"!`,
);
}

// If no range provided, default to the full data-containing range in the sheet:
if (!range) {
range = [1, 1, sheet.getLastRow(), sheet.getLastColumn()];
}

// Read data from sheet:
let rangeData: any[][];
if (typeof range === 'string') {
rangeData = sheet.getRange(range).getValues();
} else {
rangeData = sheet.getRange(...range).getValues();
}
console.log(
`Successfully read contents of sheet "${sheetName}" in spreadsheet "${spreadSheetName}".`,
);
return rangeData;
}