Document execution result mime types (#14794)

* documentMimeTypes * Update src/api.proposed.kernelApi.d.ts Co-authored-by: Raymond Zhao <[email protected]> * Update src/api.proposed.kernelApi.d.ts Co-authored-by: Raymond Zhao <[email protected]> --------- Co-authored-by: Raymond Zhao <[email protected]>
microsoft · Nov 27, 2023 · 9b56f87 · 9b56f87
1 parent ce5f523
commit 9b56f87
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/src/api.proposed.kernelApi.d.ts b/src/api.proposed.kernelApi.d.ts
@@ -1,12 +1,19 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import type { CancellationToken, Event, Uri } from 'vscode';
+import type { CancellationToken, Uri } from 'vscode';
 
 declare module './api' {
     interface OutputItem {
         /**
-         * The mime type of the output
+         * The mime type of the output.
+         * Includes standard mime types (but not limited to) `text/plain`, `application/json`, `text/html`, etc.
+         *
+         * Special mime types are:
+         * - `application/x.notebook.stream.stdout`: The output is a stream of stdout. (same as `NotebookCellOutputItem.stdout('').mime`)
+         * - `application/x.notebook.stream.stderr`: The output is a stream of stderr. (same as `NotebookCellOutputItem.stderr('').mime`)
+         * - `application/vnd.code.notebook.error`: The output is a stream of stderr. (same as `NotebookCellOutputItem.error(...).mime`)
+         *
          */
         mime: string;
         /**