Class SheetsDB

constructor

• new SheetsDB(options: DBOptions): SheetsDB

  Initializes a new instance of the SheetsDB class and sets up the Google auth client. *

  Parameters

  • options: DBOptions

    The database configuration options.

  Returns SheetsDB

  Throws

  Will throw an error if any required option is missing.

config

ensureTableExists

• ensureTableExists(): Promise<boolean>

  Verifies if the target sheet exists and creates it if not. It also verifies and applies the schema headers to the first row if missing.

  Returns Promise<boolean>

  A promise that resolves to true once the table is ready.

  Throws

  Will throw an error if the API request fails.

getAll

• getAll(): Promise<Record<string, any>[]>

  Retrieves all rows from the sheet and maps them to an array of objects using the first row as the keys.

  Returns Promise<Record<string, any>[]>

  A promise that resolves to an array of key-value records.

  Throws

  Will throw an error if the API request fails.

init

• init(): Promise<SheetsDB>

  Bootstraps the database connection. Ensures that the target sheet and schema headers exist before proceeding.

  Returns Promise<SheetsDB>

  The initialized instance of SheetsDB.