Method Module
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.
Functions and values
| Function or value |
Description
|
Full Usage:
Method.BatchRequests
Returns: string
|
`BatchRequestsParams` -> `BatchRequestsResponse`
|
Full Usage:
Method.CreateProgram
Returns: string
|
`CreateProgramParams` -> `CreateProgramResponse`
|
Full Usage:
Method.Emit
Returns: string
|
`EmitParams` -> `EmitResponse`
|
Full Usage:
Method.EmitToString
Returns: string
|
`EmitParams` -> `EmitOutputResponse`
|
Full Usage:
Method.FormatNodeForInsertion
Returns: string
|
`FormatNodeForInsertionParams` -> `string`
|
Full Usage:
Method.GetAliasSymbolOfType
Returns: string
|
`GetTypePropertyParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetAliasTypeArgumentsOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse[] voption`
|
Full Usage:
Method.GetAliasedSymbol
Returns: string
|
`CheckerSymbolParams` -> `SymbolResponse`
|
Full Usage:
Method.GetAnyType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetApparentPropertiesOfType
Returns: string
|
`GetTypePropertyParams` -> `SymbolResponse[]`
|
Full Usage:
Method.GetApparentType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetBaseConstraintOfType
Returns: string
|
`CheckerTypeParams` -> `TypeResponse voption`
|
Full Usage:
Method.GetBaseTypeOfLiteralType
Returns: string
|
`GetBaseTypeOfLiteralTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetBaseTypeOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetBaseTypes
Returns: string
|
`CheckerTypeParams` -> `TypeResponse[] voption`
|
Full Usage:
Method.GetBigIntType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetBindDiagnostics
Returns: string
|
`GetDiagnosticsParams` -> `DiagnosticResponse[] voption`
|
Full Usage:
Method.GetBooleanType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetCheckTypeOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetCompletionsAtPosition
Returns: string
|
`GetCompletionsAtPositionParams` -> `CompletionInfoResponse voption`
|
Full Usage:
Method.GetConfigFileNames
Returns: string
|
`GetProjectDiagnosticsParams` -> `string[] voption`
|
Full Usage:
Method.GetConfigFileParsingDiagnostics
Returns: string
|
`GetProjectDiagnosticsParams` -> `DiagnosticResponse[] voption`
|
Full Usage:
Method.GetConfigSourceFile
Returns: string
|
`GetSourceFileParams` -> `SourceFileResponse voption`
|
Full Usage:
Method.GetConstantValue
Returns: string
|
`CheckerNodeParams` -> `JsonNode voption`
|
Full Usage:
Method.GetConstraintOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetConstraintOfTypeParameter
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse voption`
|
Full Usage:
Method.GetContextualType
Returns: string
|
`GetContextualTypeParams` -> `TypeResponse voption`
|
Full Usage:
Method.GetDeclarationDiagnostics
Returns: string
|
`GetDiagnosticsParams` -> `DiagnosticResponse[] voption`
|
Full Usage:
Method.GetDeclarationEmit
Returns: string
|
`SelectedFilesEmitParams` -> `EmitOutputResponse`
|
Full Usage:
Method.GetDeclaredTypeOfSymbol
Returns: string
|
`GetTypeOfSymbolParams` -> `TypeResponse`
|
Full Usage:
Method.GetDefaultFromTypeParameter
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse voption`
|
Full Usage:
Method.GetDefaultProjectForFile
Returns: string
|
`GetDefaultProjectForFileParams` -> `ProjectResponse voption`
|
Full Usage:
Method.GetDocumentationComment
Returns: string
|
`CheckerSymbolParams` -> `string`
|
Full Usage:
Method.GetESSymbolType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetExportSpecifierLocalTargetSymbol
Returns: string
|
`CheckerNodeParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetExportSymbolOfSymbol
Returns: string
|
`GetSymbolPropertyParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetExportsOfModule
Returns: string
|
`CheckerSymbolParams` -> `SymbolResponse[] voption`
|
Full Usage:
Method.GetExportsOfSymbol
Returns: string
|
`GetSymbolPropertyParams` -> `SymbolResponse[] voption`
|
Full Usage:
Method.GetExtendsTypeOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetFalseTypeOfConditionalType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetFreshTypeOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse voption`
|
Full Usage:
Method.GetFullyQualifiedName
Returns: string
|
`CheckerSymbolParams` -> `string`
|
Full Usage:
Method.GetGlobalDiagnostics
Returns: string
|
`GetProjectDiagnosticsParams` -> `DiagnosticResponse[] voption`
|
Full Usage:
Method.GetImmediateAliasedSymbol
Returns: string
|
`CheckerSymbolParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetImportAdderEdits
Returns: string
|
`GetImportAdderEditsParams` -> `TextEdit[]`
|
Full Usage:
Method.GetIndexInfosOfType
Returns: string
|
`CheckerTypeParams` -> `IndexInfoResponse[] voption`
|
Full Usage:
Method.GetIndexTypeOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetJavaScriptEmit
Returns: string
|
`SelectedFilesEmitParams` -> `EmitOutputResponse`
|
Full Usage:
Method.GetJsDocTags
Returns: string
|
`CheckerSymbolParams` -> `JSDocTagInfo[] voption`
|
Full Usage:
Method.GetLocalTypeParametersOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse[] voption`
|
Full Usage:
Method.GetMemberInModuleExports
Returns: string
|
`GetMemberInModuleExportsParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetMembersOfSymbol
Returns: string
|
`GetSymbolPropertyParams` -> `SymbolResponse[] voption`
|
Full Usage:
Method.GetNeverType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetNonMissingTypeOfSymbol
Returns: string
|
`GetTypeOfSymbolParams` -> `TypeResponse`
|
Full Usage:
Method.GetNonNullableType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetNonPrimitiveType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetNullType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetNumberType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetObjectTypeOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetOuterTypeParametersOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse[] voption`
|
Full Usage:
Method.GetParameterType
Returns: string
|
`GetParameterTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetParametersOfSignature
Returns: string
|
`GetSignaturePropertyParams` -> `SymbolResponse[] voption`
|
Full Usage:
Method.GetParentOfSymbol
Returns: string
|
`GetSymbolPropertyParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetProgramDiagnostics
Returns: string
|
`GetProjectDiagnosticsParams` -> `DiagnosticResponse[] voption`
|
Full Usage:
Method.GetPropertiesOfType
Returns: string
|
`CheckerTypeParams` -> `SymbolResponse[] voption`
|
Full Usage:
Method.GetPropertyOfType
Returns: string
|
`GetPropertyOfTypeParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetReducedType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetReferencedSymbolsForNode
Returns: string
|
`GetReferencedSymbolsForNodeParams` -> `ReferencedSymbolEntry[] voption`
|
Full Usage:
Method.GetReferencesToSymbolInFile
Returns: string
|
`GetReferencesToSymbolInFileParams` -> `string[]`
|
Full Usage:
Method.GetRegularTypeOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse voption`
|
Full Usage:
Method.GetResolvedSignature
Returns: string
|
`GetResolvedSignatureParams` -> `SignatureResponse`
|
Full Usage:
Method.GetRestTypeOfSignature
Returns: string
|
`CheckerSignatureParams` -> `TypeResponse`
|
Full Usage:
Method.GetReturnTypeOfSignature
Returns: string
|
`GetSignaturePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetSemanticDiagnostics
Returns: string
|
`GetDiagnosticsParams` -> `DiagnosticResponse[] voption`
|
Full Usage:
Method.GetShorthandAssignmentValueSymbol
Returns: string
|
`GetTypeAtLocationParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetSignatureFromDeclaration
Returns: string
|
`CheckerNodeParams` -> `SignatureResponse`
|
Full Usage:
Method.GetSignatureUsages
Returns: string
|
`GetSignatureUsagesParams` -> `SignatureUsageResponse[] voption`
|
Full Usage:
Method.GetSignaturesOfType
Returns: string
|
`GetSignaturesOfTypeParams` -> `SignatureResponse[]`
|
Full Usage:
Method.GetSourceFile
Returns: string
|
`GetSourceFileParams` -> `SourceFileResponse voption`
|
Full Usage:
Method.GetSourceFileMetadata
Returns: string
|
`GetSourceFileParams` -> `SourceFileMetadata voption`
|
Full Usage:
Method.GetSourceFileNames
Returns: string
|
`GetSourceFileNamesParams` -> `string[]`
|
Full Usage:
Method.GetStringType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetSuggestionDiagnostics
Returns: string
|
`GetDiagnosticsParams` -> `DiagnosticResponse[] voption`
|
Full Usage:
Method.GetSymbolAtLocation
Returns: string
|
`GetSymbolAtLocationParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetSymbolAtPosition
Returns: string
|
`GetSymbolAtPositionParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetSymbolOfSourceFile
Returns: string
|
`GetSymbolOfSourceFileParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetSymbolOfType
Returns: string
|
`GetTypePropertyParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetSymbolsAtLocations
Returns: string
|
`GetSymbolsAtLocationsParams` -> `SymbolResponse[]`
|
Full Usage:
Method.GetSymbolsAtPositions
Returns: string
|
`GetSymbolsAtPositionsParams` -> `SymbolResponse[]`
|
Full Usage:
Method.GetSymbolsInScope
Returns: string
|
`GetSymbolsInScopeParams` -> `SymbolResponse[]`
|
Full Usage:
Method.GetSymbolsOfSourceFiles
Returns: string
|
`GetSymbolsOfSourceFilesParams` -> `SymbolResponse[]`
|
Full Usage:
Method.GetSyntacticDiagnostics
Returns: string
|
`GetDiagnosticsParams` -> `DiagnosticResponse[] voption`
|
Full Usage:
Method.GetTargetOfSignature
Returns: string
|
`GetSignaturePropertyParams` -> `SignatureResponse voption`
|
Full Usage:
Method.GetTargetOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetTargetSymbol
Returns: string
|
`CheckerSymbolParams` -> `SymbolResponse`
|
Full Usage:
Method.GetThisParameterOfSignature
Returns: string
|
`GetSignaturePropertyParams` -> `SymbolResponse voption`
|
Full Usage:
Method.GetTrueTypeOfConditionalType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse`
|
Full Usage:
Method.GetTypeArguments
Returns: string
|
`CheckerTypeParams` -> `TypeResponse[] voption`
|
Full Usage:
Method.GetTypeAtLocation
Returns: string
|
`GetTypeAtLocationParams` -> `TypeResponse`
|
Full Usage:
Method.GetTypeAtLocations
Returns: string
|
`GetTypeAtLocationsParams` -> `TypeResponse[]`
|
Full Usage:
Method.GetTypeAtPosition
Returns: string
|
`GetTypeAtPositionParams` -> `TypeResponse voption`
|
Full Usage:
Method.GetTypeFromTypeNode
Returns: string
|
`GetTypeFromTypeNodeParams` -> `TypeResponse`
|
Full Usage:
Method.GetTypeOfSymbol
Returns: string
|
`GetTypeOfSymbolParams` -> `TypeResponse`
|
Full Usage:
Method.GetTypeOfSymbolAtLocation
Returns: string
|
`GetTypeOfSymbolAtLocationParams` -> `TypeResponse`
|
Full Usage:
Method.GetTypeParameterAtPosition
Returns: string
|
`GetParameterTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetTypeParametersOfSignature
Returns: string
|
`GetSignaturePropertyParams` -> `TypeResponse[] voption`
|
Full Usage:
Method.GetTypeParametersOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse[] voption`
|
Full Usage:
Method.GetTypePredicateOfSignature
Returns: string
|
`CheckerSignatureParams` -> `TypePredicateResponse voption`
|
Full Usage:
Method.GetTypesAtPositions
Returns: string
|
`GetTypesAtPositionsParams` -> `TypeResponse[]`
|
Full Usage:
Method.GetTypesOfSymbols
Returns: string
|
`GetTypesOfSymbolsParams` -> `TypeResponse[]`
|
Full Usage:
Method.GetTypesOfType
Returns: string
|
`GetTypePropertyParams` -> `TypeResponse[] voption`
|
Full Usage:
Method.GetUndefinedType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetUnknownType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetVoidType
Returns: string
|
`GetIntrinsicTypeParams` -> `TypeResponse`
|
Full Usage:
Method.GetWellKnownSignatures
Returns: string
|
`GetIntrinsicTypeParams` -> `WellKnownSignaturesResponse`
|
Full Usage:
Method.GetWellKnownSymbols
Returns: string
|
`GetIntrinsicTypeParams` -> `WellKnownSymbolsResponse`
|
Full Usage:
Method.GetWidenedType
Returns: string
|
`GetWidenedTypeParams` -> `TypeResponse`
|
Full Usage:
Method.Initialize
Returns: string
|
`unit` -> `InitializeResponse`
|
Full Usage:
Method.IsArrayLikeType
Returns: string
|
`IsArrayLikeTypeParams` -> `bool`
|
Full Usage:
Method.IsArrayType
Returns: string
|
`CheckerTypeParams` -> `bool`
|
Full Usage:
Method.IsContextSensitive
Returns: string
|
`GetContextualTypeParams` -> `bool`
|
Full Usage:
Method.IsReadonlySymbol
Returns: string
|
`CheckerSymbolParams` -> `bool`
|
Full Usage:
Method.IsTypeAssignableTo
Returns: string
|
`IsTypeAssignableToParams` -> `bool`
|
Full Usage:
Method.ParseCommandLine
Returns: string
|
`ParseCommandLineParams` -> `ConfigFileResponse`
|
Full Usage:
Method.ParseConfigFile
Returns: string
|
`ParseConfigFileParams` -> `ConfigFileResponse`
|
Full Usage:
Method.ParseJsonConfigFileContent
Returns: string
|
`ParseJsonConfigFileContentParams` -> `ConfigFileResponse`
|
Full Usage:
Method.PrintNode
Returns: string
|
`PrintNodeParams` -> `string`
|
Full Usage:
Method.ReadConfigFile
Returns: string
|
`ReadConfigFileParams` -> `ReadConfigFileResponse`
|
Full Usage:
Method.Release
Returns: string
|
`ReleaseParams` -> `unit`
|
Full Usage:
Method.ResolveName
Returns: string
|
`ResolveNameParams` -> `SymbolResponse voption`
|
Full Usage:
Method.SaveHeapProfile
Returns: string
|
`ProfileParams` -> `ProfileResult`
|
Full Usage:
Method.SignatureToSignatureDeclaration
Returns: string
|
`SignatureToSignatureDeclarationParams` -> `SourceFileResponse voption`
|
Full Usage:
Method.StartCPUProfile
Returns: string
|
`ProfileParams` -> `unit`
|
Full Usage:
Method.StopCPUProfile
Returns: string
|
`unit` -> `ProfileResult`
|
Full Usage:
Method.TranspileDeclaration
Returns: string
|
`TranspileParams` -> `TranspileOutputResponse`
|
Full Usage:
Method.TranspileDeclarationFromFile
Returns: string
|
`TranspileFromFileParams` -> `TranspileOutputResponse`
|
Full Usage:
Method.TranspileModule
Returns: string
|
`TranspileParams` -> `TranspileOutputResponse`
|
Full Usage:
Method.TranspileModuleFromFile
Returns: string
|
`TranspileFromFileParams` -> `TranspileOutputResponse`
|
Full Usage:
Method.TypeToString
Returns: string
|
`TypeToTypeNodeParams` -> `JsonNode voption`
|
Full Usage:
Method.TypeToTypeNode
Returns: string
|
`TypeToTypeNodeParams` -> `SourceFileResponse voption`
|
Full Usage:
Method.UpdateSnapshot
Returns: string
|
`UpdateSnapshotParams` -> `UpdateSnapshotResponse`
|
Full Usage:
Method.UpdateTemporarySnapshot
Returns: string
|
`UpdateTemporarySnapshotParams` -> `UpdateSnapshotResponse`
|
|
The methods whose result is binary rather than JSON - the AST blob. The transport returns those bytes raw for a request sent on its own, but a batch response is JSON and cannot carry them, so inside a batch the same result arrives as a base64 string instead. `TscMailbox` needs to know which methods that applies to in order to hand callers the same bytes either way.
|