Interface SpreadsheetsClient

This interface is meant to be used as a wrapper around the Google Sheets API.

const SHEET_ID: SpreadsheetId = "...";
const cli: SpreadsheetClient = await DefaultSpreadsheetsClient.instance();
const a1 = await cli.getRange(SHEET_ID, "sheet1!A1");

Hierarchy

  • SpreadsheetsClient

Implemented by

Methods

appendRange getDetails getRange writeRange

Methods

appendRange

  • Appends a range of cells to a spreadsheet. Writes data to the next available row of the sheet.

    NOTE: The data can be written OUTSIDE of the defined range.

    const spreadsheetId = "...";
    const range = "Sheet1!H1";
    // also support multiple rows
    const values = [[new Date().toISOString(), randomString(), randomString()]];
    let data = await sheets.appendRange(spreadsheetId, range, values);

    Parameters

    • sid: string

      The spreadsheet ID

    • range: string

      The range to append, e.g. "sheetName!A1:Z1000"

    • values: CellValues

      The raw values to append. Support single or multiple rows.

    Returns Promise<SheetAppendResult>

getDetails

getRange

  • Reads a range of cells from a spreadsheet.

    Parameters

    Returns Promise<CellValues>

    The raw values of the cells in the range

writeRange

  • Writes a range of cells to a spreadsheet.

    Parameters

    • sid: string

      The spreadsheet ID

    • range: string

      The range to write, e.g. "sheetName!A1:Z1000"

    • values: CellValues

      The raw values to write

    Returns Promise<SheetWriteResult>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc