File tree Expand file tree Collapse file tree 3 files changed +12
-1
lines changed
docs/specification/draft/basic/utilities Expand file tree Collapse file tree 3 files changed +12
-1
lines changed Original file line number Diff line number Diff line change @@ -36,6 +36,7 @@ The receiver **MAY** then send progress notifications containing:
36
36
- The original progress token
37
37
- The current progress value so far
38
38
- An optional "total" value
39
+ - An optional "message" value
39
40
40
41
``` json
41
42
{
@@ -44,14 +45,16 @@ The receiver **MAY** then send progress notifications containing:
44
45
"params" : {
45
46
"progressToken" : " abc123" ,
46
47
"progress" : 50 ,
47
- "total" : 100
48
+ "total" : 100 ,
49
+ "message" : " Reticulating splines..."
48
50
}
49
51
}
50
52
```
51
53
52
54
- The ` progress ` value ** MUST** increase with each notification, even if the total is
53
55
unknown.
54
56
- The ` progress ` and the ` total ` values ** MAY** be floating point.
57
+ - The ` message ` field ** SHOULD** provide relevant human readable progress information.
55
58
56
59
## Behavior Requirements
57
60
Original file line number Diff line number Diff line change 1284
1284
},
1285
1285
"params" : {
1286
1286
"properties" : {
1287
+ "message" : {
1288
+ "description" : " An optional message describing the current progress." ,
1289
+ "type" : " string"
1290
+ },
1287
1291
"progress" : {
1288
1292
"description" : " The progress thus far. This should increase every time progress is made, even if the total is unknown." ,
1289
1293
"type" : " number"
Original file line number Diff line number Diff line change @@ -289,6 +289,10 @@ export interface ProgressNotification extends Notification {
289
289
* @TJS -type number
290
290
*/
291
291
total ?: number ;
292
+ /**
293
+ * An optional message describing the current progress.
294
+ */
295
+ message ?: string ;
292
296
} ;
293
297
}
294
298
You can’t perform that action at this time.
0 commit comments