Sheet

Represents a Google Spreadsheet. Resolves by name or ID.

import { Sheet } from "betterspread"

Constructor

new Sheet(sheetName: string, connection: Connection, folderId?: string)

Param	Type	Description
sheetName	string	Spreadsheet name or ID
connection	Connection	Authenticated connection
folderId	string	(optional) Restrict name search to this Drive folder

Methods

open()

open(): Promise<void>

Resolves the spreadsheet ID and initializes the API client. Must be called before other methods.

getTab()

getTab(tabName: string): Promise<Tab>

Gets a Tab by sheet name. Throws TabNotFoundError if not found.

tabs()

tabs(opts?: { excludeHidden?: boolean }): Promise<Tab[]>

Returns all tabs. Optionally exclude hidden sheets.

getClient()

getClient(): sheets_v4.Sheets

Returns the Sheets API client. Throws if open() not called.

getId()

getId(): string

Returns the resolved spreadsheet ID. Throws if open() not called.