Overview

Key features

• Built for Google Apps Script — designed around the GAS runtime and its constraints, not adapted from a generic Node.js library.

• Broad utility coverage — spreadsheet, UI, network, and Admin SDK helpers alongside general-purpose string, array, and object utilities.

• TypeScript-first — every function ships with full type definitions for IDE autocompletion and compile-time safety.

• Tested — covered by a Vitest unit test suite.

• Linked reference documentation — every Google Apps Script type used in the API links directly to its official documentation.

• Consistent error handling — a dedicated hierarchy of exception classes replaces ad-hoc thrown errors.

How this documentation is organised

• Getting started — requirements, installation, and a first working script.

• Guides explain the ideas that run through the whole library: Validation conventions, Exception handling, and The Apps Script runtime.

• Modules describe each package and show it in use: lang, appsscript, net, and exception.

• Function reference lists every exported function, grouped the way the package itself is grouped: Google Apps Script module, Base utilities, Exceptions, path module, and Abstracts and interfaces. Every entry in those tables links to a page of its own — signature, parameters, return value, what it throws, and worked examples — and every exported function, class and type has one.

• Ecosystem — the boot.gs framework, which depends on this library, and the Agent Skills that teach an AI coding agent to use it.

Press / anywhere on this site to search it.

Where the library runs

The package splits cleanly in two, and the split decides where a function can be called:

The Apps Script runtime covers which functions fall on which side and what that means in practice.

Project layout