Class DefaultSpreadsheetsClient

Example Usage:

import { SpreadsheetsClient } from "@de44/sheets-stack-core";

async function getRange(
       spreadsheetId: string,
       sheetName: string,
       range: string = "A1:Z1000"
): Promise<any[][]> {
       const cli = await SpreadsheetsClient.instance();
       const data = await db.read(spreadsheetId, sheetName, range);
       return data;
}

Hierarchy

  • DefaultSpreadsheetsClient

Implements

Constructors

constructor

Properties

cli logger _instance

Methods

appendRange getDetails getRange writeRange instance

Constructors

constructor

Properties

Protected cli

cli: Sheets

Protected logger

logger: SheetStackLogger

Static Private _instance

_instance: SpreadsheetsClient

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<{
        updatedCells: number;
        updatedColumns: number;
        updatedRange: string;
        updatedRows: number;
    }>

getDetails

getRange

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>

Static instance

  • Parameters

    • Optional keyFile: string
    • Optional scopes: string

    Returns Promise<SpreadsheetsClient>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc