class

LSProtocol::WorkDoneProgressReport

Inherits JSON::Serializable / Reference / Object

Constructors

new(pull : JSON::PullParser)

Source

new(kind : String | Nil, cancellable : Bool | Nil = nil, message : String | Nil = nil, percentage : UInt32 | Nil = nil)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

Instance methods

cancellable

Controls enablement state of a cancel button.

Clients that don't support cancellation or don't support controlling the button's enablement state are allowed to ignore the property.

Source

kind

Source

message

Optional, more detailed associated progress message. Contains complementary information to the title.

Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". If unset, the previous progress message (if any) is still valid.

Source

percentage

Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the percentage value in subsequent in report notifications.

The value should be steadily rising. Clients are free to ignore values that are not following this rule. The value range is [0, 100]

Source