Api Module
One function per server method, each taking the channel and the method's parameter record. Naming follows the wire: `getSymbolAtPosition` is `Api.getSymbolAtPosition`. Results the schema permits to be null are `voption`; the rest raise if the server sends nothing, since a missing field on a request is otherwise indistinguishable from a legitimate empty answer.
Functions and values
| Function or value |
Description
|
Full Usage:
Api.batchRequests channel parameters
Parameters:
TscChannel
parameters : BatchRequestsParams
Returns: BatchRequestsResponse
|
|
Full Usage:
Api.createProgram channel parameters
Parameters:
TscChannel
parameters : CreateProgramParams
Returns: CreateProgramResponse
|
|
Full Usage:
Api.emit channel parameters
Parameters:
TscChannel
parameters : EmitParams
Returns: EmitResponse
|
|
Full Usage:
Api.emitToString channel parameters
Parameters:
TscChannel
parameters : EmitParams
Returns: EmitOutputResponse
|
|
Full Usage:
Api.formatNodeForInsertion channel parameters
Parameters:
TscChannel
parameters : FormatNodeForInsertionParams
Returns: string
|
|
Full Usage:
Api.getAliasSymbolOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getAliasTypeArgumentsOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse[] voption
|
|
Full Usage:
Api.getAliasedSymbol channel parameters
Parameters:
TscChannel
parameters : CheckerSymbolParams
Returns: SymbolResponse
|
|
Full Usage:
Api.getAnyType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getApparentPropertiesOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: SymbolResponse[]
|
|
Full Usage:
Api.getApparentType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getBaseConstraintOfType channel parameters
Parameters:
TscChannel
parameters : CheckerTypeParams
Returns: TypeResponse voption
|
|
Full Usage:
Api.getBaseTypeOfLiteralType channel parameters
Parameters:
TscChannel
parameters : GetBaseTypeOfLiteralTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getBaseTypeOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getBaseTypes channel parameters
Parameters:
TscChannel
parameters : CheckerTypeParams
Returns: TypeResponse[] voption
|
|
Full Usage:
Api.getBigIntType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getBindDiagnostics channel parameters
Parameters:
TscChannel
parameters : GetDiagnosticsParams
Returns: DiagnosticResponse[] voption
|
|
Full Usage:
Api.getBooleanType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getCheckTypeOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getCompletionsAtPosition channel parameters
Parameters:
TscChannel
parameters : GetCompletionsAtPositionParams
Returns: CompletionInfoResponse voption
|
|
Full Usage:
Api.getConfigFileNames channel parameters
Parameters:
TscChannel
parameters : GetProjectDiagnosticsParams
Returns: string[] voption
|
|
Full Usage:
Api.getConfigFileParsingDiagnostics channel parameters
Parameters:
TscChannel
parameters : GetProjectDiagnosticsParams
Returns: DiagnosticResponse[] voption
|
|
Full Usage:
Api.getConfigSourceFile channel parameters
Parameters:
TscChannel
parameters : GetSourceFileParams
Returns: SourceFile voption
|
Returns the raw binary AST, not the schema's `SourceFileResponse` JSON envelope - see `ProtoJson.requestAst`.
|
Full Usage:
Api.getConstantValue channel parameters
Parameters:
TscChannel
parameters : CheckerNodeParams
Returns: JsonNode voption
|
|
Full Usage:
Api.getConstraintOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getConstraintOfTypeParameter channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse voption
|
|
Full Usage:
Api.getContextualType channel parameters
Parameters:
TscChannel
parameters : GetContextualTypeParams
Returns: TypeResponse voption
|
|
Full Usage:
Api.getDeclarationDiagnostics channel parameters
Parameters:
TscChannel
parameters : GetDiagnosticsParams
Returns: DiagnosticResponse[] voption
|
|
Full Usage:
Api.getDeclarationEmit channel parameters
Parameters:
TscChannel
parameters : SelectedFilesEmitParams
Returns: EmitOutputResponse
|
|
Full Usage:
Api.getDeclaredTypeOfSymbol channel parameters
Parameters:
TscChannel
parameters : GetTypeOfSymbolParams
Returns: TypeResponse
|
|
Full Usage:
Api.getDefaultFromTypeParameter channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse voption
|
|
Full Usage:
Api.getDefaultProjectForFile channel parameters
Parameters:
TscChannel
parameters : GetDefaultProjectForFileParams
Returns: ProjectResponse voption
|
|
Full Usage:
Api.getDocumentationComment channel parameters
Parameters:
TscChannel
parameters : CheckerSymbolParams
Returns: string
|
|
Full Usage:
Api.getESSymbolType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getExportSpecifierLocalTargetSymbol channel parameters
Parameters:
TscChannel
parameters : CheckerNodeParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getExportSymbolOfSymbol channel parameters
Parameters:
TscChannel
parameters : GetSymbolPropertyParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getExportsOfModule channel parameters
Parameters:
TscChannel
parameters : CheckerSymbolParams
Returns: SymbolResponse[] voption
|
|
Full Usage:
Api.getExportsOfSymbol channel parameters
Parameters:
TscChannel
parameters : GetSymbolPropertyParams
Returns: SymbolResponse[] voption
|
|
Full Usage:
Api.getExtendsTypeOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getFalseTypeOfConditionalType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getFreshTypeOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse voption
|
|
Full Usage:
Api.getFullyQualifiedName channel parameters
Parameters:
TscChannel
parameters : CheckerSymbolParams
Returns: string
|
|
Full Usage:
Api.getGlobalDiagnostics channel parameters
Parameters:
TscChannel
parameters : GetProjectDiagnosticsParams
Returns: DiagnosticResponse[] voption
|
|
Full Usage:
Api.getImmediateAliasedSymbol channel parameters
Parameters:
TscChannel
parameters : CheckerSymbolParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getImportAdderEdits channel parameters
Parameters:
TscChannel
parameters : GetImportAdderEditsParams
Returns: TextEdit[]
|
|
Full Usage:
Api.getIndexInfosOfType channel parameters
Parameters:
TscChannel
parameters : CheckerTypeParams
Returns: IndexInfoResponse[] voption
|
|
Full Usage:
Api.getIndexTypeOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getJavaScriptEmit channel parameters
Parameters:
TscChannel
parameters : SelectedFilesEmitParams
Returns: EmitOutputResponse
|
|
Full Usage:
Api.getJsDocTags channel parameters
Parameters:
TscChannel
parameters : CheckerSymbolParams
Returns: JSDocTagInfo[] voption
|
|
Full Usage:
Api.getLocalTypeParametersOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse[] voption
|
|
Full Usage:
Api.getMemberInModuleExports channel parameters
Parameters:
TscChannel
parameters : GetMemberInModuleExportsParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getMembersOfSymbol channel parameters
Parameters:
TscChannel
parameters : GetSymbolPropertyParams
Returns: SymbolResponse[] voption
|
|
Full Usage:
Api.getNeverType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getNonMissingTypeOfSymbol channel parameters
Parameters:
TscChannel
parameters : GetTypeOfSymbolParams
Returns: TypeResponse
|
|
Full Usage:
Api.getNonNullableType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getNonPrimitiveType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getNullType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getNumberType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getObjectTypeOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getOuterTypeParametersOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse[] voption
|
|
Full Usage:
Api.getParameterType channel parameters
Parameters:
TscChannel
parameters : GetParameterTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getParametersOfSignature channel parameters
Parameters:
TscChannel
parameters : GetSignaturePropertyParams
Returns: SymbolResponse[] voption
|
|
Full Usage:
Api.getParentOfSymbol channel parameters
Parameters:
TscChannel
parameters : GetSymbolPropertyParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getProgramDiagnostics channel parameters
Parameters:
TscChannel
parameters : GetProjectDiagnosticsParams
Returns: DiagnosticResponse[] voption
|
|
Full Usage:
Api.getPropertiesOfType channel parameters
Parameters:
TscChannel
parameters : CheckerTypeParams
Returns: SymbolResponse[] voption
|
|
Full Usage:
Api.getPropertyOfType channel parameters
Parameters:
TscChannel
parameters : GetPropertyOfTypeParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getReducedType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getReferencedSymbolsForNode channel parameters
Parameters:
TscChannel
parameters : GetReferencedSymbolsForNodeParams
Returns: ReferencedSymbolEntry[] voption
|
|
Full Usage:
Api.getReferencesToSymbolInFile channel parameters
Parameters:
TscChannel
parameters : GetReferencesToSymbolInFileParams
Returns: string[]
|
|
Full Usage:
Api.getRegularTypeOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse voption
|
|
Full Usage:
Api.getResolvedSignature channel parameters
Parameters:
TscChannel
parameters : GetResolvedSignatureParams
Returns: SignatureResponse
|
|
Full Usage:
Api.getRestTypeOfSignature channel parameters
Parameters:
TscChannel
parameters : CheckerSignatureParams
Returns: TypeResponse
|
|
Full Usage:
Api.getReturnTypeOfSignature channel parameters
Parameters:
TscChannel
parameters : GetSignaturePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getSemanticDiagnostics channel parameters
Parameters:
TscChannel
parameters : GetDiagnosticsParams
Returns: DiagnosticResponse[] voption
|
|
Full Usage:
Api.getShorthandAssignmentValueSymbol channel parameters
Parameters:
TscChannel
parameters : GetTypeAtLocationParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getSignatureFromDeclaration channel parameters
Parameters:
TscChannel
parameters : CheckerNodeParams
Returns: SignatureResponse
|
|
Full Usage:
Api.getSignatureUsages channel parameters
Parameters:
TscChannel
parameters : GetSignatureUsagesParams
Returns: SignatureUsageResponse[] voption
|
|
Full Usage:
Api.getSignaturesOfType channel parameters
Parameters:
TscChannel
parameters : GetSignaturesOfTypeParams
Returns: SignatureResponse[]
|
|
Full Usage:
Api.getSourceFile channel parameters
Parameters:
TscChannel
parameters : GetSourceFileParams
Returns: SourceFile voption
|
Returns the raw binary AST, not the schema's `SourceFileResponse` JSON envelope - see `ProtoJson.requestAst`.
|
Full Usage:
Api.getSourceFileMetadata channel parameters
Parameters:
TscChannel
parameters : GetSourceFileParams
Returns: SourceFileMetadata voption
|
|
Full Usage:
Api.getSourceFileNames channel parameters
Parameters:
TscChannel
parameters : GetSourceFileNamesParams
Returns: string[]
|
|
Full Usage:
Api.getStringType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getSuggestionDiagnostics channel parameters
Parameters:
TscChannel
parameters : GetDiagnosticsParams
Returns: DiagnosticResponse[] voption
|
|
Full Usage:
Api.getSymbolAtLocation channel parameters
Parameters:
TscChannel
parameters : GetSymbolAtLocationParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getSymbolAtPosition channel parameters
Parameters:
TscChannel
parameters : GetSymbolAtPositionParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getSymbolOfSourceFile channel parameters
Parameters:
TscChannel
parameters : GetSymbolOfSourceFileParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getSymbolOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getSymbolsAtLocations channel parameters
Parameters:
TscChannel
parameters : GetSymbolsAtLocationsParams
Returns: SymbolResponse[]
|
|
Full Usage:
Api.getSymbolsAtPositions channel parameters
Parameters:
TscChannel
parameters : GetSymbolsAtPositionsParams
Returns: SymbolResponse[]
|
|
Full Usage:
Api.getSymbolsInScope channel parameters
Parameters:
TscChannel
parameters : GetSymbolsInScopeParams
Returns: SymbolResponse[]
|
|
Full Usage:
Api.getSymbolsOfSourceFiles channel parameters
Parameters:
TscChannel
parameters : GetSymbolsOfSourceFilesParams
Returns: SymbolResponse[]
|
|
Full Usage:
Api.getSyntacticDiagnostics channel parameters
Parameters:
TscChannel
parameters : GetDiagnosticsParams
Returns: DiagnosticResponse[] voption
|
|
Full Usage:
Api.getTargetOfSignature channel parameters
Parameters:
TscChannel
parameters : GetSignaturePropertyParams
Returns: SignatureResponse voption
|
|
Full Usage:
Api.getTargetOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getTargetSymbol channel parameters
Parameters:
TscChannel
parameters : CheckerSymbolParams
Returns: SymbolResponse
|
|
Full Usage:
Api.getThisParameterOfSignature channel parameters
Parameters:
TscChannel
parameters : GetSignaturePropertyParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.getTrueTypeOfConditionalType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse
|
|
Full Usage:
Api.getTypeArguments channel parameters
Parameters:
TscChannel
parameters : CheckerTypeParams
Returns: TypeResponse[] voption
|
|
Full Usage:
Api.getTypeAtLocation channel parameters
Parameters:
TscChannel
parameters : GetTypeAtLocationParams
Returns: TypeResponse
|
|
Full Usage:
Api.getTypeAtLocations channel parameters
Parameters:
TscChannel
parameters : GetTypeAtLocationsParams
Returns: TypeResponse[]
|
|
Full Usage:
Api.getTypeAtPosition channel parameters
Parameters:
TscChannel
parameters : GetTypeAtPositionParams
Returns: TypeResponse voption
|
|
Full Usage:
Api.getTypeFromTypeNode channel parameters
Parameters:
TscChannel
parameters : GetTypeFromTypeNodeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getTypeOfSymbol channel parameters
Parameters:
TscChannel
parameters : GetTypeOfSymbolParams
Returns: TypeResponse
|
|
Full Usage:
Api.getTypeOfSymbolAtLocation channel parameters
Parameters:
TscChannel
parameters : GetTypeOfSymbolAtLocationParams
Returns: TypeResponse
|
|
Full Usage:
Api.getTypeParameterAtPosition channel parameters
Parameters:
TscChannel
parameters : GetParameterTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getTypeParametersOfSignature channel parameters
Parameters:
TscChannel
parameters : GetSignaturePropertyParams
Returns: TypeResponse[] voption
|
|
Full Usage:
Api.getTypeParametersOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse[] voption
|
|
Full Usage:
Api.getTypePredicateOfSignature channel parameters
Parameters:
TscChannel
parameters : CheckerSignatureParams
Returns: TypePredicateResponse voption
|
|
Full Usage:
Api.getTypesAtPositions channel parameters
Parameters:
TscChannel
parameters : GetTypesAtPositionsParams
Returns: TypeResponse[]
|
|
Full Usage:
Api.getTypesOfSymbols channel parameters
Parameters:
TscChannel
parameters : GetTypesOfSymbolsParams
Returns: TypeResponse[]
|
|
Full Usage:
Api.getTypesOfType channel parameters
Parameters:
TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse[] voption
|
|
Full Usage:
Api.getUndefinedType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getUnknownType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getVoidType channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse
|
|
Full Usage:
Api.getWellKnownSignatures channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: WellKnownSignaturesResponse
|
|
Full Usage:
Api.getWellKnownSymbols channel parameters
Parameters:
TscChannel
parameters : GetIntrinsicTypeParams
Returns: WellKnownSymbolsResponse
|
|
Full Usage:
Api.getWidenedType channel parameters
Parameters:
TscChannel
parameters : GetWidenedTypeParams
Returns: TypeResponse
|
|
|
|
Full Usage:
Api.isArrayLikeType channel parameters
Parameters:
TscChannel
parameters : IsArrayLikeTypeParams
Returns: bool
|
|
Full Usage:
Api.isArrayType channel parameters
Parameters:
TscChannel
parameters : CheckerTypeParams
Returns: bool
|
|
Full Usage:
Api.isContextSensitive channel parameters
Parameters:
TscChannel
parameters : GetContextualTypeParams
Returns: bool
|
|
Full Usage:
Api.isReadonlySymbol channel parameters
Parameters:
TscChannel
parameters : CheckerSymbolParams
Returns: bool
|
|
Full Usage:
Api.isTypeAssignableTo channel parameters
Parameters:
TscChannel
parameters : IsTypeAssignableToParams
Returns: bool
|
|
Full Usage:
Api.parseCommandLine channel parameters
Parameters:
TscChannel
parameters : ParseCommandLineParams
Returns: ConfigFileResponse
|
|
Full Usage:
Api.parseConfigFile channel parameters
Parameters:
TscChannel
parameters : ParseConfigFileParams
Returns: ConfigFileResponse
|
|
Full Usage:
Api.parseJsonConfigFileContent channel parameters
Parameters:
TscChannel
parameters : ParseJsonConfigFileContentParams
Returns: ConfigFileResponse
|
|
Full Usage:
Api.printNode channel parameters
Parameters:
TscChannel
parameters : PrintNodeParams
Returns: string
|
|
Full Usage:
Api.readConfigFile channel parameters
Parameters:
TscChannel
parameters : ReadConfigFileParams
Returns: ReadConfigFileResponse
|
|
Full Usage:
Api.release channel parameters
Parameters:
TscChannel
parameters : ReleaseParams
|
|
Full Usage:
Api.resolveName channel parameters
Parameters:
TscChannel
parameters : ResolveNameParams
Returns: SymbolResponse voption
|
|
Full Usage:
Api.saveHeapProfile channel parameters
Parameters:
TscChannel
parameters : ProfileParams
Returns: ProfileResult
|
|
Full Usage:
Api.signatureToSignatureDeclaration channel parameters
Parameters:
TscChannel
parameters : SignatureToSignatureDeclarationParams
Returns: SourceFile voption
|
Returns the raw binary AST, not the schema's `SourceFileResponse` JSON envelope - see `ProtoJson.requestAst`.
|
Full Usage:
Api.startCPUProfile channel parameters
Parameters:
TscChannel
parameters : ProfileParams
|
|
|
|
Full Usage:
Api.transpileDeclaration channel parameters
Parameters:
TscChannel
parameters : TranspileParams
Returns: TranspileOutputResponse
|
|
Full Usage:
Api.transpileDeclarationFromFile channel parameters
Parameters:
TscChannel
parameters : TranspileFromFileParams
Returns: TranspileOutputResponse
|
|
Full Usage:
Api.transpileModule channel parameters
Parameters:
TscChannel
parameters : TranspileParams
Returns: TranspileOutputResponse
|
|
Full Usage:
Api.transpileModuleFromFile channel parameters
Parameters:
TscChannel
parameters : TranspileFromFileParams
Returns: TranspileOutputResponse
|
|
Full Usage:
Api.typeToString channel parameters
Parameters:
TscChannel
parameters : TypeToTypeNodeParams
Returns: JsonNode voption
|
|
Full Usage:
Api.typeToTypeNode channel parameters
Parameters:
TscChannel
parameters : TypeToTypeNodeParams
Returns: SourceFile voption
|
Returns the raw binary AST, not the schema's `SourceFileResponse` JSON envelope - see `ProtoJson.requestAst`.
|
Full Usage:
Api.updateSnapshot channel parameters
Parameters:
TscChannel
parameters : UpdateSnapshotParams
Returns: UpdateSnapshotResponse
|
|
Full Usage:
Api.updateTemporarySnapshot channel parameters
Parameters:
TscChannel
parameters : UpdateTemporarySnapshotParams
Returns: UpdateSnapshotResponse
|
|