gas-types-detailed
Version:
Enhanced Google Apps Script Type Definitions with detailed documentation. Includes type definitions plus code snippets, return values, required authorization scopes, and other details not found in @types/google-apps-script.
33 lines (25 loc) • 1.96 kB
Markdown
# About
This package provides comprehensive TypeScript type definitions for Google Apps Script, enhanced with detailed documentation that goes beyond what's available in `@types/google-apps-script`.
While `@types/google-apps-script` provides basic type definitions, this package includes:
- **Detailed documentation** for each method and type
- **Code snippets** demonstrating how to use each method and type
- **Return value documentation** with detailed descriptions
- **Required authorization scopes** for each API method
- **Additional contextual information** not included in the standard type definitions
All documentation is generated using the scripts at https://github.com/enuchi/dts-google-apps-script.
This makes it easier to understand and use the Google Apps Script APIs directly from your IDE with full IntelliSense support.
# Installation
> `npm install --save-dev gas-types-detailed`
or
> `yarn add --dev gas-types-detailed`
# Summary
This package contains enhanced type definitions for google-apps-script (https://developers.google.com/apps-script/) with comprehensive documentation for each method and type.
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/google-apps-script and enhanced with additional documentation including code snippets, return values, required authorization scopes, and other details.
# Credits
These definitions were written by PopGoesTheWza (https://github.com/PopGoesTheWza), motemen (https://github.com/motemen/), and enuchi (https://github.com/enuchi). The type files included here were generated using the scripts at https://github.com/enuchi/dts-google-apps-script.
Reference:
https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/google-apps-script
https://github.com/enuchi/dts-google-apps-script
https://github.com/PopGoesTheWza/dts-google-apps-script
https://github.com/grant/google-apps-script-dts