1
- /**
2
- * Declaration module describing the TypeScript Server protocol
1
+ /**
2
+ * Declaration module describing the TypeScript Server protocol
3
3
*/
4
4
declare namespace ts . server . protocol {
5
- /**
6
- * A TypeScript Server message
5
+ /**
6
+ * A TypeScript Server message
7
7
*/
8
8
export interface Message {
9
- /**
10
- * Sequence number of the message
9
+ /**
10
+ * Sequence number of the message
11
11
*/
12
12
seq : number ;
13
13
14
14
/**
15
- * One of "request", "response", or "event"
15
+ * One of "request", "response", or "event"
16
16
*/
17
17
type : string ;
18
18
}
19
19
20
- /**
21
- * Client-initiated request message
20
+ /**
21
+ * Client-initiated request message
22
22
*/
23
23
export interface Request extends Message {
24
24
/**
25
- * The command to execute
25
+ * The command to execute
26
26
*/
27
27
command : string ;
28
28
29
- /**
30
- * Object containing arguments for the command
29
+ /**
30
+ * Object containing arguments for the command
31
31
*/
32
32
arguments ?: any ;
33
33
}
34
34
35
35
/**
36
- * Request to reload the project structure for all the opened files
36
+ * Request to reload the project structure for all the opened files
37
37
*/
38
38
export interface ReloadProjectsRequest extends Message {
39
39
}
40
40
41
- /**
42
- * Server-initiated event message
41
+ /**
42
+ * Server-initiated event message
43
43
*/
44
44
export interface Event extends Message {
45
- /**
46
- * Name of event
45
+ /**
46
+ * Name of event
47
47
*/
48
48
event : string ;
49
49
50
- /**
51
- * Event-specific information
50
+ /**
51
+ * Event-specific information
52
52
*/
53
53
body ?: any ;
54
54
}
@@ -62,18 +62,18 @@ declare namespace ts.server.protocol {
62
62
*/
63
63
request_seq : number ;
64
64
65
- /**
66
- * Outcome of the request.
65
+ /**
66
+ * Outcome of the request.
67
67
*/
68
68
success : boolean ;
69
69
70
- /**
70
+ /**
71
71
* The command requested.
72
72
*/
73
73
command : string ;
74
74
75
- /**
76
- * Contains error message if success === false.
75
+ /**
76
+ * Contains error message if success === false.
77
77
*/
78
78
message ?: string ;
79
79
@@ -83,7 +83,7 @@ declare namespace ts.server.protocol {
83
83
body ?: any ;
84
84
}
85
85
86
- /**
86
+ /**
87
87
* Arguments for FileRequest messages.
88
88
*/
89
89
export interface FileRequestArgs {
@@ -93,7 +93,7 @@ declare namespace ts.server.protocol {
93
93
file : string ;
94
94
}
95
95
96
- /**
96
+ /**
97
97
* Arguments for ProjectInfoRequest request.
98
98
*/
99
99
export interface ProjectInfoRequestArgs extends FileRequestArgs {
@@ -110,7 +110,7 @@ declare namespace ts.server.protocol {
110
110
arguments : ProjectInfoRequestArgs ;
111
111
}
112
112
113
- /**
113
+ /**
114
114
* Response message body for "projectInfo" request
115
115
*/
116
116
export interface ProjectInfo {
@@ -125,7 +125,7 @@ declare namespace ts.server.protocol {
125
125
fileNames ?: string [ ] ;
126
126
}
127
127
128
- /**
128
+ /**
129
129
* Response message for "projectInfo" request
130
130
*/
131
131
export interface ProjectInfoResponse extends Response {
@@ -144,12 +144,12 @@ declare namespace ts.server.protocol {
144
144
* (file, line, character offset), where line and character offset are 1-based.
145
145
*/
146
146
export interface FileLocationRequestArgs extends FileRequestArgs {
147
- /**
147
+ /**
148
148
* The line number for the request (1-based).
149
149
*/
150
150
line : number ;
151
151
152
- /**
152
+ /**
153
153
* The character offset (on the line) for the request (1-based).
154
154
*/
155
155
offset : number ;
@@ -216,7 +216,7 @@ declare namespace ts.server.protocol {
216
216
* Object found in response messages defining a span of text in a specific source file.
217
217
*/
218
218
export interface FileSpan extends TextSpan {
219
- /**
219
+ /**
220
220
* File containing text span.
221
221
*/
222
222
file : string ;
@@ -300,14 +300,14 @@ declare namespace ts.server.protocol {
300
300
*/
301
301
lineText : string ;
302
302
303
- /**
303
+ /**
304
304
* True if reference is a write location, false otherwise.
305
305
*/
306
306
isWriteAccess : boolean ;
307
307
}
308
308
309
309
/**
310
- * The body of a "references" response message.
310
+ * The body of a "references" response message.
311
311
*/
312
312
export interface ReferencesResponseBody {
313
313
/**
@@ -325,7 +325,7 @@ declare namespace ts.server.protocol {
325
325
*/
326
326
symbolStartOffset : number ;
327
327
328
- /**
328
+ /**
329
329
* The full display name of the symbol.
330
330
*/
331
331
symbolDisplayString : string ;
@@ -355,7 +355,7 @@ declare namespace ts.server.protocol {
355
355
}
356
356
357
357
/**
358
- * Information about the item to be renamed.
358
+ * Information about the item to be renamed.
359
359
*/
360
360
export interface RenameInfo {
361
361
/**
@@ -373,7 +373,7 @@ declare namespace ts.server.protocol {
373
373
*/
374
374
displayName : string ;
375
375
376
- /**
376
+ /**
377
377
* Full display name of item to be renamed.
378
378
*/
379
379
fullDisplayName : string ;
@@ -383,7 +383,7 @@ declare namespace ts.server.protocol {
383
383
*/
384
384
kind : string ;
385
385
386
- /**
386
+ /**
387
387
* Optional modifiers for the kind (such as 'public').
388
388
*/
389
389
kindModifiers : string ;
@@ -469,15 +469,15 @@ declare namespace ts.server.protocol {
469
469
placeOpenBraceOnNewLineForControlBlocks ?: boolean ;
470
470
471
471
/** Index operator */
472
- [ key : string ] : string | number | boolean ;
472
+ [ key : string ] : string | number | boolean ;
473
473
}
474
474
475
475
/**
476
476
* Information found in a configure request.
477
477
*/
478
478
export interface ConfigureRequestArguments {
479
479
480
- /**
480
+ /**
481
481
* Information about the host, for example 'Emacs 24.4' or
482
482
* 'Sublime Text version 3075'
483
483
*/
@@ -495,7 +495,7 @@ declare namespace ts.server.protocol {
495
495
}
496
496
497
497
/**
498
- * Configure request; value of command field is "configure". Specifies
498
+ * Configure request; value of command field is "configure". Specifies
499
499
* host information, such as host type, tab size, and indent size.
500
500
*/
501
501
export interface ConfigureRequest extends Request {
@@ -514,8 +514,8 @@ declare namespace ts.server.protocol {
514
514
*/
515
515
export interface OpenRequestArgs extends FileRequestArgs {
516
516
/**
517
- * Used when a version of the file content is known to be more up to date than the one on disk.
518
- * Then the known content will be used upon opening instead of the disk copy
517
+ * Used when a version of the file content is known to be more up to date than the one on disk.
518
+ * Then the known content will be used upon opening instead of the disk copy
519
519
*/
520
520
fileContent ?: string ;
521
521
}
@@ -751,7 +751,7 @@ declare namespace ts.server.protocol {
751
751
* Optional modifiers for the kind (such as 'public').
752
752
*/
753
753
kindModifiers : string ;
754
- /**
754
+ /**
755
755
* A string that is used for comparing completion items so that they can be ordered. This
756
756
* is often the same as the name but may be different in certain circumstances.
757
757
*/
@@ -794,7 +794,7 @@ declare namespace ts.server.protocol {
794
794
}
795
795
796
796
/**
797
- * Signature help information for a single parameter
797
+ * Signature help information for a single parameter
798
798
*/
799
799
export interface SignatureHelpParameter {
800
800
@@ -814,18 +814,18 @@ declare namespace ts.server.protocol {
814
814
displayParts : SymbolDisplayPart [ ] ;
815
815
816
816
/**
817
- * Whether the parameter is optional or not.
817
+ * Whether the parameter is optional or not.
818
818
*/
819
819
isOptional : boolean ;
820
820
}
821
821
822
822
/**
823
- * Represents a single signature to show in signature help.
823
+ * Represents a single signature to show in signature help.
824
824
*/
825
825
export interface SignatureHelpItem {
826
826
827
827
/**
828
- * Whether the signature accepts a variable number of arguments.
828
+ * Whether the signature accepts a variable number of arguments.
829
829
*/
830
830
isVariadic : boolean ;
831
831
@@ -845,7 +845,7 @@ declare namespace ts.server.protocol {
845
845
separatorDisplayParts : SymbolDisplayPart [ ] ;
846
846
847
847
/**
848
- * The signature helps items for the parameters.
848
+ * The signature helps items for the parameters.
849
849
*/
850
850
parameters : SignatureHelpParameter [ ] ;
851
851
@@ -861,17 +861,17 @@ declare namespace ts.server.protocol {
861
861
export interface SignatureHelpItems {
862
862
863
863
/**
864
- * The signature help items.
864
+ * The signature help items.
865
865
*/
866
866
items : SignatureHelpItem [ ] ;
867
867
868
868
/**
869
- * The span for which signature help should appear on a signature
869
+ * The span for which signature help should appear on a signature
870
870
*/
871
871
applicableSpan : TextSpan ;
872
872
873
873
/**
874
- * The item selected in the set of available help items.
874
+ * The item selected in the set of available help items.
875
875
*/
876
876
selectedItemIndex : number ;
877
877
@@ -895,7 +895,7 @@ declare namespace ts.server.protocol {
895
895
896
896
/**
897
897
* Signature help request; value of command field is "signatureHelp".
898
- * Given a file location (file, line, col), return the signature
898
+ * Given a file location (file, line, col), return the signature
899
899
* help.
900
900
*/
901
901
export interface SignatureHelpRequest extends FileLocationRequest {
@@ -926,8 +926,8 @@ declare namespace ts.server.protocol {
926
926
}
927
927
928
928
/**
929
- * GeterrForProjectRequest request; value of command field is
930
- * "geterrForProject". It works similarly with 'Geterr', only
929
+ * GeterrForProjectRequest request; value of command field is
930
+ * "geterrForProject". It works similarly with 'Geterr', only
931
931
* it request for every file in this project.
932
932
*/
933
933
export interface GeterrForProjectRequest extends Request {
@@ -997,7 +997,7 @@ declare namespace ts.server.protocol {
997
997
diagnostics : Diagnostic [ ] ;
998
998
}
999
999
1000
- /**
1000
+ /**
1001
1001
* Event message for "syntaxDiag" and "semanticDiag" event types.
1002
1002
* These events provide syntactic and semantic errors for a file.
1003
1003
*/
@@ -1033,7 +1033,7 @@ declare namespace ts.server.protocol {
1033
1033
export interface ReloadResponse extends Response {
1034
1034
}
1035
1035
1036
- /**
1036
+ /**
1037
1037
* Arguments for saveto request.
1038
1038
*/
1039
1039
export interface SavetoRequestArgs extends FileRequestArgs {
@@ -1109,7 +1109,7 @@ declare namespace ts.server.protocol {
1109
1109
*/
1110
1110
kindModifiers ?: string ;
1111
1111
1112
- /**
1112
+ /**
1113
1113
* The file in which the symbol is found.
1114
1114
*/
1115
1115
file : string ;
@@ -1156,7 +1156,7 @@ declare namespace ts.server.protocol {
1156
1156
1157
1157
/**
1158
1158
* Change request message; value of command field is "change".
1159
- * Update the server's view of the file named by argument 'file'.
1159
+ * Update the server's view of the file named by argument 'file'.
1160
1160
* Server does not currently send a response to a change request.
1161
1161
*/
1162
1162
export interface ChangeRequest extends FileLocationRequest {
0 commit comments