[google-apps-script]File.getDescription() may return null. (Definitel…

…yTyped#49007) File description's initial value is null.
derenrich · Nov 24, 2020 · ed6569c · ed6569c
1 parent 7583bce
commit ed6569c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/types/google-apps-script/google-apps-script-tests.ts b/types/google-apps-script/google-apps-script-tests.ts
@@ -170,3 +170,14 @@ function onChange(e: GoogleAppsScript.Events.SheetsOnChange) {
     console.log('Formatting change detected');
   }
 }
+
+const createFileAndGetDescription = () => {
+  // Create file.
+  const file = DriveApp.createFile('New Text File', 'Hello, world!');
+  // Get description. Expect null.
+  Logger.log(file.getDescription());
+  // Set description.
+  file.setDescription('desc');
+  // Get description. Expect 'DESC'.
+  Logger.log(file.getDescription().toUpperCase());
+};
diff --git a/types/google-apps-script/google-apps-script.drive.d.ts b/types/google-apps-script/google-apps-script.drive.d.ts
@@ -160,7 +160,7 @@ declare namespace GoogleAppsScript {
       getAs(contentType: string): Base.Blob;
       getBlob(): Base.Blob;
       getDateCreated(): Base.Date;
-      getDescription(): string;
+      getDescription(): string | null;
       getDownloadUrl(): string;
       getEditors(): User[];
       getId(): string;