@types/vscode

constructor

constructor(
    executed: number | boolean,
    location?: Range | Position,
    label?: string
);

• Parameter executed

  The number of times this branch was executed, or a boolean indicating whether it was executed if the exact count is unknown. If zero or false, the branch will be marked as un-covered.

  Parameter location

  The branch position.

property executed

executed: number | boolean;

• The number of times this branch was executed, or a boolean indicating whether it was executed if the exact count is unknown. If zero or false, the branch will be marked as un-covered.

property label

label?: string;

• Label for the branch, used in the context of "the ${label} branch was not taken," for example.

property location

location?: Range | Position;

• Branch location.

constructor

protected constructor(
    enabled?: boolean,
    condition?: string,
    hitCondition?: string,
    logMessage?: string
);

• Creates a new breakpoint

  Parameter enabled

  Is breakpoint enabled.

  Parameter condition

  Expression for conditional breakpoints

  Parameter hitCondition

  Expression that controls how many hits of the breakpoint are ignored

  Parameter logMessage

  Log message to display when breakpoint is hit

property condition

readonly condition?: string;

• An optional expression for conditional breakpoints.

property enabled

readonly enabled: boolean;

• Is breakpoint enabled.

property hitCondition

readonly hitCondition?: string;

• An optional expression that controls how many hits of the breakpoint are ignored.

property id

readonly id: string;

• The unique ID of the breakpoint.

property logMessage

readonly logMessage?: string;

• An optional message that gets logged when this breakpoint is hit. Embedded expressions within {} are interpolated by the debug adapter.

constructor

constructor(item: CallHierarchyItem, fromRanges: Range[]);

• Create a new call object.

  Parameter item

  The item making the call.

  Parameter fromRanges

  The ranges at which the calls appear.

property from

from: CallHierarchyItem;

• The item that makes the call.

property fromRanges

fromRanges: Range[];

• The range at which at which the calls appears. This is relative to the caller denoted by .

constructor

constructor(
    kind: SymbolKind,
    name: string,
    detail: string,
    uri: Uri,
    range: Range,
    selectionRange: Range
);

• Creates a new call hierarchy item.

property detail

detail?: string;

• More detail for this item, e.g. the signature of a function.

property kind

kind: SymbolKind;

• The kind of this item.

property name

name: string;

• The name of this item.

property range

range: Range;

• The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

property selectionRange

selectionRange: Range;

• The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function. Must be contained by the .

property tags

tags?: readonly SymbolTag[];

• Tags for this item.

property uri

uri: Uri;

• The resource identifier of this item.

constructor

constructor(item: CallHierarchyItem, fromRanges: Range[]);

• Create a new call object.

  Parameter item

  The item being called

  Parameter fromRanges

  The ranges at which the calls appear.

property fromRanges

fromRanges: Range[];

• The range at which this item is called. This is the range relative to the caller, e.g the item passed to and not .

property to

to: CallHierarchyItem;

• The item that is called.

constructor

constructor();

• Creates a new cancellation error.

property token

token: CancellationToken;

• The cancellation token of this source.

method cancel

cancel: () => void;

• Signal cancellation on the token.

method dispose

dispose: () => void;

• Dispose object and free resources.

property command

readonly command?: string;

• The name of the that was selected for this request.

property participant

readonly participant: string;

• The id of the chat participant to which this request was directed.

property prompt

readonly prompt: string;

• The prompt as entered by the user.

  Information about references used in this request is stored in ChatRequestTurn.references.

  *Note* that the of the participant and the are not part of the prompt.

property references

readonly references: ChatPromptReference[];

• The references that were used in this message.

constructor

constructor(value: Uri | Location, title?: string);

• Create a new ChatResponseAnchorPart.

  Parameter value

  A uri or location.

  Parameter title

  An optional title that is rendered with value.

property title

title?: string;

• An optional title that is rendered with value.

property value

value: Uri | Location;

• The target of this anchor.

constructor

constructor(value: Command);

• Create a new ChatResponseCommandButtonPart.

  Parameter value

  A Command that will be executed when the button is clicked.

property value

value: Command;

• The command that will be executed when the button is clicked.

constructor

constructor(value: ChatResponseFileTree[], baseUri: Uri);

• Create a new ChatResponseFileTreePart.

  Parameter value

  File tree data.

  Parameter baseUri

  The base uri to which this file tree is relative.

property baseUri

baseUri: Uri;

• The base uri to which this file tree is relative

property value

value: ChatResponseFileTree[];

• File tree data.

constructor

constructor(value: string | MarkdownString);

• Create a new ChatResponseMarkdownPart.

  Parameter value

  A markdown string or a string that should be interpreted as markdown. The boolean form of MarkdownString.isTrusted is NOT supported.

property value

value: MarkdownString;

• A markdown string or a string that should be interpreted as markdown.

constructor

constructor(value: string);

• Create a new ChatResponseProgressPart.

  Parameter value

  A progress message

property value

value: string;

• The progress message

constructor

constructor(
    value: Uri | Location,
    iconPath?: Uri | ThemeIcon | { light: Uri; dark: Uri }
);

• Create a new ChatResponseReferencePart.

  Parameter value

  A uri or location

  Parameter iconPath

  Icon for the reference shown in UI

property iconPath

iconPath?: Uri | ThemeIcon | { light: Uri; dark: Uri };

• The icon for the reference.

property value

value: Uri | Location;

• The reference target.

property command

readonly command?: string;

• The name of the command that this response came from.

property participant

readonly participant: string;

• The id of the chat participant that this response came from.

property response

readonly response: readonly (
    | ChatResponseMarkdownPart
    | ChatResponseFileTreePart
    | ChatResponseAnchorPart
    | ChatResponseCommandButtonPart
)[];

• The content that was received from the chat participant. Only the stream parts that represent actual content (not metadata) are represented.

property result

readonly result: ChatResult;

• The result that was received from the chat participant.

constructor

constructor(title: string, kind?: CodeActionKind);

• Creates a new code action.

  A code action must have at least a and and/or a .

  Parameter title

  The title of the code action.

  Parameter kind

  The kind of the code action.

property command

command?: Command;

• A Command this code action executes.

  If this command throws an exception, the editor displays the exception message to users in the editor at the current cursor position.

property diagnostics

diagnostics?: Diagnostic[];

• that this code action resolves.

property disabled

disabled?: { readonly reason: string };

• Marks that the code action cannot currently be applied.

  - Disabled code actions are not shown in automatic [lightbulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) code action menu.

  - Disabled actions are shown as faded out in the code action menu when the user request a more specific type of code action, such as refactorings.

  - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions) that auto applies a code action and only a disabled code actions are returned, the editor will show the user an error message with reason in the editor.

property edit

edit?: WorkspaceEdit;

• A this code action performs.

property isPreferred

isPreferred?: boolean;

• Marks this as a preferred action. Preferred actions are used by the auto fix command and can be targeted by keybindings.

  A quick fix should be marked preferred if it properly addresses the underlying error. A refactoring should be marked preferred if it is the most reasonable choice of actions to take.

property kind

kind?: CodeActionKind;

• of the code action.

  Used to filter code actions.

property title

title: string;

• A short, human-readable, title for this code action.

property Empty

static readonly Empty: CodeActionKind;

• Empty kind.

property Notebook

static readonly Notebook: CodeActionKind;

• Base kind for all code actions applying to the enitre notebook's scope. CodeActionKinds using this should always begin with notebook.

  This requires that new CodeActions be created for it and contributed via extensions. Pre-existing kinds can not just have the new notebook. prefix added to them, as the functionality is unique to the full-notebook scope.

  Notebook CodeActionKinds can be initialized as either of the following (both resulting in notebook.source.xyz): - const newKind = CodeActionKind.Notebook.append(CodeActionKind.Source.append('xyz').value) - const newKind = CodeActionKind.Notebook.append('source.xyz')

  Example Kinds/Actions: - notebook.source.organizeImports (might move all imports to a new top cell) - notebook.source.normalizeVariableNames (might rename all variables to a standardized casing format)

property QuickFix

static readonly QuickFix: CodeActionKind;

• Base kind for quickfix actions: quickfix.

  Quick fix actions address a problem in the code and are shown in the normal code action context menu.

property Refactor

static readonly Refactor: CodeActionKind;

• Base kind for refactoring actions: refactor

  Refactoring actions are shown in the refactoring context menu.

property RefactorExtract

static readonly RefactorExtract: CodeActionKind;

• Base kind for refactoring extraction actions: refactor.extract

  Example extract actions:

  - Extract method - Extract function - Extract variable - Extract interface from class - ...

property RefactorInline

static readonly RefactorInline: CodeActionKind;

• Base kind for refactoring inline actions: refactor.inline

  Example inline actions:

  - Inline function - Inline variable - Inline constant - ...

property RefactorMove

static readonly RefactorMove: CodeActionKind;

• Base kind for refactoring move actions: refactor.move

  Example move actions:

  - Move a function to a new file - Move a property between classes - Move method to base class - ...

property RefactorRewrite

static readonly RefactorRewrite: CodeActionKind;

• Base kind for refactoring rewrite actions: refactor.rewrite

  Example rewrite actions:

  - Convert JavaScript function to class - Add or remove parameter - Encapsulate field - Make method static - ...

property Source

static readonly Source: CodeActionKind;

• Base kind for source actions: source

  Source code actions apply to the entire file. They must be explicitly requested and will not show in the normal [lightbulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) menu. Source actions can be run on save using editor.codeActionsOnSave and are also shown in the source context menu.

property SourceFixAll

static readonly SourceFixAll: CodeActionKind;

• Base kind for auto-fix source actions: source.fixAll.

  Fix all actions automatically fix errors that have a clear fix that do not require user input. They should not suppress errors or perform unsafe fixes such as generating new types or classes.

property SourceOrganizeImports

static readonly SourceOrganizeImports: CodeActionKind;

• Base kind for an organize imports source action: source.organizeImports.

property value

readonly value: string;

• String value of the kind, e.g. "refactor.extract.function".

method append

append: (parts: string) => CodeActionKind;

• Create a new kind by appending a more specific selector to the current kind.

  Does not modify the current kind.

method contains

contains: (other: CodeActionKind) => boolean;

• Checks if other is a sub-kind of this CodeActionKind.

  The kind "refactor.extract" for example contains "refactor.extract" and ``"refactor.extract.function"`, but not "unicorn.refactor.extract", or "refactor.extractAll" or refactor.

  Parameter other

  Kind to check.

method intersects

intersects: (other: CodeActionKind) => boolean;

• Checks if this code action kind intersects other.

  The kind "refactor.extract" for example intersects refactor, "refactor.extract" and "refactor.extract.function", but not "unicorn.refactor.extract", or "refactor.extractAll".

  Parameter other

  Kind to check.

constructor

constructor(range: Range, command?: Command);

• Creates a new code lens object.

  Parameter range

  The range to which this code lens applies.

  Parameter command

  The command associated to this code lens.

property command

command?: Command;

• The command this code lens represents.

property isResolved

readonly isResolved: boolean;

• true when there is a command associated.

property range

range: Range;

• The range in which this code lens is valid. Should only span a single line.

constructor

constructor(red: number, green: number, blue: number, alpha: number);

• Creates a new color instance.

  Parameter red

  The red component.

  Parameter green

  The green component.

  Parameter blue

  The blue component.

  Parameter alpha

  The alpha component.

property alpha

readonly alpha: number;

• The alpha component of this color in the range [0-1].

property blue

readonly blue: number;

• The blue component of this color in the range [0-1].

property green

readonly green: number;

• The green component of this color in the range [0-1].

property red

readonly red: number;

• The red component of this color in the range [0-1].

constructor

constructor(range: Range, color: Color);

• Creates a new color range.

  Parameter range

  The range the color appears in. Must not be empty.

  Parameter color

  The value of the color.

property color

color: Color;

• The actual color value for this color range.

property range

range: Range;

• The range in the document where this color appears.

constructor

constructor(label: string);

• Creates a new color presentation.

  Parameter label

  The label of this color presentation.

property additionalTextEdits

additionalTextEdits?: TextEdit[];

• An optional array of additional that are applied when selecting this color presentation. Edits must not overlap with the main nor with themselves.

property label

label: string;

• The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation.

property textEdit

textEdit?: TextEdit;

• An which is applied to a document when selecting this presentation for the color. When falsy the is used.

constructor

constructor(label: string | CompletionItemLabel, kind?: CompletionItemKind);

• Creates a new completion item.

  Completion items must have at least a which then will be used as insert text as well as for sorting and filtering.

  Parameter label

  The label of the completion.

  Parameter kind

  The of the completion.

property additionalTextEdits

additionalTextEdits?: TextEdit[];

• An optional array of additional that are applied when selecting this completion. Edits must not overlap with the main nor with themselves.

property command

command?: Command;

• An optional Command that is executed *after* inserting this completion. *Note* that additional modifications to the current document should be described with the -property.

property commitCharacters

commitCharacters?: string[];

• An optional set of characters that when pressed while this completion is active will accept it first and then type that character. *Note* that all commit characters should have length=1 and that superfluous characters will be ignored.

property detail

detail?: string;

• A human-readable string with additional information about this item, like type or symbol information.

property documentation

documentation?: string | MarkdownString;

• A human-readable string that represents a doc-comment.

property filterText

filterText?: string;

• A string that should be used when filtering a set of completion items. When falsy the is used.

  Note that the filter text is matched against the leading word (prefix) which is defined by the -property.

property insertText

insertText?: string | SnippetString;

• A string or snippet that should be inserted in a document when selecting this completion. When falsy the is used.

property keepWhitespace

keepWhitespace?: boolean;

• Keep whitespace of the as is. By default, the editor adjusts leading whitespace of new lines so that they match the indentation of the line for which the item is accepted - setting this to true will prevent that.

property kind

kind?: CompletionItemKind;

• The kind of this completion item. Based on the kind an icon is chosen by the editor.

property label

label: string | CompletionItemLabel;

• The label of this completion item. By default this is also the text that is inserted when selecting this completion.

property preselect

preselect?: boolean;

• Select this item when showing. *Note* that only one completion item can be selected and that the editor decides which item that is. The rule is that the *first* item of those that match best is selected.

property range

range?: Range | { inserting: Range; replacing: Range };

• A range or a insert and replace range selecting the text that should be replaced by this completion item.

  When omitted, the range of the is used as replace-range and as insert-range the start of the to the current position is used.

  *Note 1:* A range must be a and it must the position at which completion has been . *Note 2:* A insert range must be a prefix of a replace range, that means it must be contained and starting at the same position.

property sortText

sortText?: string;

• A string that should be used when comparing this item with other items. When falsy the is used.

  Note that sortText is only used for the initial ordering of completion items. When having a leading word (prefix) ordering is based on how well completions match that prefix and the initial ordering is only used when completions match equally well. The prefix is defined by the -property and can therefore be different for each completion.

property tags

tags?: readonly CompletionItemTag[];

• Tags for this completion item.

property textEdit

textEdit?: TextEdit;

• Deprecated

  Use CompletionItem.insertText and CompletionItem.range instead.

  An which is applied to a document when selecting this completion. When an edit is provided the value of is ignored.

  The Range of the edit must be single-line and on the same line completions were at.

constructor

constructor(items?: T[], isIncomplete?: boolean);

• Creates a new completion list.

  Parameter items

  The completion items.

  Parameter isIncomplete

  The list is not complete.

property isIncomplete

isIncomplete?: boolean;

• This list is not complete. Further typing should result in recomputing this list.

property items

items: T[];

• The completion items.

constructor

constructor(
    callback: (resolvedDefinition: TaskDefinition) => Thenable<Pseudoterminal>
);

• Constructs a CustomExecution task object. The callback will be executed when the task is run, at which point the extension should return the Pseudoterminal it will "run in". The task should wait to do further execution until Pseudoterminal.open is called. Task cancellation should be handled using Pseudoterminal.close. When the task is complete fire Pseudoterminal.onDidClose.

  Parameter callback

  The callback that will be called when the task is started by a user. Any ${} style variables that were in the task definition will be resolved and passed into the callback as resolvedDefinition.

method [Symbol.iterator]

[Symbol.iterator]: () => IterableIterator<
    [mimeType: string, item: DataTransferItem]
>;

• Get a new iterator with the [mime, item] pairs for each element in this data transfer.

method forEach

forEach: (
    callbackfn: (
        item: DataTransferItem,
        mimeType: string,
        dataTransfer: DataTransfer
    ) => void,
    thisArg?: any
) => void;

• Allows iteration through the data transfer items.

  Parameter callbackfn

  Callback for iteration through the data transfer items.

  Parameter thisArg

  The this context used when invoking the handler function.

method get

get: (mimeType: string) => DataTransferItem | undefined;

• Retrieves the data transfer item for a given mime type.

  Parameter mimeType

  The mime type to get the data transfer item for, such as text/plain or image/png. Mimes type look ups are case-insensitive.

  Special mime types: - text/uri-list — A string with toString()ed Uris separated by \r\n. To specify a cursor position in the file, set the Uri's fragment to L3,5, where 3 is the line number and 5 is the column number.

method set

set: (mimeType: string, value: DataTransferItem) => void;

• Sets a mime type to data transfer item mapping.

  Parameter mimeType

  The mime type to set the data for. Mimes types stored in lower case, with case-insensitive looks up.

  Parameter value

  The data transfer item for the given mime type.

constructor

constructor(value: any);

• Parameter value

  Custom data stored on this item. Can be retrieved using .

property value

readonly value: any;

• Custom data stored on this item.

  You can use value to share data across operations. The original object can be retrieved so long as the extension that created the DataTransferItem runs in the same extension host.

method asFile

asFile: () => DataTransferFile | undefined;

• Try getting the associated with this data transfer item.

  Note that the file object is only valid for the scope of the drag and drop operation.

  Returns

  The file for the data transfer or undefined if the item is either not a file or the file data cannot be accessed.

method asString

asString: () => Thenable<string>;

• Get a string representation of this item.

  If is an object, this returns the result of json stringifying value.

constructor

constructor(
    command: string,
    args?: string[],
    options?: DebugAdapterExecutableOptions
);

• Creates a description for a debug adapter based on an executable program.

  Parameter command

  The command or executable path that implements the debug adapter.

  Parameter args

  Optional arguments to be passed to the command or executable.

  Parameter options

  Optional options to be used when starting the command or executable.

property args

readonly args: string[];

• The arguments passed to the debug adapter executable. Defaults to an empty array.

property command

readonly command: string;

• The command or path of the debug adapter executable. A command must be either an absolute path of an executable or the name of an command to be looked up via the PATH environment variable. The special value 'node' will be mapped to the editor's built-in Node.js runtime.

property options

readonly options?: DebugAdapterExecutableOptions;

• Optional options to be used when the debug adapter is started. Defaults to undefined.

constructor

constructor(implementation: DebugAdapter);

• Create a descriptor for an inline implementation of a debug adapter.

constructor

constructor(path: string);

• Create a description for a debug adapter running as a Named Pipe (on Windows)/UNIX Domain Socket (on non-Windows) based server.

property path

readonly path: string;

• The path to the NamedPipe/UNIX Domain Socket.

constructor

constructor(port: number, host?: string);

• Create a description for a debug adapter running as a socket based server.

property host

readonly host?: string;

• The host.

property port

readonly port: number;

• The port.

property frameId

readonly frameId: number;

• ID of the stack frame in the debug protocol.

property session

readonly session: DebugSession;

• Debug session for thread.

property threadId

readonly threadId: number;

• ID of the associated thread in the debug protocol.

property session

readonly session: DebugSession;

• Debug session for thread.

property threadId

readonly threadId: number;

• ID of the associated thread in the debug protocol.

constructor

constructor(
    name: string,
    executed: number | boolean,
    location: Range | Position
);

• Parameter executed

  The number of times this declaration was executed, or a boolean indicating whether it was executed if the exact count is unknown. If zero or false, the declaration will be marked as un-covered.

  Parameter location

  The declaration position.

property executed

executed: number | boolean;

• The number of times this declaration was executed, or a boolean indicating whether it was executed if the exact count is unknown. If zero or false, the declaration will be marked as un-covered.

property location

location: Range | Position;

• Declaration location.

property name

name: string;

• Name of the declaration.

constructor

constructor(range: Range, message: string, severity?: DiagnosticSeverity);

• Creates a new diagnostic object.

  Parameter range

  The range to which this diagnostic applies.

  Parameter message

  The human-readable message.

  Parameter severity

  The severity, default is .

property code

code?: string | number | { value: string | number; target: Uri };

• A code or identifier for this diagnostic. Should be used for later processing, e.g. when providing .

property message

message: string;

• The human-readable message.

property range

range: Range;

• The range to which this diagnostic applies.

property relatedInformation

relatedInformation?: DiagnosticRelatedInformation[];

• An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.

property severity

severity: DiagnosticSeverity;

• The severity, default is .

property source

source?: string;

• A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.

property tags

tags?: DiagnosticTag[];

• Additional metadata about the diagnostic.

constructor

constructor(location: Location, message: string);

• Creates a new related diagnostic information object.

  Parameter location

  The location.

  Parameter message

  The message.

property location

location: Location;

• The location of this related diagnostic information.

property message

message: string;

• The message of this related diagnostic information.

constructor

constructor(callOnDispose: () => any);

• Creates a new disposable that calls the provided function on dispose.

  *Note* that an asynchronous function is not awaited.

  Parameter callOnDispose

  Function that disposes something.

method dispose

dispose: () => any;

• Dispose this object.

method from

static from: (...disposableLikes: { dispose: () => any }[]) => Disposable;

• Combine many disposable-likes into one. You can use this method when having objects with a dispose function which aren't instances of Disposable.

  Parameter disposableLikes

  Objects that have at least a dispose-function member. Note that asynchronous dispose-functions aren't awaited.

  Returns

  Returns a new disposable which, upon dispose, will dispose all provided disposables.

constructor

constructor(insertText: string | SnippetString);

• Parameter insertText

  The text or snippet to insert at the drop location.

property additionalEdit

additionalEdit?: WorkspaceEdit;

• An optional additional edit to apply on drop.

property insertText

insertText: string | SnippetString;

• The text or snippet to insert at the drop location.

constructor

constructor(range: Range, kind?: DocumentHighlightKind);

• Creates a new document highlight object.

  Parameter range

  The range the highlight applies to.

  Parameter kind

  The highlight kind, default is .

property kind

kind?: DocumentHighlightKind;

• The highlight kind, default is .

property range

range: Range;

• The range this highlight applies to.

constructor

constructor(range: Range, target?: Uri);

• Creates a new document link.

  Parameter range

  The range the document link applies to. Must not be empty.

  Parameter target

  The uri the document link points to.

property range

range: Range;

• The range this link applies to.

property target

target?: Uri;

• The uri this link points to.

property tooltip

tooltip?: string;

• The tooltip text when you hover over this link.

  If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as {0} (ctrl + click). The specific instructions vary depending on OS, user settings, and localization.

constructor

constructor(
    name: string,
    detail: string,
    kind: SymbolKind,
    range: Range,
    selectionRange: Range
);

• Creates a new document symbol.

  Parameter name

  The name of the symbol.

  Parameter detail

  Details for the symbol.

  Parameter kind

  The kind of the symbol.

  Parameter range

  The full range of the symbol.

  Parameter selectionRange

  The range that should be reveal.

property children

children: DocumentSymbol[];

• Children of this symbol, e.g. properties of a class.

property detail

detail: string;

• More detail for this symbol, e.g. the signature of a function.

property kind

kind: SymbolKind;

• The kind of this symbol.

property name

name: string;

• The name of this symbol.

property range

range: Range;

• The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

property selectionRange

selectionRange: Range;

• The range that should be selected and reveal when this symbol is being picked, e.g. the name of a function. Must be contained by the .

property tags

tags?: readonly SymbolTag[];

• Tags for this symbol.

constructor

constructor(range: Range, expression?: string);

• Creates a new evaluatable expression object.

  Parameter range

  The range in the underlying document from which the evaluatable expression is extracted.

  Parameter expression

  If specified overrides the extracted expression.

property expression

readonly expression?: string;

property range

readonly range: Range;

property event

event: Event<T>;

• The event listeners can subscribe to.

method dispose

dispose: () => void;

• Dispose this object and free resources.

method fire

fire: (data: T) => void;

• Notify all subscribers of the . Failure of one or more listener will not fail this function call.

  Parameter data

  The event object.

constructor

constructor(
    uri: Uri,
    statementCoverage: TestCoverageCount,
    branchCoverage?: TestCoverageCount,
    declarationCoverage?: TestCoverageCount
);

• Parameter uri

  Covered file URI

  Parameter statementCoverage

  Statement coverage information. If the reporter does not provide statement coverage information, this can instead be used to represent line coverage.

  Parameter branchCoverage

  Branch coverage information

  Parameter declarationCoverage

  Declaration coverage information

property branchCoverage

branchCoverage?: TestCoverageCount;

• Branch coverage information.

property declarationCoverage

declarationCoverage?: TestCoverageCount;

• Declaration coverage information. Depending on the reporter and language, this may be types such as functions, methods, or namespaces.

property statementCoverage

statementCoverage: TestCoverageCount;

• Statement coverage information. If the reporter does not provide statement coverage information, this can instead be used to represent line coverage.

property uri

readonly uri: Uri;

• File URI.

method fromDetails

static fromDetails: (
    uri: Uri,
    details: readonly FileCoverageDetail[]
) => FileCoverage;

• Creates a FileCoverage instance with counts filled in from the coverage details.

  Parameter uri

  Covered file URI

  Parameter detailed

  Detailed coverage information

constructor

constructor(badge?: string, tooltip?: string, color?: ThemeColor);

• Creates a new decoration.

  Parameter badge

  A letter that represents the decoration.

  Parameter tooltip

  The tooltip of the decoration.

  Parameter color

  The color of the decoration.

property badge

badge?: string;

• A very short string that represents this decoration.

property color

color?: ThemeColor;

• The color of this decoration.

property propagate

propagate?: boolean;