Logo Xantham

Proto Module

The schema is not ordered by dependency - `UpdateSnapshotParams` refers to `APIFileChanges`, which is declared far below it - so the module is recursive rather than reordered here. Reordering would diverge from the schema and break the next diff.

Types and nested modules

Type/Module Description

Method

Every method the server exposes. The comment on each records the parameter and result types the schema assigns it; `voption` marks a result the schema permits to be null.

APIFileChanges

APIFileChanges describes file changes to apply when updating a snapshot. Either InvalidateAll is true (discard all caches) or Changed/Created/Deleted list individual documents.

BatchRequest

BatchRequestsParams

BatchRequestsResponse

BatchResponse

CheckerNodeParams

CheckerNodeParams are parameters for checker methods that operate on a node location.

CheckerSignatureParams

CheckerSignatureParams are parameters for checker methods that operate on a signature.

CheckerSymbolParams

CheckerSymbolParams are parameters for checker methods that operate on a symbol.

CheckerTypeParams

CheckerTypeParams are parameters for checker methods that operate on a type.

CompilerOptions

CompilerOptions contains the compiler options exposed by the API.

CompletionEntryLabelDetailsResponse

CompletionEntryLabelDetailsResponse holds additional label display text for a completion entry.

CompletionEntryResponse

CompletionEntryResponse represents a single completion item.

CompletionInfoResponse

CompletionInfoResponse wraps a list of completion entries.

ConfigFileResponse

CreateProgramOldProgramParams

CreateProgramOptions

CreateProgramParams

CreateProgramResponse

DiagnosticPositionResponse

DiagnosticResponse

DiagnosticResponse is the API response for a single diagnostic.

DiagnosticSourceLineResponse

DocumentIdentifier

The schema types this as `string | { uri: string }` - either a path or a document URI - so it is a union here rather than a record with two optional halves. It needs `DocumentIdentifierConverter` to serialise, which `ProtoJson.options` registers; the converter cannot be attached here as an attribute because it is declared against this type and would close the dependency loop.

EmitOutputFile

EmitOutputResponse

EmitParams

EmitResponse

FormatNodeForInsertionParams

FormatNodeForInsertionParams are the parameters for the formatNodeForInsertion method.

GetBaseTypeOfLiteralTypeParams

GetBaseTypeOfLiteralTypeParams returns the base type of a literal type.

GetCompletionsAtPositionParams

GetCompletionsAtPositionParams are the parameters for the getCompletionsAtPosition method.

GetContextualTypeParams

GetContextualTypeParams returns the contextual type for a node.

GetDefaultProjectForFileParams

GetDiagnosticsParams

GetDiagnosticsParams are parameters for per-file diagnostic methods.

GetImportAdderEditsParams

GetIntrinsicTypeParams

GetIntrinsicTypeParams is used for intrinsic type getters (anyType, stringType, etc.).

GetMemberInModuleExportsParams

GetMemberInModuleExportsParams are parameters for getMemberInModuleExports.

GetParameterTypeParams

GetParameterTypeParams are the parameters for the getParameterType method.

GetProjectDiagnosticsParams

GetProjectDiagnosticsParams are parameters for project-wide diagnostic methods.

GetPropertyOfTypeParams

GetPropertyOfTypeParams are parameters for getPropertyOfType (a named property of a type).

GetReferencedSymbolsForNodeParams

GetReferencedSymbolsForNodeParams are the parameters for the getReferencedSymbolsForNode method.

GetReferencesToSymbolInFileParams

GetReferencesToSymbolInFileParams are the parameters for the getReferencesToSymbolInFile method.

GetResolvedSignatureParams

GetSignaturePropertyParams

GetSignaturePropertyParams is used for all signature sub-property endpoints.

GetSignatureUsagesParams

GetSignatureUsagesParams are the parameters for the getSignatureUsages method.

GetSignaturesOfTypeParams

GetSourceFileNamesParams

GetSourceFileParams

GetSymbolAtLocationParams

GetSymbolAtPositionParams

GetSymbolOfSourceFileParams

GetSymbolPropertyParams

GetSymbolPropertyParams is used for all symbol sub-property endpoints.

GetSymbolsAtLocationsParams

GetSymbolsAtPositionsParams

GetSymbolsInScopeParams

GetSymbolsInScopeParams are parameters for getSymbolsInScope, which returns all symbols visible at a given location.

GetSymbolsOfSourceFilesParams

GetTypeAtLocationParams

GetTypeAtLocationsParams

GetTypeAtPositionParams

GetTypeFromTypeNodeParams

GetTypeFromTypeNodeParams are the parameters for the getTypeFromTypeNode method.

GetTypeOfSymbolAtLocationParams

GetTypeOfSymbolAtLocationParams returns the narrowed type of a symbol at a specific location.

GetTypeOfSymbolParams

GetTypePropertyParams

GetTypePropertyParams is used for all type sub-property endpoints.

GetTypesAtPositionsParams

GetTypesOfSymbolsParams

GetWidenedTypeParams

GetWidenedTypeParams are the parameters for the getWidenedType method.

ImportAdderAction

IndexInfoResponse

IndexInfoResponse represents a single index signature.

InitializeResponse

InitializeResponse is returned by the initialize method.

IsArrayLikeTypeParams

IsArrayLikeTypeParams checks whether a type is array-like.

IsTypeAssignableToParams

IsTypeAssignableToParams checks assignability between two types.

JSDocTagInfo

JSDocTagInfo is a single JSDoc tag, mirroring Strada's JSDocTagInfo but with the tag text rendered as a plain string rather than SymbolDisplayPart[].

ParseCommandLineParams

ParseConfigFileParams

ParseJsonConfigFileContentParams

PrintNodeParams

PrintNodeParams are the parameters for the printNode method.

ProfileParams

ProfileResult

ProjectFileChanges

ProjectFileChanges describes what source files changed within a single project.

ProjectReference

Path is a normalized path on disk.

ProjectResponse

@deprecated Use parsedCommandLine.fileNames.

ReadConfigFileParams

ReadConfigFileResponse

ReferencedSymbolEntry

ReferencedSymbolEntry represents a symbol definition and its references.

ReleaseParams

ReleaseParams are the parameters for the release method.

ResolveNameParams

Optional: node handle for location context

SelectedFilesEmitParams

SignatureResponse

SignatureToSignatureDeclarationParams

SignatureToSignatureDeclarationParams are the parameters for the signatureToSignatureDeclaration method.

SignatureUsageResponse

SignatureUsageResponse represents a single usage of a signature as a name-call pair.

SnapshotChanges

SnapshotChanges describes what changed between the previous latest snapshot and the newly created snapshot. Changes are reported per-project so clients can track cache refs at the (snapshot, project) level.

SourceFileMetadata

SourceFileMetadata carries program-stored metadata about a single source file.

SourceFileResponse

SourceFileResponse contains the binary-encoded AST data for a source file. The Data field is base64-encoded binary data in the encoder's format.

SymbolResponse

Project is the project in which the symbol was first observed. It is the default project for follow-up lookups whose results can vary by project.

TextEdit

TranspileFromFileParams

TranspileOptions

TranspileOutputResponse

TranspileParams

TypeAcquisition

TypePredicateResponse

TypePredicateResponse is the response for getTypePredicateOfSignature.

TypeResponse

Value is literal type data. BigInt literals are encoded as signed decimal strings because JSON cannot represent bigint; absent values are null.

TypeToTypeNodeParams

TypeToTypeNodeParams are the parameters for the typeToTypeNode method.

UpdateSnapshotParams

UpdateSnapshotParams are the parameters for creating a new snapshot. All fields are optional. With no fields set, the server adopts the latest LSP state.

UpdateSnapshotResponse

UpdateSnapshotResponse is returned by updateSnapshot.

UpdateTemporarySnapshotParams

UpdateTemporarySnapshotParams are the parameters for creating a temporary snapshot that overrides a single file's content.

WellKnownSignaturesResponse

WellKnownSignaturesResponse carries the handle id of the per-checker singleton unknown signature (the signature the checker yields when a call cannot be resolved) so the client can identify it by id without a round-trip on every check.

WellKnownSymbolsResponse

WellKnownSymbolsResponse carries the handle ids of the per-checker singleton symbols (unknown, undefined, arguments) so the client can identify them by id without a round-trip on every check.

Type something to start searching.