A set of one or more available refactoring actions, grouped under a parent refactoring.

Request to get brace completion for a location in the file.

Argument for BraceCompletionRequest request.

Brace matching request; value of command field is "brace".
Return response giving the file locations of matching braces
found in file at location line, offset.

Response to "brace" request.

Change request message; value of command field is "change".
Update the server's view of the file named by argument 'file'.
Server does not currently send a response to a change request.

Arguments for change request message.

Request to close external project.

Arguments to CloseExternalProjectRequest request

Response to CloseExternalProjectRequest request. This is just an acknowledgement, so
no body field is required.

Close request; value of command field is "close". Notify the
server that the client has closed a previously open file.  If
file is still referenced by open files, the server will resume
monitoring the filesystem for changes to file.  Server does not
currently send a response to a close request.

Object found in response messages defining an editing
instruction for a span of text in source code.  The effect of
this instruction is to replace the text starting at start and
ending one character before end with newText. For an insertion,
the text span is empty.  For a deletion, newText is empty.

Request for the available codefixes at a specific position.

Instances of this interface specify errorcodes on a specific location in a sourcefile.

Request to obtain the list of files that should be regenerated if target file is recompiled.
NOTE: this us query-only operation and does not generate any output on disk.

Response for CompileOnSaveAffectedFileListRequest request;

Contains a list of files that should be regenerated in a project

Request to recompile the file. All generated outputs (.js, .d.ts or .js.map files) is written on disk.

Arguments for CompileOnSaveEmitFileRequest

A request to retrieve compiler options diagnostics for a project

Arguments for CompilerOptionsDiagnosticsRequest request.

Completion entry details request; value of command field is
"completionEntryDetails".  Given a file location (file, line,
col) and an array of completion entry names return more
detailed information for each completion entry.

Arguments for completion details request.

An item found in a completion response.

Additional completion entry details, available on demand

Completions request; value of command field is "completions".
Given a file location (file, line, col) and a prefix (which may
be the empty string), return the possible completions that
begin with prefix.

Arguments for completions messages.

Event message for "configFileDiag" event type.
This event provides errors for a found config file.

Configure request; value of command field is "configure".  Specifies
host information, such as host type, tab size, and indent size.

Information found in a configure request.

Response to "configure" request.  This is just an acknowledgement, so
no body field is required.

Go to definition request; value of command field is
"definition". Return response giving the file locations that
define the symbol found in file at location line, col.

Definition response message.  Gives text range for definition.

Item of diagnostic information found in a DiagnosticEvent message.

Event message for DiagnosticEventKind event types.
These events provide syntactic and semantic errors for a file.

Represents additional spans returned with a diagnostic which are relevant to it

Represents diagnostic info that includes location of diagnostic in two forms
- start position and length of the error span
- startLocation and endLocation - a pair of Location objects that store start/end line and offset of the error span.

Response to DocCommentTemplateRequest

Requests a JS Doc comment template for a given position

Represents a set of highligh spans for a give name

Get document highlights request; value of command field is
"documentHighlights". Return response giving spans that are relevant
in the file at a given line and column.

Arguments in document highlight request; include: filesToSearch, file,
line, offset.

Response for a DocumentHighlightsRequest request.

A request to get encoded semantic classifications for a span in the file

Arguments for EncodedSemanticClassificationsRequest request.

The response for a EncodedSemanticClassificationsRequest

Implementation response message. Gives series of text spans depending on the format ar.

Server-initiated event message

Exit request; value of command field is "exit".  Ask the server process
to exit.

Represents a file in external project.
External project is project whose set of files, compilation options and open\close state
is maintained by the client (i.e. if all this data come from .csproj file in Visual Studio).
External project will exist even if all files in it are closed and should be closed explicitly.
If external project includes one or more tsconfig.json/jsconfig.json files then tsserver will
create configured project for every config file but will maintain a link that these projects were created
as a result of opening external project so they should be removed once external project is closed.

Represent an external project

A request whose arguments specify a file location (file, line, col).

Instances of this interface specify a location in a source file:
(file, line, character offset), where line and character offset are 1-based.

Request whose sole parameter is a file name.

Arguments for FileRequest messages.

Object found in response messages defining a span of text in a specific source file.

Format on key request; value of command field is
"formatonkey". Given file location and key typed (as string),
return response giving zero or more edit instructions.  The
edit instructions will be sorted in file order.  Applying the
edit instructions in reverse to file will result in correctly
reformatted text.

Arguments for format on key messages.

Format request; value of command field is "format".  Return
response giving zero or more edit instructions.  The edit
instructions will be sorted in file order.  Applying the edit
instructions in reverse to file will result in correctly
reformatted text.

Arguments for format messages.

Format and format on key response message.

Request refactorings at a given position or selection area.

Response is a list of available refactorings.
Each refactoring exposes one or more "Actions"; a user selects one action to invoke a refactoring

Response for GetCodeFixes request.

Note: Paths may also be directories.

Response is a list of available files.
Each refactoring exposes one or more "Actions"; a user selects one action to invoke a refactoring

Request refactorings at a given position or selection area to move to an existing file.

A request to get codes of supported code fixes.

A response for GetSupportedCodeFixesRequest request.

GeterrForProjectRequest request; value of command field is
"geterrForProject". It works similarly with 'Geterr', only
it request for every file in this project.

Arguments for GeterrForProject request.

Geterr request; value of command field is "geterr". Wait for
delay milliseconds and then, if during the wait no change or
reload messages have arrived for the first file in the files
list, get the syntactic errors for the file, field requests,
and then get the semantic errors for the file.  Repeat with a
smaller delay for each subsequent file on the files list.  Best
practice for an editor is to send a file list containing each
file that is currently visible, in most-recently-used order.

Arguments for geterr messages.

Span augmented with extra information that denotes the kind of the highlighting to be used for span.

Go to implementation request; value of command field is
"implementation". Return response giving the file locations that
implement the symbol found in file at location line, col.

Implementation response message.  Gives text range for implementations.

A request to get indentation for a location in file

Arguments for IndentationRequest request.

Response for IndentationRequest request.

Indentation result representing where indentation should be placed

A part of a symbol description that links from a jsdoc

Location in source code expressed as (one-based) line and (one-based) column offset.

A TypeScript Server message

NavBar items request; value of command field is "navbar".
Return response giving the list of navigation bar entries
extracted from the requested file.

NavTree request; value of command field is "navtree".
Return response giving the navigation tree of the requested file.

protocol.NavigationTree is identical to ts.NavigationTree, except using protocol.TextSpan instead of ts.TextSpan

An item found in a navto response.

Navto request message; value of command field is "navto".
Return list of objects giving file locations and symbols that
match the search term given in argument 'searchTerm'.  The
context for the search is given by the named file.

Arguments for navto request message.

Navto response message. Body is an array of navto items.  Each
item gives a symbol that matched the search term.

Request to open or update external project

Response to OpenExternalProjectRequest request. This is just an acknowledgement, so
no body field is required.

Arguments to OpenExternalProjectsRequest

Request to open multiple external projects

Response to OpenExternalProjectsRequest request. This is just an acknowledgement, so
no body field is required.

Open request; value of command field is "open". Notify the
server that the client has file open.  The server will not
monitor the filesystem for changes in this file and will assume
that the client is updating the server (using the change and/or
reload messages) when the file changes. Server does not currently
send a response to an open request.

Information found in an "open" request.

Organize imports by:
1) Removing unused imports
2) Coalescing imports from the same module
3) Sorting imports

Request to obtain outlining spans in file.

Response to OutliningSpansRequest request.

Represents a set of changes that happen in project

Response message body for "projectInfo" request

A request to get the project information of the current file.

Arguments for ProjectInfoRequest request.

Response message for "projectInfo" request

Quickinfo request; value of command field is
"quickinfo". Return response giving a quick type and
documentation string for the symbol found in file at location
line, col.

Quickinfo response message.

Body of QuickInfoResponse.

Represents a single refactoring action - for example, the "Extract Method..." refactor might
offer several actions, each corresponding to a surround class or closure to extract into.

Find references request; value of command field is
"references". Return response giving the file locations that
reference the symbol found in file at location line, col.

Response to "references" request.

The body of a "references" response message.

Request to reload the project structure for all the opened files

Reload request message; value of command field is "reload".
Reload contents of file with name given by the 'file' argument
from temporary file with name given by the 'tmpfile' argument.
The two names can be identical.

Arguments for reload request.

Response to "reload" request. This is just an acknowledgement, so
no body field is required.

Rename request; value of command field is "rename". Return
response giving the file locations that reference the symbol
found in file at location line, col. Also return full display
name of the symbol so that client can print it unambiguously.

Argument for RenameRequest request.

Rename response message.

Client-initiated request message

Event that is sent when server have finished processing request with specified id.

Response by server to client request message.

Saveto request message; value of command field is "saveto".
For debugging purposes, save to a temporaryfile (named by
argument 'tmpfile') the contents of file named by argument
'file'.  The server does not currently send a response to a
"saveto" request.

Arguments for saveto request.

Synchronous request for semantic diagnostics of one file.

Response object for synchronous sematic diagnostics request.

Argument for SetCompilerOptionsForInferredProjectsRequest request.

Request to set compiler options for inferred projects.
External projects are opened / closed explicitly.
Configured projects are opened when user opens loose file that has 'tsconfig.json' or 'jsconfig.json' anywhere in one of containing folders.
This configuration file will be used to obtain a list of files and configuration settings for the project.
Inferred projects are created when user opens a loose file that is not the part of external project
or configured project and will contain only open file and transitive closure of referenced files if 'useOneInferredProject' is false,
or all open loose files and its transitive closure of referenced files if 'useOneInferredProject' is true.

Response to SetCompilerOptionsForInferredProjectsResponse request. This is just an acknowledgement, so
no body field is required.

Signals that the signature help request came from a user typing a character.
Depending on the character and the syntactic context, the request may or may not be served a result.

Signals that the user manually requested signature help.
The language service will unconditionally attempt to provide a result.

Represents a single signature to show in signature help.

Signature help items found in the response of a signature help request.

Signature help information for a single parameter

Signature help request; value of command field is "signatureHelp".
Given a file location (file, line, col), return the signature
help.

Arguments of a signature help request.

Response object for a SignatureHelpRequest.

Signals that this signature help request came from typing a character or moving the cursor.
This should only occur if a signature help session was already active and the editor needs to see if it should adjust.
The language service will unconditionally attempt to provide a result.
`triggerCharacter` can be `undefined` for a retrigger caused by a cursor move.

A group of text spans, all in 'file'.

A request to determine if the caret is inside a comment.

Response to StatusRequest

Part of a symbol description.

Synchronous request for syntactic diagnostics of one file.