Logo Xantham

AsyncApi Module

Namespace: Xantham.TypeScript.Wire
Assembly: Xantham.TypeScript.Wire.dll

One function per server method, each taking the mailbox and the method's parameter record. The mirror of `Api` over `TscMailbox` rather than `TscChannel`: same names, same parameter and result types, each wrapped in `Async`. Calls that overlap in time are collected into a single round trip, so concurrency here is worth taking even though the channel underneath admits one request at a time. `batchRequests` has no counterpart: the mailbox is the batcher, and a batch nested inside one would return a result this layer cannot attribute to a caller.

Functions and values

Function or value Description

AsyncApi.createProgram mailbox parameters

Full Usage: AsyncApi.createProgram mailbox parameters

Parameters:
Returns: Async<CreateProgramResponse>
mailbox : TscMailbox
parameters : CreateProgramParams
Returns: Async<CreateProgramResponse>

AsyncApi.emit mailbox parameters

Full Usage: AsyncApi.emit mailbox parameters

Parameters:
Returns: Async<EmitResponse>
mailbox : TscMailbox
parameters : EmitParams
Returns: Async<EmitResponse>

AsyncApi.emitToString mailbox parameters

Full Usage: AsyncApi.emitToString mailbox parameters

Parameters:
Returns: Async<EmitOutputResponse>
mailbox : TscMailbox
parameters : EmitParams
Returns: Async<EmitOutputResponse>

AsyncApi.formatNodeForInsertion mailbox parameters

Full Usage: AsyncApi.formatNodeForInsertion mailbox parameters

Parameters:
Returns: Async<string>
mailbox : TscMailbox
parameters : FormatNodeForInsertionParams
Returns: Async<string>

AsyncApi.getAliasSymbolOfType mailbox parameters

Full Usage: AsyncApi.getAliasSymbolOfType mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<SymbolResponse voption>

AsyncApi.getAliasTypeArgumentsOfType mailbox parameters

Full Usage: AsyncApi.getAliasTypeArgumentsOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse[] voption>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse[] voption>

AsyncApi.getAliasedSymbol mailbox parameters

Full Usage: AsyncApi.getAliasedSymbol mailbox parameters

Parameters:
Returns: Async<SymbolResponse>
mailbox : TscMailbox
parameters : CheckerSymbolParams
Returns: Async<SymbolResponse>

AsyncApi.getAnyType mailbox parameters

Full Usage: AsyncApi.getAnyType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getApparentPropertiesOfType mailbox parameters

Full Usage: AsyncApi.getApparentPropertiesOfType mailbox parameters

Parameters:
Returns: Async<SymbolResponse[]>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<SymbolResponse[]>

AsyncApi.getApparentType mailbox parameters

Full Usage: AsyncApi.getApparentType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getBaseConstraintOfType mailbox parameters

Full Usage: AsyncApi.getBaseConstraintOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse voption>
mailbox : TscMailbox
parameters : CheckerTypeParams
Returns: Async<TypeResponse voption>

AsyncApi.getBaseTypeOfLiteralType mailbox parameters

Full Usage: AsyncApi.getBaseTypeOfLiteralType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetBaseTypeOfLiteralTypeParams
Returns: Async<TypeResponse>

AsyncApi.getBaseTypeOfType mailbox parameters

Full Usage: AsyncApi.getBaseTypeOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getBaseTypes mailbox parameters

Full Usage: AsyncApi.getBaseTypes mailbox parameters

Parameters:
Returns: Async<TypeResponse[] voption>
mailbox : TscMailbox
parameters : CheckerTypeParams
Returns: Async<TypeResponse[] voption>

AsyncApi.getBigIntType mailbox parameters

Full Usage: AsyncApi.getBigIntType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getBindDiagnostics mailbox parameters

Full Usage: AsyncApi.getBindDiagnostics mailbox parameters

Parameters:
Returns: Async<DiagnosticResponse[] voption>
mailbox : TscMailbox
parameters : GetDiagnosticsParams
Returns: Async<DiagnosticResponse[] voption>

AsyncApi.getBooleanType mailbox parameters

Full Usage: AsyncApi.getBooleanType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getCheckTypeOfType mailbox parameters

Full Usage: AsyncApi.getCheckTypeOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getCompletionsAtPosition mailbox parameters

Full Usage: AsyncApi.getCompletionsAtPosition mailbox parameters

Parameters:
Returns: Async<CompletionInfoResponse voption>
mailbox : TscMailbox
parameters : GetCompletionsAtPositionParams
Returns: Async<CompletionInfoResponse voption>

AsyncApi.getConfigFileNames mailbox parameters

Full Usage: AsyncApi.getConfigFileNames mailbox parameters

Parameters:
Returns: Async<string[] voption>
mailbox : TscMailbox
parameters : GetProjectDiagnosticsParams
Returns: Async<string[] voption>

AsyncApi.getConfigFileParsingDiagnostics mailbox parameters

Full Usage: AsyncApi.getConfigFileParsingDiagnostics mailbox parameters

Parameters:
Returns: Async<DiagnosticResponse[] voption>
mailbox : TscMailbox
parameters : GetProjectDiagnosticsParams
Returns: Async<DiagnosticResponse[] voption>

AsyncApi.getConfigSourceFile mailbox parameters

Full Usage: AsyncApi.getConfigSourceFile mailbox parameters

Parameters:
Returns: Async<SourceFile voption>

Returns the decoded binary AST, not the schema's `SourceFileResponse` JSON envelope. The mailbox normalises the two encodings the transport uses for it, so this is the same result whether the request travelled alone or inside a batch.

mailbox : TscMailbox
parameters : GetSourceFileParams
Returns: Async<SourceFile voption>

AsyncApi.getConstantValue mailbox parameters

Full Usage: AsyncApi.getConstantValue mailbox parameters

Parameters:
Returns: Async<JsonNode voption>
mailbox : TscMailbox
parameters : CheckerNodeParams
Returns: Async<JsonNode voption>

AsyncApi.getConstraintOfType mailbox parameters

Full Usage: AsyncApi.getConstraintOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getConstraintOfTypeParameter mailbox parameters

Full Usage: AsyncApi.getConstraintOfTypeParameter mailbox parameters

Parameters:
Returns: Async<TypeResponse voption>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse voption>

AsyncApi.getContextualType mailbox parameters

Full Usage: AsyncApi.getContextualType mailbox parameters

Parameters:
Returns: Async<TypeResponse voption>
mailbox : TscMailbox
parameters : GetContextualTypeParams
Returns: Async<TypeResponse voption>

AsyncApi.getDeclarationDiagnostics mailbox parameters

Full Usage: AsyncApi.getDeclarationDiagnostics mailbox parameters

Parameters:
Returns: Async<DiagnosticResponse[] voption>
mailbox : TscMailbox
parameters : GetDiagnosticsParams
Returns: Async<DiagnosticResponse[] voption>

AsyncApi.getDeclarationEmit mailbox parameters

Full Usage: AsyncApi.getDeclarationEmit mailbox parameters

Parameters:
Returns: Async<EmitOutputResponse>
mailbox : TscMailbox
parameters : SelectedFilesEmitParams
Returns: Async<EmitOutputResponse>

AsyncApi.getDeclaredTypeOfSymbol mailbox parameters

Full Usage: AsyncApi.getDeclaredTypeOfSymbol mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypeOfSymbolParams
Returns: Async<TypeResponse>

AsyncApi.getDefaultFromTypeParameter mailbox parameters

Full Usage: AsyncApi.getDefaultFromTypeParameter mailbox parameters

Parameters:
Returns: Async<TypeResponse voption>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse voption>

AsyncApi.getDefaultProjectForFile mailbox parameters

Full Usage: AsyncApi.getDefaultProjectForFile mailbox parameters

Parameters:
Returns: Async<ProjectResponse voption>
mailbox : TscMailbox
parameters : GetDefaultProjectForFileParams
Returns: Async<ProjectResponse voption>

AsyncApi.getDocumentationComment mailbox parameters

Full Usage: AsyncApi.getDocumentationComment mailbox parameters

Parameters:
Returns: Async<string>
mailbox : TscMailbox
parameters : CheckerSymbolParams
Returns: Async<string>

AsyncApi.getESSymbolType mailbox parameters

Full Usage: AsyncApi.getESSymbolType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getExportSpecifierLocalTargetSymbol mailbox parameters

Full Usage: AsyncApi.getExportSpecifierLocalTargetSymbol mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : CheckerNodeParams
Returns: Async<SymbolResponse voption>

AsyncApi.getExportSymbolOfSymbol mailbox parameters

Full Usage: AsyncApi.getExportSymbolOfSymbol mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : GetSymbolPropertyParams
Returns: Async<SymbolResponse voption>

AsyncApi.getExportsOfModule mailbox parameters

Full Usage: AsyncApi.getExportsOfModule mailbox parameters

Parameters:
Returns: Async<SymbolResponse[] voption>
mailbox : TscMailbox
parameters : CheckerSymbolParams
Returns: Async<SymbolResponse[] voption>

AsyncApi.getExportsOfSymbol mailbox parameters

Full Usage: AsyncApi.getExportsOfSymbol mailbox parameters

Parameters:
Returns: Async<SymbolResponse[] voption>
mailbox : TscMailbox
parameters : GetSymbolPropertyParams
Returns: Async<SymbolResponse[] voption>

AsyncApi.getExtendsTypeOfType mailbox parameters

Full Usage: AsyncApi.getExtendsTypeOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getFalseTypeOfConditionalType mailbox parameters

Full Usage: AsyncApi.getFalseTypeOfConditionalType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getFreshTypeOfType mailbox parameters

Full Usage: AsyncApi.getFreshTypeOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse voption>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse voption>

AsyncApi.getFullyQualifiedName mailbox parameters

Full Usage: AsyncApi.getFullyQualifiedName mailbox parameters

Parameters:
Returns: Async<string>
mailbox : TscMailbox
parameters : CheckerSymbolParams
Returns: Async<string>

AsyncApi.getGlobalDiagnostics mailbox parameters

Full Usage: AsyncApi.getGlobalDiagnostics mailbox parameters

Parameters:
Returns: Async<DiagnosticResponse[] voption>
mailbox : TscMailbox
parameters : GetProjectDiagnosticsParams
Returns: Async<DiagnosticResponse[] voption>

AsyncApi.getImmediateAliasedSymbol mailbox parameters

Full Usage: AsyncApi.getImmediateAliasedSymbol mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : CheckerSymbolParams
Returns: Async<SymbolResponse voption>

AsyncApi.getImportAdderEdits mailbox parameters

Full Usage: AsyncApi.getImportAdderEdits mailbox parameters

Parameters:
Returns: Async<TextEdit[]>
mailbox : TscMailbox
parameters : GetImportAdderEditsParams
Returns: Async<TextEdit[]>

AsyncApi.getIndexInfosOfType mailbox parameters

Full Usage: AsyncApi.getIndexInfosOfType mailbox parameters

Parameters:
Returns: Async<IndexInfoResponse[] voption>
mailbox : TscMailbox
parameters : CheckerTypeParams
Returns: Async<IndexInfoResponse[] voption>

AsyncApi.getIndexTypeOfType mailbox parameters

Full Usage: AsyncApi.getIndexTypeOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getJavaScriptEmit mailbox parameters

Full Usage: AsyncApi.getJavaScriptEmit mailbox parameters

Parameters:
Returns: Async<EmitOutputResponse>
mailbox : TscMailbox
parameters : SelectedFilesEmitParams
Returns: Async<EmitOutputResponse>

AsyncApi.getJsDocTags mailbox parameters

Full Usage: AsyncApi.getJsDocTags mailbox parameters

Parameters:
Returns: Async<JSDocTagInfo[] voption>
mailbox : TscMailbox
parameters : CheckerSymbolParams
Returns: Async<JSDocTagInfo[] voption>

AsyncApi.getLocalTypeParametersOfType mailbox parameters

Full Usage: AsyncApi.getLocalTypeParametersOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse[] voption>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse[] voption>

AsyncApi.getMemberInModuleExports mailbox parameters

Full Usage: AsyncApi.getMemberInModuleExports mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : GetMemberInModuleExportsParams
Returns: Async<SymbolResponse voption>

AsyncApi.getMembersOfSymbol mailbox parameters

Full Usage: AsyncApi.getMembersOfSymbol mailbox parameters

Parameters:
Returns: Async<SymbolResponse[] voption>
mailbox : TscMailbox
parameters : GetSymbolPropertyParams
Returns: Async<SymbolResponse[] voption>

AsyncApi.getNeverType mailbox parameters

Full Usage: AsyncApi.getNeverType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getNonMissingTypeOfSymbol mailbox parameters

Full Usage: AsyncApi.getNonMissingTypeOfSymbol mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypeOfSymbolParams
Returns: Async<TypeResponse>

AsyncApi.getNonNullableType mailbox parameters

Full Usage: AsyncApi.getNonNullableType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getNonPrimitiveType mailbox parameters

Full Usage: AsyncApi.getNonPrimitiveType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getNullType mailbox parameters

Full Usage: AsyncApi.getNullType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getNumberType mailbox parameters

Full Usage: AsyncApi.getNumberType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getObjectTypeOfType mailbox parameters

Full Usage: AsyncApi.getObjectTypeOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getOuterTypeParametersOfType mailbox parameters

Full Usage: AsyncApi.getOuterTypeParametersOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse[] voption>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse[] voption>

AsyncApi.getParameterType mailbox parameters

Full Usage: AsyncApi.getParameterType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetParameterTypeParams
Returns: Async<TypeResponse>

AsyncApi.getParametersOfSignature mailbox parameters

Full Usage: AsyncApi.getParametersOfSignature mailbox parameters

Parameters:
Returns: Async<SymbolResponse[] voption>
mailbox : TscMailbox
parameters : GetSignaturePropertyParams
Returns: Async<SymbolResponse[] voption>

AsyncApi.getParentOfSymbol mailbox parameters

Full Usage: AsyncApi.getParentOfSymbol mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : GetSymbolPropertyParams
Returns: Async<SymbolResponse voption>

AsyncApi.getProgramDiagnostics mailbox parameters

Full Usage: AsyncApi.getProgramDiagnostics mailbox parameters

Parameters:
Returns: Async<DiagnosticResponse[] voption>
mailbox : TscMailbox
parameters : GetProjectDiagnosticsParams
Returns: Async<DiagnosticResponse[] voption>

AsyncApi.getPropertiesOfType mailbox parameters

Full Usage: AsyncApi.getPropertiesOfType mailbox parameters

Parameters:
Returns: Async<SymbolResponse[] voption>
mailbox : TscMailbox
parameters : CheckerTypeParams
Returns: Async<SymbolResponse[] voption>

AsyncApi.getPropertyOfType mailbox parameters

Full Usage: AsyncApi.getPropertyOfType mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : GetPropertyOfTypeParams
Returns: Async<SymbolResponse voption>

AsyncApi.getReducedType mailbox parameters

Full Usage: AsyncApi.getReducedType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getReferencedSymbolsForNode mailbox parameters

Full Usage: AsyncApi.getReferencedSymbolsForNode mailbox parameters

Parameters:
Returns: Async<ReferencedSymbolEntry[] voption>
mailbox : TscMailbox
parameters : GetReferencedSymbolsForNodeParams
Returns: Async<ReferencedSymbolEntry[] voption>

AsyncApi.getReferencesToSymbolInFile mailbox parameters

Full Usage: AsyncApi.getReferencesToSymbolInFile mailbox parameters

Parameters:
Returns: Async<string[]>
mailbox : TscMailbox
parameters : GetReferencesToSymbolInFileParams
Returns: Async<string[]>

AsyncApi.getRegularTypeOfType mailbox parameters

Full Usage: AsyncApi.getRegularTypeOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse voption>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse voption>

AsyncApi.getResolvedSignature mailbox parameters

Full Usage: AsyncApi.getResolvedSignature mailbox parameters

Parameters:
Returns: Async<SignatureResponse>
mailbox : TscMailbox
parameters : GetResolvedSignatureParams
Returns: Async<SignatureResponse>

AsyncApi.getRestTypeOfSignature mailbox parameters

Full Usage: AsyncApi.getRestTypeOfSignature mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : CheckerSignatureParams
Returns: Async<TypeResponse>

AsyncApi.getReturnTypeOfSignature mailbox parameters

Full Usage: AsyncApi.getReturnTypeOfSignature mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetSignaturePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getSemanticDiagnostics mailbox parameters

Full Usage: AsyncApi.getSemanticDiagnostics mailbox parameters

Parameters:
Returns: Async<DiagnosticResponse[] voption>
mailbox : TscMailbox
parameters : GetDiagnosticsParams
Returns: Async<DiagnosticResponse[] voption>

AsyncApi.getShorthandAssignmentValueSymbol mailbox parameters

Full Usage: AsyncApi.getShorthandAssignmentValueSymbol mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : GetTypeAtLocationParams
Returns: Async<SymbolResponse voption>

AsyncApi.getSignatureFromDeclaration mailbox parameters

Full Usage: AsyncApi.getSignatureFromDeclaration mailbox parameters

Parameters:
Returns: Async<SignatureResponse>
mailbox : TscMailbox
parameters : CheckerNodeParams
Returns: Async<SignatureResponse>

AsyncApi.getSignatureUsages mailbox parameters

Full Usage: AsyncApi.getSignatureUsages mailbox parameters

Parameters:
Returns: Async<SignatureUsageResponse[] voption>
mailbox : TscMailbox
parameters : GetSignatureUsagesParams
Returns: Async<SignatureUsageResponse[] voption>

AsyncApi.getSignaturesOfType mailbox parameters

Full Usage: AsyncApi.getSignaturesOfType mailbox parameters

Parameters:
Returns: Async<SignatureResponse[]>
mailbox : TscMailbox
parameters : GetSignaturesOfTypeParams
Returns: Async<SignatureResponse[]>

AsyncApi.getSourceFile mailbox parameters

Full Usage: AsyncApi.getSourceFile mailbox parameters

Parameters:
Returns: Async<SourceFile voption>

Returns the decoded binary AST, not the schema's `SourceFileResponse` JSON envelope. The mailbox normalises the two encodings the transport uses for it, so this is the same result whether the request travelled alone or inside a batch.

mailbox : TscMailbox
parameters : GetSourceFileParams
Returns: Async<SourceFile voption>

AsyncApi.getSourceFileMetadata mailbox parameters

Full Usage: AsyncApi.getSourceFileMetadata mailbox parameters

Parameters:
Returns: Async<SourceFileMetadata voption>
mailbox : TscMailbox
parameters : GetSourceFileParams
Returns: Async<SourceFileMetadata voption>

AsyncApi.getSourceFileNames mailbox parameters

Full Usage: AsyncApi.getSourceFileNames mailbox parameters

Parameters:
Returns: Async<string[]>
mailbox : TscMailbox
parameters : GetSourceFileNamesParams
Returns: Async<string[]>

AsyncApi.getStringType mailbox parameters

Full Usage: AsyncApi.getStringType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getSuggestionDiagnostics mailbox parameters

Full Usage: AsyncApi.getSuggestionDiagnostics mailbox parameters

Parameters:
Returns: Async<DiagnosticResponse[] voption>
mailbox : TscMailbox
parameters : GetDiagnosticsParams
Returns: Async<DiagnosticResponse[] voption>

AsyncApi.getSymbolAtLocation mailbox parameters

Full Usage: AsyncApi.getSymbolAtLocation mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : GetSymbolAtLocationParams
Returns: Async<SymbolResponse voption>

AsyncApi.getSymbolAtPosition mailbox parameters

Full Usage: AsyncApi.getSymbolAtPosition mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : GetSymbolAtPositionParams
Returns: Async<SymbolResponse voption>

AsyncApi.getSymbolOfSourceFile mailbox parameters

Full Usage: AsyncApi.getSymbolOfSourceFile mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : GetSymbolOfSourceFileParams
Returns: Async<SymbolResponse voption>

AsyncApi.getSymbolOfType mailbox parameters

Full Usage: AsyncApi.getSymbolOfType mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<SymbolResponse voption>

AsyncApi.getSymbolsAtLocations mailbox parameters

Full Usage: AsyncApi.getSymbolsAtLocations mailbox parameters

Parameters:
Returns: Async<SymbolResponse[]>
mailbox : TscMailbox
parameters : GetSymbolsAtLocationsParams
Returns: Async<SymbolResponse[]>

AsyncApi.getSymbolsAtPositions mailbox parameters

Full Usage: AsyncApi.getSymbolsAtPositions mailbox parameters

Parameters:
Returns: Async<SymbolResponse[]>
mailbox : TscMailbox
parameters : GetSymbolsAtPositionsParams
Returns: Async<SymbolResponse[]>

AsyncApi.getSymbolsInScope mailbox parameters

Full Usage: AsyncApi.getSymbolsInScope mailbox parameters

Parameters:
Returns: Async<SymbolResponse[]>
mailbox : TscMailbox
parameters : GetSymbolsInScopeParams
Returns: Async<SymbolResponse[]>

AsyncApi.getSymbolsOfSourceFiles mailbox parameters

Full Usage: AsyncApi.getSymbolsOfSourceFiles mailbox parameters

Parameters:
Returns: Async<SymbolResponse[]>
mailbox : TscMailbox
parameters : GetSymbolsOfSourceFilesParams
Returns: Async<SymbolResponse[]>

AsyncApi.getSyntacticDiagnostics mailbox parameters

Full Usage: AsyncApi.getSyntacticDiagnostics mailbox parameters

Parameters:
Returns: Async<DiagnosticResponse[] voption>
mailbox : TscMailbox
parameters : GetDiagnosticsParams
Returns: Async<DiagnosticResponse[] voption>

AsyncApi.getTargetOfSignature mailbox parameters

Full Usage: AsyncApi.getTargetOfSignature mailbox parameters

Parameters:
Returns: Async<SignatureResponse voption>
mailbox : TscMailbox
parameters : GetSignaturePropertyParams
Returns: Async<SignatureResponse voption>

AsyncApi.getTargetOfType mailbox parameters

Full Usage: AsyncApi.getTargetOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getTargetSymbol mailbox parameters

Full Usage: AsyncApi.getTargetSymbol mailbox parameters

Parameters:
Returns: Async<SymbolResponse>
mailbox : TscMailbox
parameters : CheckerSymbolParams
Returns: Async<SymbolResponse>

AsyncApi.getThisParameterOfSignature mailbox parameters

Full Usage: AsyncApi.getThisParameterOfSignature mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : GetSignaturePropertyParams
Returns: Async<SymbolResponse voption>

AsyncApi.getTrueTypeOfConditionalType mailbox parameters

Full Usage: AsyncApi.getTrueTypeOfConditionalType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse>

AsyncApi.getTypeArguments mailbox parameters

Full Usage: AsyncApi.getTypeArguments mailbox parameters

Parameters:
Returns: Async<TypeResponse[] voption>
mailbox : TscMailbox
parameters : CheckerTypeParams
Returns: Async<TypeResponse[] voption>

AsyncApi.getTypeAtLocation mailbox parameters

Full Usage: AsyncApi.getTypeAtLocation mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypeAtLocationParams
Returns: Async<TypeResponse>

AsyncApi.getTypeAtLocations mailbox parameters

Full Usage: AsyncApi.getTypeAtLocations mailbox parameters

Parameters:
Returns: Async<TypeResponse[]>
mailbox : TscMailbox
parameters : GetTypeAtLocationsParams
Returns: Async<TypeResponse[]>

AsyncApi.getTypeAtPosition mailbox parameters

Full Usage: AsyncApi.getTypeAtPosition mailbox parameters

Parameters:
Returns: Async<TypeResponse voption>
mailbox : TscMailbox
parameters : GetTypeAtPositionParams
Returns: Async<TypeResponse voption>

AsyncApi.getTypeFromTypeNode mailbox parameters

Full Usage: AsyncApi.getTypeFromTypeNode mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypeFromTypeNodeParams
Returns: Async<TypeResponse>

AsyncApi.getTypeOfSymbol mailbox parameters

Full Usage: AsyncApi.getTypeOfSymbol mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypeOfSymbolParams
Returns: Async<TypeResponse>

AsyncApi.getTypeOfSymbolAtLocation mailbox parameters

Full Usage: AsyncApi.getTypeOfSymbolAtLocation mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetTypeOfSymbolAtLocationParams
Returns: Async<TypeResponse>

AsyncApi.getTypeParameterAtPosition mailbox parameters

Full Usage: AsyncApi.getTypeParameterAtPosition mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetParameterTypeParams
Returns: Async<TypeResponse>

AsyncApi.getTypeParametersOfSignature mailbox parameters

Full Usage: AsyncApi.getTypeParametersOfSignature mailbox parameters

Parameters:
Returns: Async<TypeResponse[] voption>
mailbox : TscMailbox
parameters : GetSignaturePropertyParams
Returns: Async<TypeResponse[] voption>

AsyncApi.getTypeParametersOfType mailbox parameters

Full Usage: AsyncApi.getTypeParametersOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse[] voption>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse[] voption>

AsyncApi.getTypePredicateOfSignature mailbox parameters

Full Usage: AsyncApi.getTypePredicateOfSignature mailbox parameters

Parameters:
Returns: Async<TypePredicateResponse voption>
mailbox : TscMailbox
parameters : CheckerSignatureParams
Returns: Async<TypePredicateResponse voption>

AsyncApi.getTypesAtPositions mailbox parameters

Full Usage: AsyncApi.getTypesAtPositions mailbox parameters

Parameters:
Returns: Async<TypeResponse[]>
mailbox : TscMailbox
parameters : GetTypesAtPositionsParams
Returns: Async<TypeResponse[]>

AsyncApi.getTypesOfSymbols mailbox parameters

Full Usage: AsyncApi.getTypesOfSymbols mailbox parameters

Parameters:
Returns: Async<TypeResponse[]>
mailbox : TscMailbox
parameters : GetTypesOfSymbolsParams
Returns: Async<TypeResponse[]>

AsyncApi.getTypesOfType mailbox parameters

Full Usage: AsyncApi.getTypesOfType mailbox parameters

Parameters:
Returns: Async<TypeResponse[] voption>
mailbox : TscMailbox
parameters : GetTypePropertyParams
Returns: Async<TypeResponse[] voption>

AsyncApi.getUndefinedType mailbox parameters

Full Usage: AsyncApi.getUndefinedType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getUnknownType mailbox parameters

Full Usage: AsyncApi.getUnknownType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getVoidType mailbox parameters

Full Usage: AsyncApi.getVoidType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<TypeResponse>

AsyncApi.getWellKnownSignatures mailbox parameters

Full Usage: AsyncApi.getWellKnownSignatures mailbox parameters

Parameters:
Returns: Async<WellKnownSignaturesResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<WellKnownSignaturesResponse>

AsyncApi.getWellKnownSymbols mailbox parameters

Full Usage: AsyncApi.getWellKnownSymbols mailbox parameters

Parameters:
Returns: Async<WellKnownSymbolsResponse>
mailbox : TscMailbox
parameters : GetIntrinsicTypeParams
Returns: Async<WellKnownSymbolsResponse>

AsyncApi.getWidenedType mailbox parameters

Full Usage: AsyncApi.getWidenedType mailbox parameters

Parameters:
Returns: Async<TypeResponse>
mailbox : TscMailbox
parameters : GetWidenedTypeParams
Returns: Async<TypeResponse>

AsyncApi.initialize mailbox

Full Usage: AsyncApi.initialize mailbox

Parameters:
Returns: Async<InitializeResponse>
mailbox : TscMailbox
Returns: Async<InitializeResponse>

AsyncApi.isArrayLikeType mailbox parameters

Full Usage: AsyncApi.isArrayLikeType mailbox parameters

Parameters:
Returns: Async<bool>
mailbox : TscMailbox
parameters : IsArrayLikeTypeParams
Returns: Async<bool>

AsyncApi.isArrayType mailbox parameters

Full Usage: AsyncApi.isArrayType mailbox parameters

Parameters:
Returns: Async<bool>
mailbox : TscMailbox
parameters : CheckerTypeParams
Returns: Async<bool>

AsyncApi.isContextSensitive mailbox parameters

Full Usage: AsyncApi.isContextSensitive mailbox parameters

Parameters:
Returns: Async<bool>
mailbox : TscMailbox
parameters : GetContextualTypeParams
Returns: Async<bool>

AsyncApi.isReadonlySymbol mailbox parameters

Full Usage: AsyncApi.isReadonlySymbol mailbox parameters

Parameters:
Returns: Async<bool>
mailbox : TscMailbox
parameters : CheckerSymbolParams
Returns: Async<bool>

AsyncApi.isTypeAssignableTo mailbox parameters

Full Usage: AsyncApi.isTypeAssignableTo mailbox parameters

Parameters:
Returns: Async<bool>
mailbox : TscMailbox
parameters : IsTypeAssignableToParams
Returns: Async<bool>

AsyncApi.parseCommandLine mailbox parameters

Full Usage: AsyncApi.parseCommandLine mailbox parameters

Parameters:
Returns: Async<ConfigFileResponse>
mailbox : TscMailbox
parameters : ParseCommandLineParams
Returns: Async<ConfigFileResponse>

AsyncApi.parseConfigFile mailbox parameters

Full Usage: AsyncApi.parseConfigFile mailbox parameters

Parameters:
Returns: Async<ConfigFileResponse>
mailbox : TscMailbox
parameters : ParseConfigFileParams
Returns: Async<ConfigFileResponse>

AsyncApi.parseJsonConfigFileContent mailbox parameters

Full Usage: AsyncApi.parseJsonConfigFileContent mailbox parameters

Parameters:
Returns: Async<ConfigFileResponse>
mailbox : TscMailbox
parameters : ParseJsonConfigFileContentParams
Returns: Async<ConfigFileResponse>

AsyncApi.printNode mailbox parameters

Full Usage: AsyncApi.printNode mailbox parameters

Parameters:
Returns: Async<string>
mailbox : TscMailbox
parameters : PrintNodeParams
Returns: Async<string>

AsyncApi.readConfigFile mailbox parameters

Full Usage: AsyncApi.readConfigFile mailbox parameters

Parameters:
Returns: Async<ReadConfigFileResponse>
mailbox : TscMailbox
parameters : ReadConfigFileParams
Returns: Async<ReadConfigFileResponse>

AsyncApi.release mailbox parameters

Full Usage: AsyncApi.release mailbox parameters

Parameters:
Returns: Async<unit>
mailbox : TscMailbox
parameters : ReleaseParams
Returns: Async<unit>

AsyncApi.resolveName mailbox parameters

Full Usage: AsyncApi.resolveName mailbox parameters

Parameters:
Returns: Async<SymbolResponse voption>
mailbox : TscMailbox
parameters : ResolveNameParams
Returns: Async<SymbolResponse voption>

AsyncApi.saveHeapProfile mailbox parameters

Full Usage: AsyncApi.saveHeapProfile mailbox parameters

Parameters:
Returns: Async<ProfileResult>
mailbox : TscMailbox
parameters : ProfileParams
Returns: Async<ProfileResult>

AsyncApi.signatureToSignatureDeclaration mailbox parameters

Full Usage: AsyncApi.signatureToSignatureDeclaration mailbox parameters

Parameters:
Returns: Async<SourceFile voption>

Returns the decoded binary AST, not the schema's `SourceFileResponse` JSON envelope. The mailbox normalises the two encodings the transport uses for it, so this is the same result whether the request travelled alone or inside a batch.

mailbox : TscMailbox
parameters : SignatureToSignatureDeclarationParams
Returns: Async<SourceFile voption>

AsyncApi.startCPUProfile mailbox parameters

Full Usage: AsyncApi.startCPUProfile mailbox parameters

Parameters:
Returns: Async<unit>
mailbox : TscMailbox
parameters : ProfileParams
Returns: Async<unit>

AsyncApi.stopCPUProfile mailbox

Full Usage: AsyncApi.stopCPUProfile mailbox

Parameters:
Returns: Async<ProfileResult>
mailbox : TscMailbox
Returns: Async<ProfileResult>

AsyncApi.transpileDeclaration mailbox parameters

Full Usage: AsyncApi.transpileDeclaration mailbox parameters

Parameters:
Returns: Async<TranspileOutputResponse>
mailbox : TscMailbox
parameters : TranspileParams
Returns: Async<TranspileOutputResponse>

AsyncApi.transpileDeclarationFromFile mailbox parameters

Full Usage: AsyncApi.transpileDeclarationFromFile mailbox parameters

Parameters:
Returns: Async<TranspileOutputResponse>
mailbox : TscMailbox
parameters : TranspileFromFileParams
Returns: Async<TranspileOutputResponse>

AsyncApi.transpileModule mailbox parameters

Full Usage: AsyncApi.transpileModule mailbox parameters

Parameters:
Returns: Async<TranspileOutputResponse>
mailbox : TscMailbox
parameters : TranspileParams
Returns: Async<TranspileOutputResponse>

AsyncApi.transpileModuleFromFile mailbox parameters

Full Usage: AsyncApi.transpileModuleFromFile mailbox parameters

Parameters:
Returns: Async<TranspileOutputResponse>
mailbox : TscMailbox
parameters : TranspileFromFileParams
Returns: Async<TranspileOutputResponse>

AsyncApi.typeToString mailbox parameters

Full Usage: AsyncApi.typeToString mailbox parameters

Parameters:
Returns: Async<JsonNode voption>
mailbox : TscMailbox
parameters : TypeToTypeNodeParams
Returns: Async<JsonNode voption>

AsyncApi.typeToTypeNode mailbox parameters

Full Usage: AsyncApi.typeToTypeNode mailbox parameters

Parameters:
Returns: Async<SourceFile voption>

Returns the decoded binary AST, not the schema's `SourceFileResponse` JSON envelope. The mailbox normalises the two encodings the transport uses for it, so this is the same result whether the request travelled alone or inside a batch.

mailbox : TscMailbox
parameters : TypeToTypeNodeParams
Returns: Async<SourceFile voption>

AsyncApi.updateSnapshot mailbox parameters

Full Usage: AsyncApi.updateSnapshot mailbox parameters

Parameters:
Returns: Async<UpdateSnapshotResponse>
mailbox : TscMailbox
parameters : UpdateSnapshotParams
Returns: Async<UpdateSnapshotResponse>

AsyncApi.updateTemporarySnapshot mailbox parameters

Full Usage: AsyncApi.updateTemporarySnapshot mailbox parameters

Parameters:
Returns: Async<UpdateSnapshotResponse>
mailbox : TscMailbox
parameters : UpdateTemporarySnapshotParams
Returns: Async<UpdateSnapshotResponse>

Type something to start searching.