[excel] Update reference docs with latest IntelliSense file (#394)

alison-mk · web-flow · commit fc5ec1978ce3 · 2025-09-08T16:40:43.000-07:00
* Pulling latest from CDN * Include proper beta tags * Make beta tags consistent * Clarify convertToPdf note * Run docs generation * Use GitHub Copilot to update preprocessor.ts and strip text after @beta tags in output files
diff --git a/docs/docs-ref-autogen/excelscript/excelscript.cellcontrol.yml b/docs/docs-ref-autogen/excelscript/excelscript.cellcontrol.yml
@@ -4,7 +4,16 @@ uid: ExcelScript!ExcelScript.CellControl:type
 package: ExcelScript!
 fullName: ExcelScript.CellControl
 summary: Represents an interactable control inside of a cell.
-remarks: "\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[ExcelScript.UnknownCellControl](/javascript/api/office-scripts/excelscript/excelscript.unknowncellcontrol), [ExcelScript.EmptyCellControl](/javascript/api/office-scripts/excelscript/excelscript.emptycellcontrol), [ExcelScript.MixedCellControl](/javascript/api/office-scripts/excelscript/excelscript.mixedcellcontrol), [ExcelScript.CheckboxCellControl](/javascript/api/office-scripts/excelscript/excelscript.checkboxcellcontrol)"
+remarks: >-
+
+
+  Learn more about the types in this type alias through the following links. 
+
+
+  [ExcelScript.UnknownCellControl](/javascript/api/office-scripts/excelscript/excelscript.unknowncellcontrol),
+  [ExcelScript.EmptyCellControl](/javascript/api/office-scripts/excelscript/excelscript.emptycellcontrol),
+  [ExcelScript.MixedCellControl](/javascript/api/office-scripts/excelscript/excelscript.mixedcellcontrol),
+  [ExcelScript.CheckboxCellControl](/javascript/api/office-scripts/excelscript/excelscript.checkboxcellcontrol)
 
 isPreview: false
 isDeprecated: false
diff --git a/docs/docs-ref-autogen/officescript.yml b/docs/docs-ref-autogen/officescript.yml
@@ -5,6 +5,7 @@ type: package
 summary: ''
 interfaces:
   - OfficeScript!OfficeScript.EmailAttachment:interface
+  - OfficeScript!OfficeScript.FileProperties:interface
   - OfficeScript!OfficeScript.MailProperties:interface
 enums:
   - OfficeScript!OfficeScript.EmailContentType:enum
@@ -14,10 +15,9 @@ functions:
     uid: OfficeScript!OfficeScript.convertToPdf:function(1)
     package: OfficeScript!
     summary: >-
-      Return the text encoding of the document as a PDF. If the document is
-      empty, then the following error is shown: "We didn't find anything to
-      print". Some actions made prior to using this API may not be captured in
-      the PDF in Excel on the web.
+      Converts the document to a PDF and returns the text encoding of it. Note:
+      Recent changes made to the workbook in Excel on the web, through Office
+      Scripts or the Excel UI, may not be captured in the PDF.
     remarks: ''
 
     isPreview: true
@@ -26,12 +26,27 @@ functions:
       content: 'export function convertToPdf(): string;'
       return:
         type: string
-        description: |-
+        description: >-
           The content of the workbook as a string, in PDF format.
 
+
+          **Throws**: `ConvertToPdfEmptyWorkbook` The error thrown if the
+          document is empty.
+
+
+          **Throws**: `ConvertToPdfProtectedWorkbook` The error thrown if
+          the document is protected.
+
+
+          **Throws**: `ExternalApiTimeout` The error thrown if the API
+          reaches the timeout limit of 30 seconds.
+
+
           #### Examples
 
+
           ```TypeScript
+
           /**
            * This script saves a worksheet as a PDF and emails that PDF to a recipient.
            */
@@ -48,8 +63,9 @@ functions:
                   attachments: [pdfFile]
               })    
           }
+
           ```
-  - name: "OfficeScript.downloadFile({\r\n        name,\r\n        content,\r\n    })"
+  - name: OfficeScript.downloadFile(fileProperties)
     uid: OfficeScript!OfficeScript.downloadFile:function(1)
     package: OfficeScript!
     summary: >-
@@ -60,22 +76,28 @@ functions:
     isPreview: true
     isDeprecated: false
     syntax:
-      content: |-
-        export function downloadFile({
-                name,
-                content,
-            }: {
-                name: string;
-                content: string;
-            }): void;
+      content: 'export function downloadFile(fileProperties: FileProperties): void;'
       parameters:
-        - id: "{\r\n        name,\r\n        content,\r\n    }"
-          description: ''
-          type: |-
-            {
-                    name: string;
-                    content: string;
-                }
+        - id: fileProperties
+          description: >-
+            The file to download.
+
+
+            **Throws**: `DownloadFileNameMissing` The error thrown if the
+            name is empty.
+
+
+            **Throws**: `DownloadFileContentMissing` The error thrown if the
+            content is empty.
+
+
+            **Throws**: `DownloadFileInvalidExtension` The error thrown if
+            the file name extension is not ".txt" or ".pdf".
+
+
+            **Throws**: `ExternalApiTimeout` The error thrown if the API
+            reaches the timeout limit of 30 seconds.
+          type: <xref uid="OfficeScript!OfficeScript.FileProperties:interface" />
       return:
         type: void
         description: ''
@@ -97,27 +119,7 @@ functions:
     package: OfficeScript!
     summary: >-
       Saves a copy of the current workbook in OneDrive, in the same directory as
-      the original file, with the specified file name. The API has a timeout
-      limit of 30 seconds. This limit is rarely exceeded. Note: Timeout doesn't
-      necessarily indicate that the API failed. The workbook copy may still be
-      created, but after the timeout limit this API does not return a success or
-      failure message.
-
-
-      **Throws**: `ExternalAPITimeout` The error thrown if the API reaches
-      the timeout limit of 30 seconds. Note that the copy may still be created.
-
-
-      **Throws**: `InvalidExtensionError` The error thrown if the file name
-      doesn't end with ".xlsx".
-
-
-      **Throws**: `SaveCopyAsFileMayAlreadyExistError` The error thrown if
-      the file name of the copy already exists.
-
-
-      **Throws**: `SaveCopyAsFileNotOnOneDriveError` The error thrown if the
-      document is not saved to OneDrive.
+      the original file, with the specified file name.
     remarks: ''
 
     isPreview: true
@@ -129,6 +131,27 @@ functions:
           description: >-
             The file name of the copied and saved file. The file name must end
             with ".xlsx".
+
+
+            **Throws**: `InvalidExtensionError` The error thrown if the file
+            name doesn't end with ".xlsx".
+
+
+            **Throws**: `SaveCopyAsFileMayAlreadyExistError` The error
+            thrown if the file name of the copy already exists.
+
+
+            **Throws**: `SaveCopyAsErrorInvalidCharacters` The error thrown
+            if the file name contains invalid characters.
+
+
+            **Throws**: `SaveCopyAsFileNotOnOneDriveError` The error thrown
+            if the document is not saved to OneDrive.
+
+
+            **Throws**: `ExternalApiTimeout` The error thrown if the API
+            reaches the timeout limit of 30 seconds. Note that the copy may
+            still be created.
           type: string
       return:
         type: void
@@ -138,8 +161,7 @@ functions:
     package: OfficeScript!
     summary: >-
       Send an email with an Office Script. Use `MailProperties` to specify the
-      content and recipients of the email. If the request body includes content,
-      this method returns 400 Bad request.
+      content and recipients of the email.
     remarks: ''
 
     isPreview: true
diff --git a/docs/docs-ref-autogen/officescript/officescript.fileproperties.yml b/docs/docs-ref-autogen/officescript/officescript.fileproperties.yml
@@ -0,0 +1,41 @@
+### YamlMime:TSType
+name: OfficeScript.FileProperties
+uid: OfficeScript!OfficeScript.FileProperties:interface
+package: OfficeScript!
+fullName: OfficeScript.FileProperties
+summary: The file to download.
+remarks: ''
+
+isPreview: true
+isDeprecated: false
+type: interface
+properties:
+  - name: content
+    uid: OfficeScript!OfficeScript.FileProperties#content:member
+    package: OfficeScript!
+    fullName: content
+    summary: The content of the file.
+    remarks: ''
+
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'content: string;'
+      return:
+        type: string
+  - name: name
+    uid: OfficeScript!OfficeScript.FileProperties#name:member
+    package: OfficeScript!
+    fullName: name
+    summary: >-
+      The name of the file once downloaded. The file extension determines the
+      type of the file. Supported extensions are ".txt" and ".pdf". Default is
+      ".txt".
+    remarks: ''
+
+    isPreview: true
+    isDeprecated: false
+    syntax:
+      content: 'name: string;'
+      return:
+        type: string
diff --git a/docs/docs-ref-autogen/toc.yml b/docs/docs-ref-autogen/toc.yml
@@ -653,5 +653,7 @@ items:
                 uid: OfficeScript!OfficeScript.EmailImportance:enum
           - name: EmailAttachment
             uid: OfficeScript!OfficeScript.EmailAttachment:interface
+          - name: FileProperties
+            uid: OfficeScript!OfficeScript.FileProperties:interface
           - name: MailProperties
             uid: OfficeScript!OfficeScript.MailProperties:interface
diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv
@@ -3432,6 +3432,9 @@ OfficeScript.EmailImportance,N/A,Enum,Unknown,false
 OfficeScript.EmailImportance,"high",EnumField,Poor,false
 OfficeScript.EmailImportance,"low",EnumField,Poor,false
 OfficeScript.EmailImportance,"normal",EnumField,Fine,false
+OfficeScript.FileProperties,N/A,Interface,Unknown,false
+OfficeScript.FileProperties,"content",Property,Poor,false
+OfficeScript.FileProperties,"name",Property,Good,false
 OfficeScript.MailProperties,N/A,Interface,Unknown,false
 OfficeScript.MailProperties,"attachments",Property,Great,false
 OfficeScript.MailProperties,"bcc",Property,Great,false
diff --git a/generate-docs/api-extractor-inputs-officescript/officescript.d.ts b/generate-docs/api-extractor-inputs-officescript/officescript.d.ts
@@ -1,49 +1,82 @@
 export declare namespace OfficeScript {
     /**
      * Saves a copy of the current workbook in OneDrive, in the same directory as the original file, with the specified file name.
-     * The API has a timeout limit of 30 seconds. This limit is rarely exceeded.
-     * Note: Timeout doesn't necessarily indicate that the API failed. The workbook copy may still be created, but after the timeout limit this API does not return a success or failure message.
-     
-     * **Throws**:  `ExternalApiTimeout` The error thrown if the API reaches the timeout limit of 30 seconds. Note that the copy may still be created.
+     * @beta
+     * @param filename - The file name of the copied and saved file. The file name must end with ".xlsx".
      
      * **Throws**:  `InvalidExtensionError` The error thrown if the file name doesn't end with ".xlsx".
      
      * **Throws**:  `SaveCopyAsFileMayAlreadyExistError` The error thrown if the file name of the copy already exists.
      
+     * **Throws**:  `SaveCopyAsErrorInvalidCharacters` The error thrown if the file name contains invalid characters.
+     
      * **Throws**:  `SaveCopyAsFileNotOnOneDriveError` The error thrown if the document is not saved to OneDrive.
-     * @param filename - The file name of the copied and saved file. The file name must end with ".xlsx".
-     * @beta
+     
+     * **Throws**:  `ExternalApiTimeout` The error thrown if the API reaches the timeout limit of 30 seconds. Note that the copy may still be created.
      */
     export function saveCopyAs(filename: string): void;
 
     /**
-     * Return the text encoding of the document as a PDF.
-     * If the document is empty, then the following error is shown: "We didn't find anything to print".
-     * Some actions made prior to using this API may not be captured in the PDF in Excel on the web.
-     * @returns The content of the workbook as a string, in PDF format.
+     * Converts the document to a PDF and returns the text encoding of it.
+     * Note: Recent changes made to the workbook in Excel on the web, through Office Scripts or the Excel UI, may not be captured in the PDF.
      * @beta
+     * @returns The content of the workbook as a string, in PDF format.
+     
+     * **Throws**:  `ConvertToPdfEmptyWorkbook` The error thrown if the document is empty.
+     
+     * **Throws**:  `ConvertToPdfProtectedWorkbook` The error thrown if the document is protected.
+     
+     * **Throws**:  `ExternalApiTimeout` The error thrown if the API reaches the timeout limit of 30 seconds.
      */
     export function convertToPdf(): string;
 
     /**
      * Downloads a specified file to the default download location specified by the local machine.
-     * @param name - The name of the file once downloaded. The file extension determines the type of the file. Supported extensions are ".txt" and ".pdf". Default is ".txt".
-     * @param content - The content of the file.
      * @beta
+     * @param fileProperties - The file to download.
+     
+     * **Throws**:  `DownloadFileNameMissing` The error thrown if the name is empty.
+     
+     * **Throws**:  `DownloadFileContentMissing` The error thrown if the content is empty.
+     
+     * **Throws**:  `DownloadFileInvalidExtension` The error thrown if the file name extension is not ".txt" or ".pdf".
+     
+     * **Throws**:  `ExternalApiTimeout` The error thrown if the API reaches the timeout limit of 30 seconds.
      */
-    export function downloadFile({
-        name,
-        content,
-    }: {
+    export function downloadFile(fileProperties: FileProperties): void;
+
+    /**
+     * The file to download.
+     * @beta
+     */
+    export interface FileProperties {
+        /**
+         * The name of the file once downloaded. The file extension determines the type of the file. Supported extensions are ".txt" and ".pdf". Default is ".txt".
+         * @beta
+         */
         name: string;
+
+        /**
+         * The content of the file.
+         * @beta
+         */
         content: string;
-    }): void;
+    }
 
     /**
      * Send an email with an Office Script. Use `MailProperties` to specify the content and recipients of the email.
-     * If the request body includes content, this method returns 400 Bad request.
-     * @param message - The properties that define the content and recipients of the email.
      * @beta
+     * @param message - The properties that define the content and recipients of the email.
+     
+     * **Throws**:  `SendMailErrorMaxCalls` The error thrown if the maximum number of API calls is exceeded. The limit is 100 API calls.
+     
+     * **Throws**:  `SendMailNoRecipient` The error thrown if no recipient is specified.
+     
+     * **Throws**:  `SendMailInvalidEmail` The error thrown if an invalid email address is provided.
+     
+     * **Throws**:  `SendMailExtensionNotSupported` The error thrown if the attachment name extension is not ".txt" or ".pdf".
+     
+     * **Throws**:  `ExternalApiTimeout` The error thrown if the API reaches the timeout limit of 30 seconds.
      */
     export function sendMail(mailProperties: MailProperties): void;
 
diff --git a/generate-docs/script-inputs/office-scripts-docs.d.ts b/generate-docs/script-inputs/office-scripts-docs.d.ts
diff --git a/generate-docs/scripts/preprocessor.ts b/generate-docs/scripts/preprocessor.ts
