@codingame/monaco-vscode-api 20.1.1 → 20.2.0

package/vscode/src/vs/workbench/services/search/common/searchExtTypes.d.ts

@@ -39,59 +39,212 @@ export declare class Range {
     }): Range;
 }
 export type ProviderResult<T> = T | undefined | null | Thenable<T | undefined | null>;
+/**
+ * A relative pattern is a helper to construct glob patterns that are matched
+ * relatively to a base path. The base path can either be an absolute file path
+ * or a [workspace folder](#WorkspaceFolder).
+ */
 export interface RelativePattern {
+    /**
+     * A base file path to which this pattern will be matched against relatively. The
+     * file path must be absolute, should not have any trailing path separators and
+     * not include any relative segments (`.` or `..`).
+     */
     baseUri: URI;
+    /**
+     * A file glob pattern like `*.{ts,js}` that will be matched on file paths
+     * relative to the base path.
+     *
+     * Example: Given a base of `/home/work/folder` and a file path of `/home/work/folder/index.js`,
+     * the file glob pattern will match on `index.js`.
+     */
     pattern: string;
 }
+/**
+ * A file glob pattern to match file paths against. This can either be a glob pattern string
+ * (like `** /*.{ts,js}` without space before / or `*.{ts,js}`) or a [relative pattern](#RelativePattern).
+ *
+ * Glob patterns can have the following syntax:
+ * * `*` to match zero or more characters in a path segment
+ * * `?` to match on one character in a path segment
+ * * `**` to match any number of path segments, including none
+ * * `{}` to group conditions (e.g. `** /*.{ts,js}` without space before / matches all TypeScript and JavaScript files)
+ * * `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+ * * `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+ *
+ * Note: a backslash (`\`) is not valid within a glob pattern. If you have an existing file
+ * path to match against, consider to use the [relative pattern](#RelativePattern) support
+ * that takes care of converting any backslash into slash. Otherwise, make sure to convert
+ * any backslash to slash when creating the glob pattern.
+ */
 export type GlobPattern = string | RelativePattern;
+/**
+ * The parameters of a query for text search.
+ */
 export interface TextSearchQuery2 {
+    /**
+     * The text pattern to search for.
+     */
     pattern: string;
+    /**
+     * Whether or not `pattern` should match multiple lines of text.
+     */
     isMultiline?: boolean;
+    /**
+     * Whether or not `pattern` should be interpreted as a regular expression.
+     */
     isRegExp?: boolean;
+    /**
+     * Whether or not the search should be case-sensitive.
+     */
     isCaseSensitive?: boolean;
+    /**
+     * Whether or not to search for whole word matches only.
+     */
     isWordMatch?: boolean;
 }
 export interface TextSearchProviderFolderOptions {
+    /**
+     * The root folder to search within.
+     */
     folder: URI;
+    /**
+     * Files that match an `includes` glob pattern should be included in the search.
+     */
     includes: string[];
+    /**
+     * Files that match an `excludes` glob pattern should be excluded from the search.
+     */
     excludes: GlobPattern[];
+    /**
+     * Whether symlinks should be followed while searching.
+     * For more info, see the setting description for `search.followSymlinks`.
+     */
     followSymlinks: boolean;
+    /**
+     * Which file locations we should look for ignore (.gitignore or .ignore) files to respect.
+     */
     useIgnoreFiles: {
+        /**
+         * Use ignore files at the current workspace root.
+         */
         local: boolean;
+        /**
+         * Use ignore files at the parent directory. If set, `local` in {@link TextSearchProviderFolderOptions.useIgnoreFiles} should also be `true`.
+         */
         parent: boolean;
+        /**
+         * Use global ignore files. If set, `local` in {@link TextSearchProviderFolderOptions.useIgnoreFiles} should also be `true`.
+         */
         global: boolean;
     };
+    /**
+     * Interpret files using this encoding.
+     * See the vscode setting `"files.encoding"`
+     */
     encoding: string;
 }
+/**
+ * Options that apply to text search.
+ */
 export interface TextSearchProviderOptions {
     folderOptions: TextSearchProviderFolderOptions[];
+    /**
+     * The maximum number of results to be returned.
+     */
     maxResults: number;
+    /**
+     * Options to specify the size of the result text preview.
+     */
     previewOptions: {
+        /**
+         * The maximum number of lines in the preview.
+         * Only search providers that support multiline search will ever return more than one line in the match.
+         * Defaults to 100.
+         */
         matchLines: number;
+        /**
+         * The maximum number of characters included per line.
+         * Defaults to 10000.
+         */
         charsPerLine: number;
     };
+    /**
+     * Exclude files larger than `maxFileSize` in bytes.
+     */
     maxFileSize: number | undefined;
+    /**
+     * Number of lines of context to include before and after each match.
+     */
     surroundingContext: number;
 }
+/**
+ * Information collected when text search is complete.
+ */
 export interface TextSearchComplete2 {
+    /**
+     * Whether the search hit the limit on the maximum number of search results.
+     * `maxResults` on [`TextSearchOptions`](#TextSearchOptions) specifies the max number of results.
+     * - If exactly that number of matches exist, this should be false.
+     * - If `maxResults` matches are returned and more exist, this should be true.
+     * - If search hits an internal limit which is less than `maxResults`, this should be true.
+     */
     limitHit?: boolean;
 }
 export interface FileSearchProviderFolderOptions {
+    /**
+     * The root folder to search within.
+     */
     folder: URI;
+    /**
+     * Files that match an `includes` glob pattern should be included in the search.
+     */
     includes: string[];
+    /**
+     * Files that match an `excludes` glob pattern should be excluded from the search.
+     */
     excludes: GlobPattern[];
+    /**
+     * Whether symlinks should be followed while searching.
+     * For more info, see the setting description for `search.followSymlinks`.
+     */
     followSymlinks: boolean;
+    /**
+     * Which file locations we should look for ignore (.gitignore or .ignore) files to respect.
+     */
     useIgnoreFiles: {
+        /**
+         * Use ignore files at the current workspace root.
+         */
         local: boolean;
+        /**
+         * Use ignore files at the parent directory. If set, {@link FileSearchProviderOptions.useIgnoreFiles.local} should also be `true`.
+         */
         parent: boolean;
+        /**
+         * Use global ignore files. If set, {@link FileSearchProviderOptions.useIgnoreFiles.local} should also be `true`.
+         */
         global: boolean;
     };
 }
+/**
+ * Options that apply to file search.
+ */
 export interface FileSearchProviderOptions {
     folderOptions: FileSearchProviderFolderOptions[];
+    /**
+     * An object with a lifespan that matches the session's lifespan. If the provider chooses to, this object can be used as the key for a cache,
+     * and searches with the same session object can search the same cache. When the token is cancelled, the session is complete and the cache can be cleared.
+     */
     session: unknown;
+    /**
+     * The maximum number of results to be returned.
+     */
     maxResults: number;
 }
+/**
+ * The main match information for a {@link TextSearchResult2}.
+ */
 export declare class TextSearchMatch2 {
     uri: URI;
     ranges: {
@@ -99,53 +252,200 @@ export declare class TextSearchMatch2 {
         previewRange: Range;
     }[];
     previewText: string;
+    /**
+     * @param uri The uri for the matching document.
+     * @param ranges The ranges associated with this match.
+     * @param previewText The text that is used to preview the match. The highlighted range in `previewText` is specified in `ranges`.
+     */
     constructor(uri: URI, ranges: {
         sourceRange: Range;
         previewRange: Range;
     }[], previewText: string);
 }
+/**
+ * The potential context information for a {@link TextSearchResult2}.
+ */
 export declare class TextSearchContext2 {
     uri: URI;
     text: string;
     lineNumber: number;
+    /**
+     * @param uri The uri for the matching document.
+     * @param text The line of context text.
+     * @param lineNumber The line number of this line of context.
+     */
     constructor(uri: URI, text: string, lineNumber: number);
 }
+/**
+/**
+ * Keyword suggestion for AI search.
+ */
 export declare class AISearchKeyword {
     keyword: string;
+    /**
+     * @param keyword The keyword associated with the search.
+     */
     constructor(keyword: string);
 }
+/**
+ * A result payload for a text search, pertaining to matches within a single file.
+ */
 export type TextSearchResult2 = TextSearchMatch2 | TextSearchContext2;
+/**
+ * A result payload for an AI search.
+ * This can be a {@link TextSearchMatch2 match} or a {@link AISearchKeyword keyword}.
+ * The result can be a match or a keyword.
+*/
 export type AISearchResult = TextSearchResult2 | AISearchKeyword;
+/**
+ * A FileSearchProvider provides search results for files in the given folder that match a query string. It can be invoked by quickaccess or other extensions.
+ *
+ * A FileSearchProvider is the more powerful of two ways to implement file search in VS Code. Use a FileSearchProvider if you wish to search within a folder for
+ * all files that match the user's query.
+ *
+ * The FileSearchProvider will be invoked on every keypress in quickaccess. When `workspace.findFiles` is called, it will be invoked with an empty query string,
+ * and in that case, every file in the folder should be returned.
+ */
 export interface FileSearchProvider2 {
+    /**
+     * Provide the set of files that match a certain file path pattern.
+     * @param query The parameters for this query.
+     * @param options A set of options to consider while searching files.
+     * @param progress A progress callback that must be invoked for all results.
+     * @param token A cancellation token.
+     */
     provideFileSearchResults(pattern: string, options: FileSearchProviderOptions, token: CancellationToken): ProviderResult<URI[]>;
 }
+/**
+ * A TextSearchProvider provides search results for text results inside files in the workspace.
+ */
 export interface TextSearchProvider2 {
+    /**
+     * Provide results that match the given text pattern.
+     * @param query The parameters for this query.
+     * @param options A set of options to consider while searching.
+     * @param progress A progress callback that must be invoked for all results.
+     * @param token A cancellation token.
+     */
     provideTextSearchResults(query: TextSearchQuery2, options: TextSearchProviderOptions, progress: IProgress<TextSearchResult2>, token: CancellationToken): ProviderResult<TextSearchComplete2>;
 }
+/**
+ * Information collected when text search is complete.
+ */
 export interface TextSearchComplete2 {
+    /**
+     * Whether the search hit the limit on the maximum number of search results.
+     * `maxResults` on {@linkcode TextSearchOptions} specifies the max number of results.
+     * - If exactly that number of matches exist, this should be false.
+     * - If `maxResults` matches are returned and more exist, this should be true.
+     * - If search hits an internal limit which is less than `maxResults`, this should be true.
+     */
     limitHit?: boolean;
+    /**
+     * Additional information regarding the state of the completed search.
+     *
+     * Messages with "Information" style support links in markdown syntax:
+     * - Click to [run a command](command:workbench.action.OpenQuickPick)
+     * - Click to [open a website](https://aka.ms)
+     *
+     * Commands may optionally return { triggerSearch: true } to signal to the editor that the original search should run be again.
+     */
     message?: TextSearchCompleteMessage2[];
 }
+/**
+ * A message regarding a completed search.
+ */
 export interface TextSearchCompleteMessage2 {
+    /**
+     * Markdown text of the message.
+     */
     text: string;
+    /**
+     * Whether the source of the message is trusted, command links are disabled for untrusted message sources.
+     * Messaged are untrusted by default.
+     */
     trusted?: boolean;
+    /**
+     * The message type, this affects how the message will be rendered.
+     */
     type: TextSearchCompleteMessageType;
 }
+/**
+ * A FileSearchProvider provides search results for files in the given folder that match a query string. It can be invoked by quickaccess or other extensions.
+ *
+ * A FileSearchProvider is the more powerful of two ways to implement file search in VS Code. Use a FileSearchProvider if you wish to search within a folder for
+ * all files that match the user's query.
+ *
+ * The FileSearchProvider will be invoked on every keypress in quickaccess. When `workspace.findFiles` is called, it will be invoked with an empty query string,
+ * and in that case, every file in the folder should be returned.
+ */
 export interface FileSearchProvider2 {
+    /**
+     * Provide the set of files that match a certain file path pattern.
+     * @param query The parameters for this query.
+     * @param options A set of options to consider while searching files.
+     * @param progress A progress callback that must be invoked for all results.
+     * @param token A cancellation token.
+     */
     provideFileSearchResults(pattern: string, options: FileSearchProviderOptions, token: CancellationToken): ProviderResult<URI[]>;
 }
+/**
+ * A TextSearchProvider provides search results for text results inside files in the workspace.
+ */
 export interface TextSearchProvider2 {
+    /**
+     * Provide results that match the given text pattern.
+     * @param query The parameters for this query.
+     * @param options A set of options to consider while searching.
+     * @param progress A progress callback that must be invoked for all results.
+     * @param token A cancellation token.
+     */
     provideTextSearchResults(query: TextSearchQuery2, options: TextSearchProviderOptions, progress: IProgress<TextSearchResult2>, token: CancellationToken): ProviderResult<TextSearchComplete2>;
 }
+/**
+ * Information collected when text search is complete.
+ */
 export interface TextSearchComplete2 {
+    /**
+     * Whether the search hit the limit on the maximum number of search results.
+     * `maxResults` on {@link TextSearchOptions} specifies the max number of results.
+     * - If exactly that number of matches exist, this should be false.
+     * - If `maxResults` matches are returned and more exist, this should be true.
+     * - If search hits an internal limit which is less than `maxResults`, this should be true.
+     */
     limitHit?: boolean;
+    /**
+     * Additional information regarding the state of the completed search.
+     *
+     * Messages with "Information" style support links in markdown syntax:
+     * - Click to [run a command](command:workbench.action.OpenQuickPick)
+     * - Click to [open a website](https://aka.ms)
+     *
+     * Commands may optionally return { triggerSearch: true } to signal to the editor that the original search should run be again.
+     */
     message?: TextSearchCompleteMessage2[];
 }
+/**
+ * A message regarding a completed search.
+ */
 export interface TextSearchCompleteMessage2 {
+    /**
+     * Markdown text of the message.
+     */
     text: string;
+    /**
+     * Whether the source of the message is trusted, command links are disabled for untrusted message sources.
+     * Messaged are untrusted by default.
+     */
     trusted?: boolean;
+    /**
+     * The message type, this affects how the message will be rendered.
+     */
     type: TextSearchCompleteMessageType;
 }
+/**
+ * Options for following search.exclude and files.exclude settings.
+ */
 export declare enum ExcludeSettingOptions {
     None = 1,
     FilesExclude = 2,
@@ -155,12 +455,39 @@ export declare enum TextSearchCompleteMessageType {
     Information = 1,
     Warning = 2
 }
+/**
+ * A message regarding a completed search.
+ */
 export interface TextSearchCompleteMessage {
+    /**
+     * Markdown text of the message.
+     */
     text: string;
+    /**
+     * Whether the source of the message is trusted, command links are disabled for untrusted message sources.
+     */
     trusted?: boolean;
+    /**
+     * The message type, this affects how the message will be rendered.
+     */
     type: TextSearchCompleteMessageType;
 }
+/**
+ * An AITextSearchProvider provides additional AI text search results in the workspace.
+ */
 export interface AITextSearchProvider {
+    /**
+     * The name of the AI searcher. Will be displayed as `{name} Results` in the Search View.
+     */
     readonly name?: string;
+    /**
+     * WARNING: VERY EXPERIMENTAL.
+     *
+     * Provide results that match the given text pattern.
+     * @param query The parameter for this query.
+     * @param options A set of options to consider while searching.
+     * @param progress A progress callback that must be invoked for all results.
+     * @param token A cancellation token.
+     */
     provideAITextSearchResults(query: string, options: TextSearchProviderOptions, progress: IProgress<TextSearchResult2>, token: CancellationToken): ProviderResult<TextSearchComplete2>;
 }

package/vscode/src/vs/workbench/services/search/common/textSearchManager.d.ts

@@ -42,6 +42,12 @@ export declare class TextSearchResultsCollector {
     flush(): void;
     private sendItems;
 }
+/**
+ * Collects items that have a size - before the cumulative size of collected items reaches START_BATCH_AFTER_COUNT, the callback is called for every
+ * set of items collected.
+ * But after that point, the callback is called with batches of maxBatchSize.
+ * If the batch isn't filled within some time, the callback is also called.
+ */
 export declare class BatchedCollector<T> {
     private maxBatchSize;
     private cb;

package/vscode/src/vs/workbench/services/statusbar/browser/statusbar.d.ts

@@ -9,16 +9,46 @@ export declare enum StatusbarAlignment {
     RIGHT = 1
 }
 export interface IStatusbarEntryLocation {
+    /**
+     * The identifier and priority of another status bar
+     * entry to position relative to. If the referenced
+     * entry does not exist, the priority will be used.
+     */
     location: {
         id: string;
         priority: number;
     };
+    /**
+     * The alignment of the status bar entry relative
+     * to the referenced entry.
+     */
     alignment: StatusbarAlignment;
+    /**
+     * Whether to move the entry close to the location
+     * so that it appears as if both this entry and
+     * the location belong to each other.
+     */
     compact?: boolean;
 }
 export declare function isStatusbarEntryLocation(thing: unknown): thing is IStatusbarEntryLocation;
 export interface IStatusbarEntryPriority {
+    /**
+     * The main priority of the entry that
+     * defines the order of appearance:
+     * either a number or a reference to
+     * another status bar entry to position
+     * relative to.
+     *
+     * May not be unique across all entries.
+     */
     readonly primary: number | IStatusbarEntryLocation;
+    /**
+     * The secondary priority of the entry
+     * is used in case the main priority
+     * matches another one's priority.
+     *
+     * Should be unique across all entries.
+     */
     readonly secondary: number;
 }
 export declare function isStatusbarEntryPriority(thing: unknown): thing is IStatusbarEntryPriority;
@@ -37,22 +67,83 @@ export interface ITooltipWithCommands {
     readonly commands: Command[];
 }
 export declare function isTooltipWithCommands(thing: unknown): thing is ITooltipWithCommands;
+/**
+ * A declarative way of describing a status bar entry
+ */
 export interface IStatusbarEntry {
+    /**
+     * The (short) name to show for the entry like 'Language Indicator',
+     * 'Git Status' etc.
+     */
     readonly name: string;
+    /**
+     * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
+     *
+     * `My text $(icon name) contains icons like $(icon name) this one.`
+     */
     readonly text: string;
+    /**
+     * Text to be read out by the screen reader.
+     */
     readonly ariaLabel: string;
+    /**
+     * Role of the status bar entry which defines how a screen reader interacts with it.
+     * Default is 'button'.
+     */
     readonly role?: string;
+    /**
+     * An optional tooltip text to show when you hover over the entry.
+     *
+     * Use `ITooltipWithCommands` to show a tooltip with commands in hover footer area.
+     */
     readonly tooltip?: TooltipContent | ITooltipWithCommands;
+    /**
+     * An optional color to use for the entry.
+     *
+     * @deprecated Use `kind` instead to support themable hover styles.
+     */
     readonly color?: string | ThemeColor;
+    /**
+     * An optional background color to use for the entry.
+     *
+     * @deprecated Use `kind` instead to support themable hover styles.
+     */
     readonly backgroundColor?: string | ThemeColor;
+    /**
+     * An optional command to execute on click.
+     *
+     * Can use the special `ShowTooltipCommand` to
+     * show the tooltip on click if provided.
+     */
     readonly command?: string | Command | typeof ShowTooltipCommand;
+    /**
+     * Whether to show a beak above the status bar entry.
+     */
     readonly showBeak?: boolean;
+    /**
+     * Will enable a spinning icon in front of the text to indicate progress. When `true` is
+     * specified, `loading` will be used.
+     */
     readonly showProgress?: boolean | "loading" | "syncing";
+    /**
+     * The kind of status bar entry. This applies different colors to the entry.
+     */
     readonly kind?: StatusbarEntryKind;
+    /**
+     * Enables the status bar entry to appear in all opened windows. Automatically will add
+     * the entry to new auxiliary windows opening.
+     */
     readonly showInAllWindows?: boolean;
+    /**
+     * If provided, signals what extension is providing the status bar entry. This allows for
+     * more actions to manage the extension from the status bar entry.
+     */
     readonly extensionId?: string;
     readonly content?: HTMLElement;
 }
 export interface IStatusbarEntryAccessor extends IDisposable {
+    /**
+     * Allows to update an existing status bar entry.
+     */
     update(properties: IStatusbarEntry): void;
 }

package/vscode/src/vs/workbench/services/statusbar/browser/statusbar.service.d.ts

@@ -4,7 +4,17 @@ import { IStatusbarEntryContainer, IAuxiliaryStatusbarPart } from "@codingame/mo
 export declare const IStatusbarService: import("../../../../platform/instantiation/common/instantiation.js").ServiceIdentifier<IStatusbarService>;
 export interface IStatusbarService extends IStatusbarEntryContainer {
     readonly _serviceBrand: undefined;
+    /**
+    * Get the status bar part that is rooted in the provided container.
+    */
     getPart(container: HTMLElement): IStatusbarEntryContainer;
+    /**
+    * Creates a new auxililary status bar part in the provided container.
+    */
     createAuxiliaryStatusbarPart(container: HTMLElement, instantiationService: IInstantiationService): IAuxiliaryStatusbarPart;
+    /**
+    * Create a scoped status bar service that only operates on the provided
+    * status entry container.
+    */
     createScoped(statusbarEntryContainer: IStatusbarEntryContainer, disposables: DisposableStore): IStatusbarService;
 }

package/vscode/src/vs/workbench/services/terminal/common/embedderTerminalService.service.d.ts

@@ -2,6 +2,9 @@ import { Event } from "../../../../base/common/event.js";
 import { IShellLaunchConfig } from "../../../../platform/terminal/common/terminal.js";
 import { IEmbedderTerminalOptions } from "@codingame/monaco-vscode-terminal-service-override/vscode/vs/workbench/services/terminal/common/embedderTerminalService";
 export declare const IEmbedderTerminalService: import("../../../../platform/instantiation/common/instantiation.js").ServiceIdentifier<IEmbedderTerminalService>;
+/**
+* Manages terminals that the embedder can create before the terminal contrib is available.
+*/
 export interface IEmbedderTerminalService {
     readonly _serviceBrand: undefined;
     readonly onDidCreateTerminal: Event<IShellLaunchConfig>;

package/vscode/src/vs/workbench/services/textfile/common/encoding.d.ts

@@ -21,6 +21,10 @@ export interface IDecodeStreamResult {
     detected: IDetectedEncodingResult;
 }
 export declare enum DecodeStreamErrorKind {
+    /**
+     * Error indicating that the stream is binary even
+     * though `acceptTextOnly` was specified.
+     */
     STREAM_IS_BINARY = 1
 }
 export declare class DecodeStreamError extends Error {
@@ -38,6 +42,11 @@ export declare function toEncodeReadable(readable: Readable<string>, encoding: s
 export declare function encodingExists(encoding: string): Promise<boolean>;
 export declare function toNodeEncoding(enc: string | null): string;
 export declare function detectEncodingByBOMFromBuffer(buffer: VSBuffer | null, bytesRead: number): typeof UTF8_with_bom | typeof UTF16le | typeof UTF16be | null;
+/**
+ * The encodings that are allowed in a settings file don't match the canonical encoding labels specified by WHATWG.
+ * See https://encoding.spec.whatwg.org/#names-and-labels
+ * Iconv-lite strips all non-alphanumeric characters, but ripgrep doesn't. For backcompat, allow these labels.
+ */
 export declare function toCanonicalName(enc: string): string;
 export interface IDetectedEncodingResult {
     encoding: string | null;

package/vscode/src/vs/workbench/services/textfile/common/textEditorService.service.d.ts

@@ -3,8 +3,25 @@ import { EditorInput } from "../../../common/editor/editorInput.js";
 export declare const ITextEditorService: import("../../../../platform/instantiation/common/instantiation.js").ServiceIdentifier<ITextEditorService>;
 export interface ITextEditorService {
     readonly _serviceBrand: undefined;
+    /**
+    * @deprecated this method should not be used, rather consider using
+    * `IEditorResolverService` instead with `DEFAULT_EDITOR_ASSOCIATION.id`.
+    */
     createTextEditor(input: IUntypedEditorInput): EditorInput;
+    /**
+    * @deprecated this method should not be used, rather consider using
+    * `IEditorResolverService` instead with `DEFAULT_EDITOR_ASSOCIATION.id`.
+    */
     createTextEditor(input: IUntypedFileEditorInput): IFileEditorInput;
+    /**
+    * A way to create text editor inputs from an untyped editor input. Depending
+    * on the passed in input this will be:
+    * - a `IFileEditorInput` for file resources
+    * - a `UntitledEditorInput` for untitled resources
+    * - a `TextResourceEditorInput` for virtual resources
+    *
+    * @param input the untyped editor input to create a typed input from
+    */
     resolveTextEditor(input: IUntypedEditorInput): Promise<EditorInput>;
     resolveTextEditor(input: IUntypedFileEditorInput): Promise<IFileEditorInput>;
 }