Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProgressContext

A progress context.

Hierarchy

  • ProgressContext

Index

Properties

baseContext

baseContext: Progress<{ increment?: number; message?: string }>

The base context provided by Visual Studio Code.

Optional cancellationToken

cancellationToken: CancellationToken

If cancellable, this contains the "cancellation token".

increment

increment: number

The increment value.

incrementIfNeeded

incrementIfNeeded: (item: any, message: string) => boolean

Increments the progress value only if an item has not been handled yet.

param

The item to check.

param

The new message.

returns

Value has been increased or not.

Type declaration

    • (item: any, message: string): boolean
    • Parameters

      • item: any
      • message: string

      Returns boolean

message

message: string

Gets or sets the status message.

Generated using TypeDoc