mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
9f25bcc456
This PR updates Google Apps Script types. (2017-05-12 -> 2018-07-11) This is a generated type definition. CC: @erickoledadevrel --- - [x] Use a meaningful title for the pull request. Include the name of the package modified. - [x] Test the change in your own code. (Compile and run.) - [x] Add or edit tests to reflect the change. (Run with `npm test`.) - [x] Follow the advice from the [readme](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.md#make-a-pull-request). - [x] Avoid [common mistakes](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.md#common-mistakes). - [x] Run `npm run lint package-name` (or `tsc` if no `tslint.json` is present). ``` npm run lint google-apps-script definitely-typed@0.0.2 lint /Users/timmerman/Documents/github/DefinitelyTyped dtslint types "google-apps-script" # No result. ``` If changing an existing definition: - [x] Provide a URL to documentation or source code which provides context for the suggested changes: https://developers.google.com/apps-script/reference/ - [x] Increase the version number in the header if appropriate. - The version should be bumped by the publisher. - [x] If you are making substantial changes, consider adding a `tslint.json` containing `{ "extends": "dtslint/dt.json" }`.
60 lines
1.9 KiB
TypeScript
60 lines
1.9 KiB
TypeScript
// Type definitions for Google Apps Script 2018-07-11
|
|
// Project: https://developers.google.com/apps-script/
|
|
// Definitions by: motemen <https://github.com/motemen/>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference path="google-apps-script.types.d.ts" />
|
|
|
|
declare namespace GoogleAppsScript {
|
|
export module Content {
|
|
/**
|
|
* Service for returning text content from a script.
|
|
*
|
|
* You can serve up text in various forms. For example, publish this script as a web app.
|
|
*
|
|
* function doGet() {
|
|
* return ContentService.createTextOutput("Hello World");
|
|
* }
|
|
*/
|
|
export interface ContentService {
|
|
MimeType: typeof MimeType;
|
|
createTextOutput(): TextOutput;
|
|
createTextOutput(content: string): TextOutput;
|
|
}
|
|
|
|
/**
|
|
* An enum for mime types that can be served from a script.
|
|
*/
|
|
export enum MimeType { ATOM, CSV, ICAL, JAVASCRIPT, JSON, RSS, TEXT, VCARD, XML }
|
|
|
|
/**
|
|
* A TextOutput object that can be served from a script.
|
|
*
|
|
* Due to security considerations, scripts cannot directly return text content to a browser.
|
|
* Instead, the browser is redirected to googleusercontent.com, which will display it without any
|
|
* further sanitization or manipulation.
|
|
*
|
|
* You can return text content like this:
|
|
*
|
|
* function doGet() {
|
|
* return ContentService.createTextOutput("hello world!");
|
|
* }
|
|
*
|
|
* ContentService
|
|
*/
|
|
export interface TextOutput {
|
|
append(addedContent: string): TextOutput;
|
|
clear(): TextOutput;
|
|
downloadAsFile(filename: string): TextOutput;
|
|
getContent(): string;
|
|
getFileName(): string;
|
|
getMimeType(): MimeType;
|
|
setContent(content: string): TextOutput;
|
|
setMimeType(mimeType: MimeType): TextOutput;
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
declare var ContentService: GoogleAppsScript.Content.ContentService;
|