View source

typedef FileDecorationProvider

package vscode

The decoration provider interfaces defines the contract between extensions and file decorations.

Fields

provideFileDecoration(uri:Uri, token:CancellationToken):ProviderResult<FileDecoration>

Provide decorations for a given uri.

Note that this function is only called when a file gets rendered in the UI. This means a decoration from a descendent that propagates upwards must be signaled to the editor via the {@link FileDecorationProvider.onDidChangeFileDecorations onDidChangeFileDecorations}-event.

Parameters:

uri

The uri of the file to provide a decoration for.

token

A cancellation token.

Returns:

A decoration or a thenable that resolves to such.

@:optionaloptionalonDidChangeFileDecorations:Null<Event<Null<EitherType<Uri, Array<Uri>>>>>

An optional event to signal that decorations for one or many files have changed.

Note that this event should be used to propagate information about children.

@link EventEmitter}

See also:

  • {