A set of one or more available refactoring actions, grouped under a parent refactoring.
A set of one or more available refactoring actions, grouped under a parent refactoring.
Builder to manage the program state changes
Builder to manage the program state changes
A list of comma-separated expressions. This node is only created by transformations.
A list of comma-separated expressions. This node is only created by transformations.
Reports config file diagnostics
Reports config file diagnostics
A linked list of formatted diagnostic messages to be used as part of a multiline message. It is built from the bottom up, leaving the head to be the "main" diagnostic. While it seems that DiagnosticMessageChain is structurally similar to DiagnosticMessage, the difference is that messages are all preformatted in DMC.
A linked list of formatted diagnostic messages to be used as part of a multiline message. It is built from the bottom up, leaving the head to be the "main" diagnostic. While it seems that DiagnosticMessageChain is structurally similar to DiagnosticMessage, the difference is that messages are all preformatted in DMC.
The document registry represents a store of SourceFile objects that can be shared between multiple LanguageService instances. A LanguageService instance holds on the SourceFile (AST) of files in the context. SourceFile objects account for most of the memory usage by the language service. Sharing the same DocumentRegistry instance between different instances of LanguageService allow for more efficient memory utilization since all projects will share at least the library file (lib.d.ts).
A more advanced use of the document registry is to serialize sourceFile objects to disk and re-hydrate them when needed.
To create a default DocumentRegistry, use createDocumentRegistry to create one, and pass it to all subsequent createLanguageService calls.
The document registry represents a store of SourceFile objects that can be shared between multiple LanguageService instances. A LanguageService instance holds on the SourceFile (AST) of files in the context. SourceFile objects account for most of the memory usage by the language service. Sharing the same DocumentRegistry instance between different instances of LanguageService allow for more efficient memory utilization since all projects will share at least the library file (lib.d.ts). A more advanced use of the document registry is to serialize sourceFile objects to disk and re-hydrate them when needed. To create a default DocumentRegistry, use createDocumentRegistry to create one, and pass it to all subsequent createLanguageService calls.
The builder that can handle the changes in program and iterate through changed file to emit the files The semantic diagnostics are cached per file and managed by clearing for the changed/affected files
The builder that can handle the changes in program and iterate through changed file to emit the files The semantic diagnostics are cached per file and managed by clearing for the changed/affected files
Return code used by getEmitOutput function to indicate status of the function
Return code used by getEmitOutput function to indicate status of the function
This is either an export =
or an export default
declaration.
Unless isExportEquals
is set, this node was parsed as an export default
.
This is either an `export =` or an `export default` declaration. Unless `isExportEquals` is set, this node was parsed as an `export default`.
Several node kinds share function-like features such as a signature, a name, and a body. These nodes should extend FunctionLikeDeclarationBase. Examples:
Several node kinds share function-like features such as a signature, a name, and a body. These nodes should extend FunctionLikeDeclarationBase. Examples: - FunctionDeclaration - MethodDeclaration - AccessorDeclaration
Represents an immutable snapshot of a script at a specified time.Once acquired, the snapshot is observably immutable. i.e. the same calls with the same parameters will return the same values.
Represents an immutable snapshot of a script at a specified time.Once acquired, the snapshot is observably immutable. i.e. the same calls with the same parameters will return the same values.
One of:
One of: - import x = require("mod"); - import x = M.x;
Class and interface types (ObjectFlags.Class and ObjectFlags.Interface).
Class and interface types (ObjectFlags.Class and ObjectFlags.Interface).
Note that @extends
is a synonym of @augments
.
Both tags are represented by this interface.
Note that `@extends` is a synonym of `@augments`. Both tags are represented by this interface.
Class#method reference in JSDoc
Class#method reference in JSDoc
Used by services to specify the minimum host area required to set up source files under any compilation settings
Used by services to specify the minimum host area required to set up source files under any compilation settings
Navigation bar interface designed for visual studio's dual-column layout.
This does not form a proper tree.
The navbar is returned as a list of top-level items, each of which has a list of child items.
Child items always have an empty array for their childItems
.
Navigation bar interface designed for visual studio's dual-column layout. This does not form a proper tree. The navbar is returned as a list of top-level items, each of which has a list of child items. Child items always have an empty array for their `childItems`.
Node in a tree of nested declarations in a file. The top node is always a script or module node.
Node in a tree of nested declarations in a file. The top node is always a script or module node.
Stored map from non-relative module name to a table: directory -> result of module lookup in this directory We support only non-relative module names because resolution of relative module names is usually more deterministic and thus less expensive.
Stored map from non-relative module name to a table: directory -> result of module lookup in this directory We support only non-relative module names because resolution of relative module names is usually more deterministic and thus less expensive.
This interface is a base interface for ObjectLiteralExpression and JSXAttributes to extend from. JSXAttributes is similar to ObjectLiteralExpression in that it contains array of properties; however, JSXAttributes' properties can only be JSXAttribute or JSXSpreadAttribute. ObjectLiteralExpression, on the other hand, can only have properties of type ObjectLiteralElement (e.g. PropertyAssignment, ShorthandPropertyAssignment etc.)
This interface is a base interface for ObjectLiteralExpression and JSXAttributes to extend from. JSXAttributes is similar to ObjectLiteralExpression in that it contains array of properties; however, JSXAttributes' properties can only be JSXAttribute or JSXSpreadAttribute. ObjectLiteralExpression, on the other hand, can only have properties of type ObjectLiteralElement (e.g. PropertyAssignment, ShorthandPropertyAssignment etc.)
Unique identifier with a package name and version.
If changing this, remember to change packageIdIsEqual
.
Unique identifier with a package name and version. If changing this, remember to change `packageIdIsEqual`.
Interface extending ParseConfigHost to support ParseConfigFile that reads config file and reports errors
Interface extending ParseConfigHost to support ParseConfigFile that reads config file and reports errors
Either a parsed command line or a parsed tsconfig.json
Either a parsed command line or a parsed tsconfig.json
Cached resolutions per containing directory. This assumes that any module id will have the same resolution for sibling files located in the same folder.
Cached resolutions per containing directory. This assumes that any module id will have the same resolution for sibling files located in the same folder.
Brand for a PropertyAccessExpression which, like a QualifiedName, consists of a sequence of identifiers separated by dots.
Brand for a PropertyAccessExpression which, like a QualifiedName, consists of a sequence of identifiers separated by dots.
Represents a bigint literal value without requiring bigint support
Represents a bigint literal value without requiring bigint support
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.
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.
A set of edits to make in response to a refactor action, plus an optional location where renaming should be invoked from
A set of edits to make in response to a refactor action, plus an optional location where renaming should be invoked from
Represents the result of module resolution. Module resolution will pick up tsx/jsx/js files even if '--jsx' and '--allowJs' are turned off. The Program will then filter results based on these flags.
Prefer to return a ResolvedModuleFull
so that the file type does not have to be inferred.
Represents the result of module resolution. Module resolution will pick up tsx/jsx/js files even if '--jsx' and '--allowJs' are turned off. The Program will then filter results based on these flags. Prefer to return a `ResolvedModuleFull` so that the file type does not have to be inferred.
ResolvedModule with an explicitly provided extension
property.
Prefer this over ResolvedModule
.
If changing this, remember to change moduleResolutionIsEqualTo
.
ResolvedModule with an explicitly provided `extension` property. Prefer this over `ResolvedModule`. If changing this, remember to change `moduleResolutionIsEqualTo`.
The builder that caches the semantic diagnostics for the program and handles the changed files and affected files
The builder that caches the semantic diagnostics for the program and handles the changed files and affected files
For when we encounter a semicolon in a class declaration. ES6 allows these as class elements.
For when we encounter a semicolon in a class declaration. ES6 allows these as class elements.
If a file is opened, the server will look for a tsconfig (or jsconfig) and if successful create a ConfiguredProject for it. Otherwise it will create an InferredProject.
If a file is opened, the server will look for a tsconfig (or jsconfig) and if successful create a ConfiguredProject for it. Otherwise it will create an InferredProject.
Project whose configuration is handled externally, such as in a '.csproj'.
These are created only if a host explicitly calls openExternalProject
.
Project whose configuration is handled externally, such as in a '.csproj'. These are created only if a host explicitly calls `openExternalProject`.
If a file is opened and no tsconfig (or jsconfig) is found, the file and its imports/references are put into an InferredProject.
If a file is opened and no tsconfig (or jsconfig) is found, the file and its imports/references are put into an InferredProject.
Info that we may send about a file that was just opened. Info about a file will only be sent once per session, even if the file changes in ways that might affect the info. Currently this is only sent for '.js' files.
Info that we may send about a file that was just opened. Info about a file will only be sent once per session, even if the file changes in ways that might affect the info. Currently this is only sent for '.js' files.
This will be converted to the payload of a protocol.TelemetryEvent in session.defaultEventHandler.
This will be converted to the payload of a protocol.TelemetryEvent in session.defaultEventHandler.
A set of one or more available refactoring actions, grouped under a parent refactoring.
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.
Request to get brace completion for a location in the file.
Argument for BraceCompletionRequest request.
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.
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.
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.
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.
Arguments for change request message.
Request to close external project.
Request to close external project.
Arguments to CloseExternalProjectRequest request
Arguments to CloseExternalProjectRequest request
Response to CloseExternalProjectRequest request. This is just an acknowledgement, so no body field is required.
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.
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.
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.
Request for the available codefixes at a specific position.
Instances of this interface specify errorcodes on a specific location in a sourcefile.
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.
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;
Response for CompileOnSaveAffectedFileListRequest request;
Contains a list of files that should be regenerated in a project
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.
Request to recompile the file. All generated outputs (.js, .d.ts or .js.map files) is written on disk.
Arguments for CompileOnSaveEmitFileRequest
Arguments for CompileOnSaveEmitFileRequest
A request to retrieve compiler options diagnostics for a project
A request to retrieve compiler options diagnostics for a project
Arguments for CompilerOptionsDiagnosticsRequest request.
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.
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.
Arguments for completion details request.
An item found in a completion response.
An item found in a completion response.
Additional completion entry details, available on demand
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.
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.
Arguments for completions messages.
Event message for "configFileDiag" event type. This event provides errors for a found config file.
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.
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.
Information found in a configure request.
Response to "configure" request. This is just an acknowledgement, so no body field is required.
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.
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.
Definition response message. Gives text range for definition.
Item of diagnostic information found in a DiagnosticEvent message.
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.
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 additional spans returned with a diagnostic which are relevant to it
Represents diagnostic info that includes location of diagnostic in two forms
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
Response to DocCommentTemplateRequest
Requests a JS Doc comment template for a given position
Requests a JS Doc comment template for a given position
Represents a set of highligh spans for a give name
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.
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.
Arguments in document highlight request; include: filesToSearch, file, line, offset.
Response for a DocumentHighlightsRequest request.
Response for a DocumentHighlightsRequest request.
A request to get encoded semantic classifications for a span in the file
A request to get encoded semantic classifications for a span in the file
Arguments for EncodedSemanticClassificationsRequest request.
Arguments for EncodedSemanticClassificationsRequest request.
The response for a EncodedSemanticClassificationsRequest
The response for a EncodedSemanticClassificationsRequest
Implementation response message. Gives series of text spans depending on the format ar.
Implementation response message. Gives series of text spans depending on the format ar.
Server-initiated event message
Server-initiated event message
Exit request; value of command field is "exit". Ask the server process to exit.
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.
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
Represent an external project
A request whose arguments specify a file location (file, line, col).
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.
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.
Request whose sole parameter is a file name.
Arguments for FileRequest messages.
Arguments for FileRequest messages.
Object found in response messages defining a span of text in a specific source file.
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.
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.
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.
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.
Arguments for format messages.
Format and format on key response message.
Format and format on key response message.
Request refactorings at a given position or selection area.
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 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.
Response for GetCodeFixes request.
Note: Paths may also be directories.
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
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.
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 request to get codes of supported code fixes.
A response for GetSupportedCodeFixesRequest request.
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.
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.
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.
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.
Arguments for geterr messages.
Span augmented with extra information that denotes the kind of the highlighting to be used for span.
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.
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.
Implementation response message. Gives text range for implementations.
A request to get indentation for a location in file
A request to get indentation for a location in file
Arguments for IndentationRequest request.
Arguments for IndentationRequest request.
Response for IndentationRequest request.
Response for IndentationRequest request.
Indentation result representing where indentation should be placed
Indentation result representing where indentation should be placed
A part of a symbol description that links from a jsdoc
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.
Location in source code expressed as (one-based) line and (one-based) column offset.
A TypeScript Server message
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.
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.
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
protocol.NavigationTree is identical to ts.NavigationTree, except using protocol.TextSpan instead of ts.TextSpan
An item found in a navto response.
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.
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.
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.
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
Request to open or update external project
Response to OpenExternalProjectRequest request. This is just an acknowledgement, so no body field is required.
Response to OpenExternalProjectRequest request. This is just an acknowledgement, so no body field is required.
Arguments to OpenExternalProjectsRequest
Arguments to OpenExternalProjectsRequest
Request to open multiple external projects
Request to open multiple external projects
Response to OpenExternalProjectsRequest request. This is just an acknowledgement, so no body field is required.
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.
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.
Information found in an "open" request.
Organize imports by:
Organize imports by: 1) Removing unused imports 2) Coalescing imports from the same module 3) Sorting imports
Request to obtain outlining spans in file.
Request to obtain outlining spans in file.
Response to OutliningSpansRequest request.
Response to OutliningSpansRequest request.
Represents a set of changes that happen in project
Represents a set of changes that happen in project
Response message body for "projectInfo" request
Response message body for "projectInfo" request
A request to get the project information of the current file.
A request to get the project information of the current file.
Arguments for ProjectInfoRequest request.
Arguments for ProjectInfoRequest request.
Response message for "projectInfo" 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 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.
Quickinfo response message.
Body of QuickInfoResponse.
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.
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.
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.
Response to "references" request.
The body of a "references" response message.
The body of a "references" response message.
Request to reload the project structure for all the opened files
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.
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.
Arguments for reload request.
Response to "reload" request. This is just an acknowledgement, so no body field is required.
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.
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.
Argument for RenameRequest request.
Rename response message.
Rename response message.
Client-initiated request message
Client-initiated request message
Event that is sent when server have finished processing request with specified id.
Event that is sent when server have finished processing request with specified id.
Response by server to client request message.
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.
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.
Arguments for saveto request.
Synchronous request for semantic diagnostics of one file.
Synchronous request for semantic diagnostics of one file.
Response object for synchronous sematic diagnostics request.
Response object for synchronous sematic diagnostics request.
Argument for SetCompilerOptionsForInferredProjectsRequest 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.
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.
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 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.
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.
Represents a single signature to show in signature help.
Signature help items found in the response of a signature help request.
Signature help items found in the response of a signature help request.
Signature help information for a single parameter
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.
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.
Arguments of a signature help request.
Response object for a SignatureHelpRequest.
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.
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 group of text spans, all in 'file'.
A request to determine if the caret is inside a comment.
A request to determine if the caret is inside a comment.
Response to StatusRequest
Response to StatusRequest
Part of a symbol description.
Part of a symbol description.
Synchronous request for syntactic diagnostics of one file.
Synchronous request for syntactic diagnostics of one file.
Response object for synchronous syntactic diagnostics request.
Response object for synchronous syntactic diagnostics request.
Object found in response messages defining a span of text in source code.
Object found in response messages defining a span of text in source code.
A request to get TODO comments from the file
A request to get TODO comments from the file
Arguments for TodoCommentRequest request.
Arguments for TodoCommentRequest request.
Response for TodoCommentRequest request.
Response for TodoCommentRequest request.
Go to type request; value of command field is "typeDefinition". Return response giving the file locations that define the type for the symbol found in file at location line, col.
Go to type request; value of command field is "typeDefinition". Return response giving the file locations that define the type for the symbol found in file at location line, col.
Definition response message. Gives text range for definition.
Definition response message. Gives text range for definition.
Request to synchronize list of open files with the client
Request to synchronize list of open files with the client
Arguments to UpdateOpenRequest
Arguments to UpdateOpenRequest
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 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.
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. The id is used for subsequent calls into the language service to ask questions about the signature help item in the context of any documents that have been updated. i.e. after an edit has happened, while signature help is still active, the host can ask important questions like 'what parameter is the user currently contained within?'.
Represents a single signature to show in signature help. The id is used for subsequent calls into the language service to ask questions about the signature help item in the context of any documents that have been updated. i.e. after an edit has happened, while signature help is still active, the host can ask important questions like 'what parameter is the user currently contained within?'.
Represents a set of signature help items, and the preferred item that should be selected.
Represents a set of signature help items, and the preferred item that should be selected.
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.
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.
Subset of properties from SourceFile that are used in multiple utility functions
Subset of properties from SourceFile that are used in multiple utility functions
Type references (ObjectFlags.Reference). When a class or interface has type parameters or a "this" type, references to the class or interface are made using type references. The typeArguments property specifies the types to substitute for the type parameters of the class or interface and optionally includes an extra element that specifies the type to substitute for "this" in the resulting instantiation. When no extra argument is present, the type reference itself is substituted for "this". The typeArguments property is undefined if the class or interface has no type parameters and the reference isn't specifying an explicit "this" argument.
Type references (ObjectFlags.Reference). When a class or interface has type parameters or a "this" type, references to the class or interface are made using type references. The typeArguments property specifies the types to substitute for the type parameters of the class or interface and optionally includes an extra element that specifies the type to substitute for "this" in the resulting instantiation. When no extra argument is present, the type reference itself is substituted for "this". The typeArguments property is undefined if the class or interface has no type parameters and the reference isn't specifying an explicit "this" argument.
Host to create watch with config file
Host to create watch with config file
Host to create watch with root files and options
Host to create watch with root files and options
Host that has watch functionality used in --watch mode
Host that has watch functionality used in --watch mode
Creates the watch what generates program using the config file
Creates the watch what generates program using the config file
Creates the watch that generates program using the root files and compiler options
Creates the watch that generates program using the root files and compiler options
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close