Class GoogleSheetsTable

Enables row-level interactions with a single sheet within a Google Sheets spreadsheet.

Export

GoogleSheetsTable

Constructors

constructor

Methods

countRows deleteRow findKeyRows findRow findRows insertRow updateRow

Constructors

constructor

Methods

countRows

  • countRows(): Promise<number>

  • Counts the total number of rows in the table.

    Returns Promise<number>

    The row count.

    Async

deleteRow

  • deleteRow(predicate): Promise<void>

  • Deletes an existing row in the table.

    Parameters

    • predicate: SearchPredicate

      The search function used to find the existing row to delete.

    Returns Promise<void>

    Async

    Throws

    Row is not found

findKeyRows

  • findKeyRows<T>(selector, keys): Promise<{
        rowsByKey: Record<T, Row>;
    }>

  • Finds all of the rows in the table that are identified by a set of keys.

    Type Parameters

    • T extends string | number | symbol

      The type of the key

    Parameters

    • selector: KeyColumnSelector<T>

      A function that selects the key column within each row.

    • keys: T[]

      An array of keys to search for.

    Returns Promise<{
        rowsByKey: Record<T, Row>;
    }>

    A dictionary of keys to matching rows.

    Async

findRow

findRows

  • findRows(): Promise<{
        rows: Row[];
    }>

  • Finds all rows within the table.

    Returns Promise<{
        rows: Row[];
    }>

    All of the rows.

    Async

  • findRows(sorting): Promise<{
        rows: Row[];
    }>

  • Finds all rows within the table and sorts them.

    Parameters

    • sorting: ColumnSortSpec[]

      The columns to sort by.

    Returns Promise<{
        rows: Row[];
    }>

    All of the rows, sorted.

    Async

  • findRows(predicate): Promise<{
        rows: Row[];
    }>

  • Finds zero or more rows within the table.

    Parameters

    Returns Promise<{
        rows: Row[];
    }>

    The found rows.

    Async

  • findRows(predicate, sorting): Promise<{
        rows: Row[];
    }>

  • Finds zero or more rows within the table and sorts them.

    Parameters

    • predicate: SearchPredicate

      The search function.

    • sorting: ColumnSortSpec[]

      The columns to sort by.

    Returns Promise<{
        rows: Row[];
    }>

    The found rows, sorted.

    Async

insertRow

  • insertRow(newRow): Promise<{
        insertedRow: Row;
    }>

  • Inserts a new row into the table.

    Parameters

    • newRow: RowData

      An object containing the row data to insert.

    Returns Promise<{
        insertedRow: Row;
    }>

    The inserted row.

    Async

    Throws

    Inserted row violates column constraints

updateRow

  • updateRow(predicate, rowUpdates): Promise<{
        updatedRow: Row;
    }>

  • Updates the data of an existing row in the table.

    Parameters

    • predicate: SearchPredicate

      The search function used to find the existing row to update.

    • rowUpdates: RowData

      An object containing the data to update.

    Returns Promise<{
        updatedRow: Row;
    }>

    The updated row.

    Async

    Throws

    Row is not found

    Throws

    Row change violates column constraints

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc