Logo Xantham

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

Api.batchRequests channel parameters

Full Usage: Api.batchRequests channel parameters

Parameters:
Returns: BatchRequestsResponse
channel : TscChannel
parameters : BatchRequestsParams
Returns: BatchRequestsResponse

Api.createProgram channel parameters

Full Usage: Api.createProgram channel parameters

Parameters:
Returns: CreateProgramResponse
channel : TscChannel
parameters : CreateProgramParams
Returns: CreateProgramResponse

Api.emit channel parameters

Full Usage: Api.emit channel parameters

Parameters:
Returns: EmitResponse
channel : TscChannel
parameters : EmitParams
Returns: EmitResponse

Api.emitToString channel parameters

Full Usage: Api.emitToString channel parameters

Parameters:
Returns: EmitOutputResponse
channel : TscChannel
parameters : EmitParams
Returns: EmitOutputResponse

Api.formatNodeForInsertion channel parameters

Full Usage: Api.formatNodeForInsertion channel parameters

Parameters:
Returns: string
channel : TscChannel
parameters : FormatNodeForInsertionParams
Returns: string

Api.getAliasSymbolOfType channel parameters

Full Usage: Api.getAliasSymbolOfType channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : GetTypePropertyParams
Returns: SymbolResponse voption

Api.getAliasTypeArgumentsOfType channel parameters

Full Usage: Api.getAliasTypeArgumentsOfType channel parameters

Parameters:
Returns: TypeResponse[] voption
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse[] voption

Api.getAliasedSymbol channel parameters

Full Usage: Api.getAliasedSymbol channel parameters

Parameters:
Returns: SymbolResponse
channel : TscChannel
parameters : CheckerSymbolParams
Returns: SymbolResponse

Api.getAnyType channel parameters

Full Usage: Api.getAnyType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getApparentPropertiesOfType channel parameters

Full Usage: Api.getApparentPropertiesOfType channel parameters

Parameters:
Returns: SymbolResponse[]
channel : TscChannel
parameters : GetTypePropertyParams
Returns: SymbolResponse[]

Api.getApparentType channel parameters

Full Usage: Api.getApparentType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getBaseConstraintOfType channel parameters

Full Usage: Api.getBaseConstraintOfType channel parameters

Parameters:
Returns: TypeResponse voption
channel : TscChannel
parameters : CheckerTypeParams
Returns: TypeResponse voption

Api.getBaseTypeOfLiteralType channel parameters

Full Usage: Api.getBaseTypeOfLiteralType channel parameters

Parameters:
Returns: TypeResponse

Api.getBaseTypeOfType channel parameters

Full Usage: Api.getBaseTypeOfType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getBaseTypes channel parameters

Full Usage: Api.getBaseTypes channel parameters

Parameters:
Returns: TypeResponse[] voption
channel : TscChannel
parameters : CheckerTypeParams
Returns: TypeResponse[] voption

Api.getBigIntType channel parameters

Full Usage: Api.getBigIntType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getBindDiagnostics channel parameters

Full Usage: Api.getBindDiagnostics channel parameters

Parameters:
Returns: DiagnosticResponse[] voption
channel : TscChannel
parameters : GetDiagnosticsParams
Returns: DiagnosticResponse[] voption

Api.getBooleanType channel parameters

Full Usage: Api.getBooleanType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getCheckTypeOfType channel parameters

Full Usage: Api.getCheckTypeOfType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getCompletionsAtPosition channel parameters

Full Usage: Api.getCompletionsAtPosition channel parameters

Parameters:
Returns: CompletionInfoResponse voption
channel : TscChannel
parameters : GetCompletionsAtPositionParams
Returns: CompletionInfoResponse voption

Api.getConfigFileNames channel parameters

Full Usage: Api.getConfigFileNames channel parameters

Parameters:
Returns: string[] voption
channel : TscChannel
parameters : GetProjectDiagnosticsParams
Returns: string[] voption

Api.getConfigFileParsingDiagnostics channel parameters

Full Usage: Api.getConfigFileParsingDiagnostics channel parameters

Parameters:
Returns: DiagnosticResponse[] voption
channel : TscChannel
parameters : GetProjectDiagnosticsParams
Returns: DiagnosticResponse[] voption

Api.getConfigSourceFile channel parameters

Full Usage: Api.getConfigSourceFile channel parameters

Parameters:
Returns: SourceFile voption

Returns the raw binary AST, not the schema's `SourceFileResponse` JSON envelope - see `ProtoJson.requestAst`.

channel : TscChannel
parameters : GetSourceFileParams
Returns: SourceFile voption

Api.getConstantValue channel parameters

Full Usage: Api.getConstantValue channel parameters

Parameters:
Returns: JsonNode voption
channel : TscChannel
parameters : CheckerNodeParams
Returns: JsonNode voption

Api.getConstraintOfType channel parameters

Full Usage: Api.getConstraintOfType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getConstraintOfTypeParameter channel parameters

Full Usage: Api.getConstraintOfTypeParameter channel parameters

Parameters:
Returns: TypeResponse voption
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse voption

Api.getContextualType channel parameters

Full Usage: Api.getContextualType channel parameters

Parameters:
Returns: TypeResponse voption
channel : TscChannel
parameters : GetContextualTypeParams
Returns: TypeResponse voption

Api.getDeclarationDiagnostics channel parameters

Full Usage: Api.getDeclarationDiagnostics channel parameters

Parameters:
Returns: DiagnosticResponse[] voption
channel : TscChannel
parameters : GetDiagnosticsParams
Returns: DiagnosticResponse[] voption

Api.getDeclarationEmit channel parameters

Full Usage: Api.getDeclarationEmit channel parameters

Parameters:
Returns: EmitOutputResponse
channel : TscChannel
parameters : SelectedFilesEmitParams
Returns: EmitOutputResponse

Api.getDeclaredTypeOfSymbol channel parameters

Full Usage: Api.getDeclaredTypeOfSymbol channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypeOfSymbolParams
Returns: TypeResponse

Api.getDefaultFromTypeParameter channel parameters

Full Usage: Api.getDefaultFromTypeParameter channel parameters

Parameters:
Returns: TypeResponse voption
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse voption

Api.getDefaultProjectForFile channel parameters

Full Usage: Api.getDefaultProjectForFile channel parameters

Parameters:
Returns: ProjectResponse voption
channel : TscChannel
parameters : GetDefaultProjectForFileParams
Returns: ProjectResponse voption

Api.getDocumentationComment channel parameters

Full Usage: Api.getDocumentationComment channel parameters

Parameters:
Returns: string
channel : TscChannel
parameters : CheckerSymbolParams
Returns: string

Api.getESSymbolType channel parameters

Full Usage: Api.getESSymbolType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getExportSpecifierLocalTargetSymbol channel parameters

Full Usage: Api.getExportSpecifierLocalTargetSymbol channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : CheckerNodeParams
Returns: SymbolResponse voption

Api.getExportSymbolOfSymbol channel parameters

Full Usage: Api.getExportSymbolOfSymbol channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : GetSymbolPropertyParams
Returns: SymbolResponse voption

Api.getExportsOfModule channel parameters

Full Usage: Api.getExportsOfModule channel parameters

Parameters:
Returns: SymbolResponse[] voption
channel : TscChannel
parameters : CheckerSymbolParams
Returns: SymbolResponse[] voption

Api.getExportsOfSymbol channel parameters

Full Usage: Api.getExportsOfSymbol channel parameters

Parameters:
Returns: SymbolResponse[] voption
channel : TscChannel
parameters : GetSymbolPropertyParams
Returns: SymbolResponse[] voption

Api.getExtendsTypeOfType channel parameters

Full Usage: Api.getExtendsTypeOfType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getFalseTypeOfConditionalType channel parameters

Full Usage: Api.getFalseTypeOfConditionalType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getFreshTypeOfType channel parameters

Full Usage: Api.getFreshTypeOfType channel parameters

Parameters:
Returns: TypeResponse voption
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse voption

Api.getFullyQualifiedName channel parameters

Full Usage: Api.getFullyQualifiedName channel parameters

Parameters:
Returns: string
channel : TscChannel
parameters : CheckerSymbolParams
Returns: string

Api.getGlobalDiagnostics channel parameters

Full Usage: Api.getGlobalDiagnostics channel parameters

Parameters:
Returns: DiagnosticResponse[] voption
channel : TscChannel
parameters : GetProjectDiagnosticsParams
Returns: DiagnosticResponse[] voption

Api.getImmediateAliasedSymbol channel parameters

Full Usage: Api.getImmediateAliasedSymbol channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : CheckerSymbolParams
Returns: SymbolResponse voption

Api.getImportAdderEdits channel parameters

Full Usage: Api.getImportAdderEdits channel parameters

Parameters:
Returns: TextEdit[]
channel : TscChannel
parameters : GetImportAdderEditsParams
Returns: TextEdit[]

Api.getIndexInfosOfType channel parameters

Full Usage: Api.getIndexInfosOfType channel parameters

Parameters:
Returns: IndexInfoResponse[] voption
channel : TscChannel
parameters : CheckerTypeParams
Returns: IndexInfoResponse[] voption

Api.getIndexTypeOfType channel parameters

Full Usage: Api.getIndexTypeOfType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getJavaScriptEmit channel parameters

Full Usage: Api.getJavaScriptEmit channel parameters

Parameters:
Returns: EmitOutputResponse
channel : TscChannel
parameters : SelectedFilesEmitParams
Returns: EmitOutputResponse

Api.getJsDocTags channel parameters

Full Usage: Api.getJsDocTags channel parameters

Parameters:
Returns: JSDocTagInfo[] voption
channel : TscChannel
parameters : CheckerSymbolParams
Returns: JSDocTagInfo[] voption

Api.getLocalTypeParametersOfType channel parameters

Full Usage: Api.getLocalTypeParametersOfType channel parameters

Parameters:
Returns: TypeResponse[] voption
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse[] voption

Api.getMemberInModuleExports channel parameters

Full Usage: Api.getMemberInModuleExports channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : GetMemberInModuleExportsParams
Returns: SymbolResponse voption

Api.getMembersOfSymbol channel parameters

Full Usage: Api.getMembersOfSymbol channel parameters

Parameters:
Returns: SymbolResponse[] voption
channel : TscChannel
parameters : GetSymbolPropertyParams
Returns: SymbolResponse[] voption

Api.getNeverType channel parameters

Full Usage: Api.getNeverType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getNonMissingTypeOfSymbol channel parameters

Full Usage: Api.getNonMissingTypeOfSymbol channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypeOfSymbolParams
Returns: TypeResponse

Api.getNonNullableType channel parameters

Full Usage: Api.getNonNullableType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getNonPrimitiveType channel parameters

Full Usage: Api.getNonPrimitiveType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getNullType channel parameters

Full Usage: Api.getNullType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getNumberType channel parameters

Full Usage: Api.getNumberType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getObjectTypeOfType channel parameters

Full Usage: Api.getObjectTypeOfType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getOuterTypeParametersOfType channel parameters

Full Usage: Api.getOuterTypeParametersOfType channel parameters

Parameters:
Returns: TypeResponse[] voption
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse[] voption

Api.getParameterType channel parameters

Full Usage: Api.getParameterType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetParameterTypeParams
Returns: TypeResponse

Api.getParametersOfSignature channel parameters

Full Usage: Api.getParametersOfSignature channel parameters

Parameters:
Returns: SymbolResponse[] voption
channel : TscChannel
parameters : GetSignaturePropertyParams
Returns: SymbolResponse[] voption

Api.getParentOfSymbol channel parameters

Full Usage: Api.getParentOfSymbol channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : GetSymbolPropertyParams
Returns: SymbolResponse voption

Api.getProgramDiagnostics channel parameters

Full Usage: Api.getProgramDiagnostics channel parameters

Parameters:
Returns: DiagnosticResponse[] voption
channel : TscChannel
parameters : GetProjectDiagnosticsParams
Returns: DiagnosticResponse[] voption

Api.getPropertiesOfType channel parameters

Full Usage: Api.getPropertiesOfType channel parameters

Parameters:
Returns: SymbolResponse[] voption
channel : TscChannel
parameters : CheckerTypeParams
Returns: SymbolResponse[] voption

Api.getPropertyOfType channel parameters

Full Usage: Api.getPropertyOfType channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : GetPropertyOfTypeParams
Returns: SymbolResponse voption

Api.getReducedType channel parameters

Full Usage: Api.getReducedType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getReferencedSymbolsForNode channel parameters

Full Usage: Api.getReferencedSymbolsForNode channel parameters

Parameters:
Returns: ReferencedSymbolEntry[] voption
channel : TscChannel
parameters : GetReferencedSymbolsForNodeParams
Returns: ReferencedSymbolEntry[] voption

Api.getReferencesToSymbolInFile channel parameters

Full Usage: Api.getReferencesToSymbolInFile channel parameters

Parameters:
Returns: string[]
channel : TscChannel
parameters : GetReferencesToSymbolInFileParams
Returns: string[]

Api.getRegularTypeOfType channel parameters

Full Usage: Api.getRegularTypeOfType channel parameters

Parameters:
Returns: TypeResponse voption
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse voption

Api.getResolvedSignature channel parameters

Full Usage: Api.getResolvedSignature channel parameters

Parameters:
Returns: SignatureResponse

Api.getRestTypeOfSignature channel parameters

Full Usage: Api.getRestTypeOfSignature channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : CheckerSignatureParams
Returns: TypeResponse

Api.getReturnTypeOfSignature channel parameters

Full Usage: Api.getReturnTypeOfSignature channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetSignaturePropertyParams
Returns: TypeResponse

Api.getSemanticDiagnostics channel parameters

Full Usage: Api.getSemanticDiagnostics channel parameters

Parameters:
Returns: DiagnosticResponse[] voption
channel : TscChannel
parameters : GetDiagnosticsParams
Returns: DiagnosticResponse[] voption

Api.getShorthandAssignmentValueSymbol channel parameters

Full Usage: Api.getShorthandAssignmentValueSymbol channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : GetTypeAtLocationParams
Returns: SymbolResponse voption

Api.getSignatureFromDeclaration channel parameters

Full Usage: Api.getSignatureFromDeclaration channel parameters

Parameters:
Returns: SignatureResponse
channel : TscChannel
parameters : CheckerNodeParams
Returns: SignatureResponse

Api.getSignatureUsages channel parameters

Full Usage: Api.getSignatureUsages channel parameters

Parameters:
Returns: SignatureUsageResponse[] voption
channel : TscChannel
parameters : GetSignatureUsagesParams
Returns: SignatureUsageResponse[] voption

Api.getSignaturesOfType channel parameters

Full Usage: Api.getSignaturesOfType channel parameters

Parameters:
Returns: SignatureResponse[]
channel : TscChannel
parameters : GetSignaturesOfTypeParams
Returns: SignatureResponse[]

Api.getSourceFile channel parameters

Full Usage: Api.getSourceFile channel parameters

Parameters:
Returns: SourceFile voption

Returns the raw binary AST, not the schema's `SourceFileResponse` JSON envelope - see `ProtoJson.requestAst`.

channel : TscChannel
parameters : GetSourceFileParams
Returns: SourceFile voption

Api.getSourceFileMetadata channel parameters

Full Usage: Api.getSourceFileMetadata channel parameters

Parameters:
Returns: SourceFileMetadata voption
channel : TscChannel
parameters : GetSourceFileParams
Returns: SourceFileMetadata voption

Api.getSourceFileNames channel parameters

Full Usage: Api.getSourceFileNames channel parameters

Parameters:
Returns: string[]
channel : TscChannel
parameters : GetSourceFileNamesParams
Returns: string[]

Api.getStringType channel parameters

Full Usage: Api.getStringType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getSuggestionDiagnostics channel parameters

Full Usage: Api.getSuggestionDiagnostics channel parameters

Parameters:
Returns: DiagnosticResponse[] voption
channel : TscChannel
parameters : GetDiagnosticsParams
Returns: DiagnosticResponse[] voption

Api.getSymbolAtLocation channel parameters

Full Usage: Api.getSymbolAtLocation channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : GetSymbolAtLocationParams
Returns: SymbolResponse voption

Api.getSymbolAtPosition channel parameters

Full Usage: Api.getSymbolAtPosition channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : GetSymbolAtPositionParams
Returns: SymbolResponse voption

Api.getSymbolOfSourceFile channel parameters

Full Usage: Api.getSymbolOfSourceFile channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : GetSymbolOfSourceFileParams
Returns: SymbolResponse voption

Api.getSymbolOfType channel parameters

Full Usage: Api.getSymbolOfType channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : GetTypePropertyParams
Returns: SymbolResponse voption

Api.getSymbolsAtLocations channel parameters

Full Usage: Api.getSymbolsAtLocations channel parameters

Parameters:
Returns: SymbolResponse[]
channel : TscChannel
parameters : GetSymbolsAtLocationsParams
Returns: SymbolResponse[]

Api.getSymbolsAtPositions channel parameters

Full Usage: Api.getSymbolsAtPositions channel parameters

Parameters:
Returns: SymbolResponse[]
channel : TscChannel
parameters : GetSymbolsAtPositionsParams
Returns: SymbolResponse[]

Api.getSymbolsInScope channel parameters

Full Usage: Api.getSymbolsInScope channel parameters

Parameters:
Returns: SymbolResponse[]
channel : TscChannel
parameters : GetSymbolsInScopeParams
Returns: SymbolResponse[]

Api.getSymbolsOfSourceFiles channel parameters

Full Usage: Api.getSymbolsOfSourceFiles channel parameters

Parameters:
Returns: SymbolResponse[]
channel : TscChannel
parameters : GetSymbolsOfSourceFilesParams
Returns: SymbolResponse[]

Api.getSyntacticDiagnostics channel parameters

Full Usage: Api.getSyntacticDiagnostics channel parameters

Parameters:
Returns: DiagnosticResponse[] voption
channel : TscChannel
parameters : GetDiagnosticsParams
Returns: DiagnosticResponse[] voption

Api.getTargetOfSignature channel parameters

Full Usage: Api.getTargetOfSignature channel parameters

Parameters:
Returns: SignatureResponse voption
channel : TscChannel
parameters : GetSignaturePropertyParams
Returns: SignatureResponse voption

Api.getTargetOfType channel parameters

Full Usage: Api.getTargetOfType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getTargetSymbol channel parameters

Full Usage: Api.getTargetSymbol channel parameters

Parameters:
Returns: SymbolResponse
channel : TscChannel
parameters : CheckerSymbolParams
Returns: SymbolResponse

Api.getThisParameterOfSignature channel parameters

Full Usage: Api.getThisParameterOfSignature channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : GetSignaturePropertyParams
Returns: SymbolResponse voption

Api.getTrueTypeOfConditionalType channel parameters

Full Usage: Api.getTrueTypeOfConditionalType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse

Api.getTypeArguments channel parameters

Full Usage: Api.getTypeArguments channel parameters

Parameters:
Returns: TypeResponse[] voption
channel : TscChannel
parameters : CheckerTypeParams
Returns: TypeResponse[] voption

Api.getTypeAtLocation channel parameters

Full Usage: Api.getTypeAtLocation channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypeAtLocationParams
Returns: TypeResponse

Api.getTypeAtLocations channel parameters

Full Usage: Api.getTypeAtLocations channel parameters

Parameters:
Returns: TypeResponse[]
channel : TscChannel
parameters : GetTypeAtLocationsParams
Returns: TypeResponse[]

Api.getTypeAtPosition channel parameters

Full Usage: Api.getTypeAtPosition channel parameters

Parameters:
Returns: TypeResponse voption
channel : TscChannel
parameters : GetTypeAtPositionParams
Returns: TypeResponse voption

Api.getTypeFromTypeNode channel parameters

Full Usage: Api.getTypeFromTypeNode channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypeFromTypeNodeParams
Returns: TypeResponse

Api.getTypeOfSymbol channel parameters

Full Usage: Api.getTypeOfSymbol channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetTypeOfSymbolParams
Returns: TypeResponse

Api.getTypeOfSymbolAtLocation channel parameters

Full Usage: Api.getTypeOfSymbolAtLocation channel parameters

Parameters:
Returns: TypeResponse

Api.getTypeParameterAtPosition channel parameters

Full Usage: Api.getTypeParameterAtPosition channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetParameterTypeParams
Returns: TypeResponse

Api.getTypeParametersOfSignature channel parameters

Full Usage: Api.getTypeParametersOfSignature channel parameters

Parameters:
Returns: TypeResponse[] voption
channel : TscChannel
parameters : GetSignaturePropertyParams
Returns: TypeResponse[] voption

Api.getTypeParametersOfType channel parameters

Full Usage: Api.getTypeParametersOfType channel parameters

Parameters:
Returns: TypeResponse[] voption
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse[] voption

Api.getTypePredicateOfSignature channel parameters

Full Usage: Api.getTypePredicateOfSignature channel parameters

Parameters:
Returns: TypePredicateResponse voption
channel : TscChannel
parameters : CheckerSignatureParams
Returns: TypePredicateResponse voption

Api.getTypesAtPositions channel parameters

Full Usage: Api.getTypesAtPositions channel parameters

Parameters:
Returns: TypeResponse[]
channel : TscChannel
parameters : GetTypesAtPositionsParams
Returns: TypeResponse[]

Api.getTypesOfSymbols channel parameters

Full Usage: Api.getTypesOfSymbols channel parameters

Parameters:
Returns: TypeResponse[]
channel : TscChannel
parameters : GetTypesOfSymbolsParams
Returns: TypeResponse[]

Api.getTypesOfType channel parameters

Full Usage: Api.getTypesOfType channel parameters

Parameters:
Returns: TypeResponse[] voption
channel : TscChannel
parameters : GetTypePropertyParams
Returns: TypeResponse[] voption

Api.getUndefinedType channel parameters

Full Usage: Api.getUndefinedType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getUnknownType channel parameters

Full Usage: Api.getUnknownType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getVoidType channel parameters

Full Usage: Api.getVoidType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetIntrinsicTypeParams
Returns: TypeResponse

Api.getWellKnownSignatures channel parameters

Full Usage: Api.getWellKnownSignatures channel parameters

Parameters:
Returns: WellKnownSignaturesResponse

Api.getWellKnownSymbols channel parameters

Full Usage: Api.getWellKnownSymbols channel parameters

Parameters:
Returns: WellKnownSymbolsResponse

Api.getWidenedType channel parameters

Full Usage: Api.getWidenedType channel parameters

Parameters:
Returns: TypeResponse
channel : TscChannel
parameters : GetWidenedTypeParams
Returns: TypeResponse

Api.initialize channel

Full Usage: Api.initialize channel

Parameters:
Returns: InitializeResponse
channel : TscChannel
Returns: InitializeResponse

Api.isArrayLikeType channel parameters

Full Usage: Api.isArrayLikeType channel parameters

Parameters:
Returns: bool
channel : TscChannel
parameters : IsArrayLikeTypeParams
Returns: bool

Api.isArrayType channel parameters

Full Usage: Api.isArrayType channel parameters

Parameters:
Returns: bool
channel : TscChannel
parameters : CheckerTypeParams
Returns: bool

Api.isContextSensitive channel parameters

Full Usage: Api.isContextSensitive channel parameters

Parameters:
Returns: bool
channel : TscChannel
parameters : GetContextualTypeParams
Returns: bool

Api.isReadonlySymbol channel parameters

Full Usage: Api.isReadonlySymbol channel parameters

Parameters:
Returns: bool
channel : TscChannel
parameters : CheckerSymbolParams
Returns: bool

Api.isTypeAssignableTo channel parameters

Full Usage: Api.isTypeAssignableTo channel parameters

Parameters:
Returns: bool
channel : TscChannel
parameters : IsTypeAssignableToParams
Returns: bool

Api.parseCommandLine channel parameters

Full Usage: Api.parseCommandLine channel parameters

Parameters:
Returns: ConfigFileResponse
channel : TscChannel
parameters : ParseCommandLineParams
Returns: ConfigFileResponse

Api.parseConfigFile channel parameters

Full Usage: Api.parseConfigFile channel parameters

Parameters:
Returns: ConfigFileResponse
channel : TscChannel
parameters : ParseConfigFileParams
Returns: ConfigFileResponse

Api.parseJsonConfigFileContent channel parameters

Full Usage: Api.parseJsonConfigFileContent channel parameters

Parameters:
Returns: ConfigFileResponse

Api.printNode channel parameters

Full Usage: Api.printNode channel parameters

Parameters:
Returns: string
channel : TscChannel
parameters : PrintNodeParams
Returns: string

Api.readConfigFile channel parameters

Full Usage: Api.readConfigFile channel parameters

Parameters:
Returns: ReadConfigFileResponse

Api.release channel parameters

Full Usage: Api.release channel parameters

Parameters:
channel : TscChannel
parameters : ReleaseParams

Api.resolveName channel parameters

Full Usage: Api.resolveName channel parameters

Parameters:
Returns: SymbolResponse voption
channel : TscChannel
parameters : ResolveNameParams
Returns: SymbolResponse voption

Api.saveHeapProfile channel parameters

Full Usage: Api.saveHeapProfile channel parameters

Parameters:
Returns: ProfileResult
channel : TscChannel
parameters : ProfileParams
Returns: ProfileResult

Api.signatureToSignatureDeclaration channel parameters

Full Usage: Api.signatureToSignatureDeclaration channel parameters

Parameters:
Returns: SourceFile voption

Returns the raw binary AST, not the schema's `SourceFileResponse` JSON envelope - see `ProtoJson.requestAst`.

channel : TscChannel
parameters : SignatureToSignatureDeclarationParams
Returns: SourceFile voption

Api.startCPUProfile channel parameters

Full Usage: Api.startCPUProfile channel parameters

Parameters:
channel : TscChannel
parameters : ProfileParams

Api.stopCPUProfile channel

Full Usage: Api.stopCPUProfile channel

Parameters:
Returns: ProfileResult
channel : TscChannel
Returns: ProfileResult

Api.transpileDeclaration channel parameters

Full Usage: Api.transpileDeclaration channel parameters

Parameters:
Returns: TranspileOutputResponse
channel : TscChannel
parameters : TranspileParams
Returns: TranspileOutputResponse

Api.transpileDeclarationFromFile channel parameters

Full Usage: Api.transpileDeclarationFromFile channel parameters

Parameters:
Returns: TranspileOutputResponse

Api.transpileModule channel parameters

Full Usage: Api.transpileModule channel parameters

Parameters:
Returns: TranspileOutputResponse
channel : TscChannel
parameters : TranspileParams
Returns: TranspileOutputResponse

Api.transpileModuleFromFile channel parameters

Full Usage: Api.transpileModuleFromFile channel parameters

Parameters:
Returns: TranspileOutputResponse

Api.typeToString channel parameters

Full Usage: Api.typeToString channel parameters

Parameters:
Returns: JsonNode voption
channel : TscChannel
parameters : TypeToTypeNodeParams
Returns: JsonNode voption

Api.typeToTypeNode channel parameters

Full Usage: Api.typeToTypeNode channel parameters

Parameters:
Returns: SourceFile voption

Returns the raw binary AST, not the schema's `SourceFileResponse` JSON envelope - see `ProtoJson.requestAst`.

channel : TscChannel
parameters : TypeToTypeNodeParams
Returns: SourceFile voption

Api.updateSnapshot channel parameters

Full Usage: Api.updateSnapshot channel parameters

Parameters:
Returns: UpdateSnapshotResponse

Api.updateTemporarySnapshot channel parameters

Full Usage: Api.updateTemporarySnapshot channel parameters

Parameters:
Returns: UpdateSnapshotResponse

Type something to start searching.