specify setTrace

This commit is contained in:
Sacha Ayoun 2020-04-15 11:36:19 +01:00
parent b878589b58
commit 1e756eb68f

View file

@ -1289,6 +1289,15 @@ export interface PartialResultParams {
}
```
#### <a href="#traceValue" name="traceValue" class="anchor"> TraceValue </a>
A `TraceValue` represents the level of verbosity with which the server systematically reports its execution trace using [$/logTrace](#logTrace) notifications.
The initial trace value is set by the client at initialization and can be modified later using the [$/setTrace](#setTrace) notification.
```typescript
export type TraceValue = 'off' | 'message' | 'verbose'
```
### Actual Protocol
This section documents the actual language server protocol. It uses the following format:
@ -1379,7 +1388,7 @@ interface InitializeParams extends WorkDoneProgressParams {
/**
* The initial trace setting. If omitted trace is disabled ('off').
*/
trace?: 'off' | 'messages' | 'verbose';
trace?: TraceValue;
/**
* The workspace folders configured in the client when the server starts.
@ -1882,6 +1891,23 @@ interface logTraceParams {
}
```
#### <a href="#setTrace" name="setTrace" class="anchor">SetTrace Notification (:arrow_right:)</a>
A notification that should be used by the client to modify the trace setting of the server.
_Notification_:
* method: '$/setTrace'
* params: `setTraceParams` defined as follows:
```typescript
interface setTraceParams {
/**
* The new value that should be assigned to the trace setting.
*/
value: TraceValue;
}
```
#### <a href="#window_showMessage" name="window_showMessage" class="anchor">ShowMessage Notification (:arrow_left:)</a>
The show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.