TypeChecker | typescript

Hierarchy

TypeChecker

Index

Methods

getAliasedSymbol

getAliasedSymbol(symbol: Symbol): Symbol

- Defined in lib/typescript.d.ts:2227
Follow all aliases to get the original symbol.

Parameters
- symbol: Symbol
Returns Symbol

getAmbientModules

getAmbientModules(): Symbol[]

- Defined in lib/typescript.d.ts:2231
Returns Symbol[]

getApparentType

getApparentType(type: Type): Type

- Defined in lib/typescript.d.ts:2233
Parameters
- type: Type
Returns Type

getAugmentedPropertiesOfType

getAugmentedPropertiesOfType(type: Type): Symbol[]

- Defined in lib/typescript.d.ts:2209
Parameters
- type: Type
Returns Symbol[]

getBaseConstraintOfType

getBaseConstraintOfType(type: Type): Type

- Defined in lib/typescript.d.ts:2234
Parameters
- type: Type
Returns Type

getBaseTypeOfLiteralType

getBaseTypeOfLiteralType(type: Type): Type

- Defined in lib/typescript.d.ts:2158
Parameters
- type: Type
Returns Type

getBaseTypes

getBaseTypes(type: InterfaceType): BaseType[]

- Defined in lib/typescript.d.ts:2157
Parameters
- type: InterfaceType
Returns BaseType[]

getConstantValue

getConstantValue(node: EnumMember | ElementAccessExpression | PropertyAccessExpression): string | number

- Defined in lib/typescript.d.ts:2224
Parameters
- node: EnumMember | ElementAccessExpression | PropertyAccessExpression
Returns string | number

getContextualType

getContextualType(node: Expression): Type

- Defined in lib/typescript.d.ts:2212
Parameters
- node: Expression
Returns Type

getDeclaredTypeOfSymbol

getDeclaredTypeOfSymbol(symbol: Symbol): Type

- Defined in lib/typescript.d.ts:2150
Parameters
- symbol: Symbol
Returns Type

getDefaultFromTypeParameter

getDefaultFromTypeParameter(type: Type): Type

- Defined in lib/typescript.d.ts:2235
Parameters
- type: Type
Returns Type

getExportSpecifierLocalTargetSymbol

getExportSpecifierLocalTargetSymbol(location: Identifier | ExportSpecifier): Symbol

- Defined in lib/typescript.d.ts:2190
Parameters
- location: Identifier | ExportSpecifier
Returns Symbol

getExportSymbolOfSymbol

getExportSymbolOfSymbol(symbol: Symbol): Symbol

- Defined in lib/typescript.d.ts:2199
If a symbol is a local symbol with an associated exported symbol, returns the exported symbol. Otherwise returns its input. For example, at export type T = number;: - getSymbolAtLocation at the location T will return the exported symbol for T. - But the result of getSymbolsInScope will contain the local symbol for T, not the exported symbol. - Calling getExportSymbolOfSymbol on that local symbol will return the exported symbol.

Parameters
- symbol: Symbol
Returns Symbol

getExportsOfModule

getExportsOfModule(moduleSymbol: Symbol): Symbol[]

- Defined in lib/typescript.d.ts:2228
Parameters
- moduleSymbol: Symbol
Returns Symbol[]

getFullyQualifiedName

getFullyQualifiedName(symbol: Symbol): string

- Defined in lib/typescript.d.ts:2208
Parameters
- symbol: Symbol
Returns string

getIndexInfoOfType

getIndexInfoOfType(type: Type, kind: IndexKind): IndexInfo

- Defined in lib/typescript.d.ts:2154
Parameters
- type: Type
- kind: IndexKind
Returns IndexInfo

getIndexTypeOfType

getIndexTypeOfType(type: Type, kind: IndexKind): Type

- Defined in lib/typescript.d.ts:2156
Parameters
- type: Type
- kind: IndexKind
Returns Type

getJsxIntrinsicTagNamesAt

getJsxIntrinsicTagNamesAt(location: Node): Symbol[]

- Defined in lib/typescript.d.ts:2229
Parameters
- location: Node
Returns Symbol[]

getNonNullableType

getNonNullableType(type: Type): Type

- Defined in lib/typescript.d.ts:2162
Parameters
- type: Type
Returns Type

getNullableType

getNullableType(type: Type, flags: TypeFlags): Type

- Defined in lib/typescript.d.ts:2161
Parameters
- type: Type
- flags: TypeFlags
Returns Type

getPrivateIdentifierPropertyOfType

getPrivateIdentifierPropertyOfType(leftType: Type, name: string, location: Node): Symbol

- Defined in lib/typescript.d.ts:2153
Parameters
- leftType: Type
- name: string
- location: Node
Returns Symbol

getPropertiesOfType

getPropertiesOfType(type: Type): Symbol[]

- Defined in lib/typescript.d.ts:2151
Parameters
- type: Type
Returns Symbol[]

getPropertyOfType

getPropertyOfType(type: Type, propertyName: string): Symbol

- Defined in lib/typescript.d.ts:2152
Parameters
- type: Type
- propertyName: string
Returns Symbol

getPropertySymbolOfDestructuringAssignment

getPropertySymbolOfDestructuringAssignment(location: Identifier): Symbol

- Defined in lib/typescript.d.ts:2200
Parameters
- location: Identifier
Returns Symbol

getResolvedSignature

getResolvedSignature(node: CallLikeExpression, candidatesOutArray?: Signature[], argumentCount?: number): Signature

- Defined in lib/typescript.d.ts:2218
returns unknownSignature in the case of an error. returns undefined if the node is not valid.

Parameters
- node: CallLikeExpression
- Optional candidatesOutArray: Signature[]
- Optional argumentCount: number
  
  Apparent number of arguments, passed in case of a possibly incomplete call. This should come from an ArgumentListInfo. See signatureHelp.ts.
Returns Signature

getReturnTypeOfSignature

getReturnTypeOfSignature(signature: Signature): Type

- Defined in lib/typescript.d.ts:2160
Parameters
- signature: Signature
Returns Type

getRootSymbols

getRootSymbols(symbol: Symbol): readonly Symbol[]

- Defined in lib/typescript.d.ts:2210
Parameters
- symbol: Symbol
Returns readonly Symbol[]

getShorthandAssignmentValueSymbol

getShorthandAssignmentValueSymbol(location: Node): Symbol

- Defined in lib/typescript.d.ts:2189
The function returns the value (local variable) symbol of an identifier in the short-hand property assignment. This is necessary as an identifier in short-hand property assignment can contains two meaning: property name and property value.

Parameters
- location: Node
Returns Symbol

getSignatureFromDeclaration

getSignatureFromDeclaration(declaration: SignatureDeclaration): Signature

- Defined in lib/typescript.d.ts:2219
Parameters
- declaration: SignatureDeclaration
Returns Signature

getSignaturesOfType

getSignaturesOfType(type: Type, kind: SignatureKind): readonly Signature[]

- Defined in lib/typescript.d.ts:2155
Parameters
- type: Type
- kind: SignatureKind
Returns readonly Signature[]

getSymbolAtLocation

getSymbolAtLocation(node: Node): Symbol

- Defined in lib/typescript.d.ts:2183
Parameters
- node: Node
Returns Symbol

getSymbolOfExpando

getSymbolOfExpando(node: Node, allowDeclaration: boolean): Symbol

- Defined in lib/typescript.d.ts:2211
Parameters
- node: Node
- allowDeclaration: boolean
Returns Symbol

getSymbolsInScope

getSymbolsInScope(location: Node, meaning: SymbolFlags): Symbol[]

- Defined in lib/typescript.d.ts:2182
Parameters
- location: Node
- meaning: SymbolFlags
Returns Symbol[]

getSymbolsOfParameterPropertyDeclaration

getSymbolsOfParameterPropertyDeclaration(parameter: ParameterDeclaration, parameterName: string): Symbol[]

- Defined in lib/typescript.d.ts:2184
Parameters
- parameter: ParameterDeclaration
- parameterName: string
Returns Symbol[]

getTypeArguments

getTypeArguments(type: TypeReference): readonly Type[]

- Defined in lib/typescript.d.ts:2163
Parameters
- type: TypeReference
Returns readonly Type[]

getTypeAtLocation

getTypeAtLocation(node: Node): Type

- Defined in lib/typescript.d.ts:2202
Parameters
- node: Node
Returns Type

getTypeFromTypeNode

getTypeFromTypeNode(node: TypeNode): Type

- Defined in lib/typescript.d.ts:2203
Parameters
- node: TypeNode
Returns Type

getTypeOfAssignmentPattern

getTypeOfAssignmentPattern(pattern: AssignmentPattern): Type

- Defined in lib/typescript.d.ts:2201
Parameters
- pattern: AssignmentPattern
Returns Type

getTypeOfSymbolAtLocation

getTypeOfSymbolAtLocation(symbol: Symbol, node: Node): Type

- Defined in lib/typescript.d.ts:2149
Parameters
- symbol: Symbol
- node: Node
Returns Type

getWidenedType

getWidenedType(type: Type): Type

- Defined in lib/typescript.d.ts:2159
Parameters
- type: Type
Returns Type

indexInfoToIndexSignatureDeclaration

indexInfoToIndexSignatureDeclaration(indexInfo: IndexInfo, kind: IndexKind, enclosingDeclaration: Node, flags: NodeBuilderFlags): IndexSignatureDeclaration

- Defined in lib/typescript.d.ts:2171
Note that the resulting nodes cannot be checked.

Parameters
- indexInfo: IndexInfo
- kind: IndexKind
- enclosingDeclaration: Node
- flags: NodeBuilderFlags
Returns IndexSignatureDeclaration

isArgumentsSymbol

isArgumentsSymbol(symbol: Symbol): boolean

- Defined in lib/typescript.d.ts:2222
Parameters
- symbol: Symbol
Returns boolean

isImplementationOfOverload

isImplementationOfOverload(node: SignatureDeclaration): boolean

- Defined in lib/typescript.d.ts:2220
Parameters
- node: SignatureDeclaration
Returns boolean

isOptionalParameter

isOptionalParameter(node: ParameterDeclaration): boolean

- Defined in lib/typescript.d.ts:2230
Parameters
- node: ParameterDeclaration
Returns boolean

isUndefinedSymbol

isUndefinedSymbol(symbol: Symbol): boolean

- Defined in lib/typescript.d.ts:2221
Parameters
- symbol: Symbol
Returns boolean

isUnknownSymbol

isUnknownSymbol(symbol: Symbol): boolean

- Defined in lib/typescript.d.ts:2223
Parameters
- symbol: Symbol
Returns boolean

isValidPropertyAccess

isValidPropertyAccess(node: QualifiedName | PropertyAccessExpression | ImportTypeNode, propertyName: string): boolean

- Defined in lib/typescript.d.ts:2225
Parameters
- node: QualifiedName | PropertyAccessExpression | ImportTypeNode
- propertyName: string
Returns boolean

runWithCancellationToken

runWithCancellationToken<T>(token: CancellationToken, cb: (checker: TypeChecker) => T): T

- Defined in lib/typescript.d.ts:2241
Depending on the operation performed, it may be appropriate to throw away the checker if the cancellation token is triggered. Typically, if it is used for error checking and the operation is cancelled, then it should be discarded, otherwise it is safe to keep.

Type parameters
- T
Parameters
- token: CancellationToken
- cb: (checker: TypeChecker) => T
  - - (checker: TypeChecker): T
    - Parameters
      - checker: TypeChecker
      Returns T
Returns T

signatureToSignatureDeclaration

signatureToSignatureDeclaration(signature: Signature, kind: SyntaxKind, enclosingDeclaration: Node, flags: NodeBuilderFlags): CallSignatureDeclaration & { typeArguments?: NodeArray<TypeNode> } & ConstructSignatureDeclaration & { typeArguments?: NodeArray<TypeNode> } & MethodSignature & { typeArguments?: NodeArray<TypeNode> } & ArrowFunction & { typeArguments?: NodeArray<TypeNode> } & FunctionExpression & { typeArguments?: NodeArray<TypeNode> } & FunctionDeclaration & { typeArguments?: NodeArray<TypeNode> } & ConstructorDeclaration & { typeArguments?: NodeArray<TypeNode> } & MethodDeclaration & { typeArguments?: NodeArray<TypeNode> } & GetAccessorDeclaration & { typeArguments?: NodeArray<TypeNode> } & SetAccessorDeclaration & { typeArguments?: NodeArray<TypeNode> } & IndexSignatureDeclaration & { typeArguments?: NodeArray<TypeNode> } & FunctionTypeNode & { typeArguments?: NodeArray<TypeNode> } & ConstructorTypeNode & { typeArguments?: NodeArray<TypeNode> } & JSDocFunctionType & { typeArguments?: NodeArray<TypeNode> }

- Defined in lib/typescript.d.ts:2167
Note that the resulting nodes cannot be checked.

Parameters
- signature: Signature
- kind: SyntaxKind
- enclosingDeclaration: Node
- flags: NodeBuilderFlags
Returns CallSignatureDeclaration & { typeArguments?: NodeArray<TypeNode> } & ConstructSignatureDeclaration & { typeArguments?: NodeArray<TypeNode> } & MethodSignature & { typeArguments?: NodeArray<TypeNode> } & ArrowFunction & { typeArguments?: NodeArray<TypeNode> } & FunctionExpression & { typeArguments?: NodeArray<TypeNode> } & FunctionDeclaration & { typeArguments?: NodeArray<TypeNode> } & ConstructorDeclaration & { typeArguments?: NodeArray<TypeNode> } & MethodDeclaration & { typeArguments?: NodeArray<TypeNode> } & GetAccessorDeclaration & { typeArguments?: NodeArray<TypeNode> } & SetAccessorDeclaration & { typeArguments?: NodeArray<TypeNode> } & IndexSignatureDeclaration & { typeArguments?: NodeArray<TypeNode> } & FunctionTypeNode & { typeArguments?: NodeArray<TypeNode> } & ConstructorTypeNode & { typeArguments?: NodeArray<TypeNode> } & JSDocFunctionType & { typeArguments?: NodeArray<TypeNode> }

signatureToString

signatureToString(signature: Signature, enclosingDeclaration?: Node, flags?: TypeFormatFlags, kind?: SignatureKind): string

- Defined in lib/typescript.d.ts:2204
Parameters
- signature: Signature
- Optional enclosingDeclaration: Node
- Optional flags: TypeFormatFlags
- Optional kind: SignatureKind
Returns string

symbolToEntityName

symbolToEntityName(symbol: Symbol, meaning: SymbolFlags, enclosingDeclaration: Node, flags: NodeBuilderFlags): EntityName

- Defined in lib/typescript.d.ts:2173
Note that the resulting nodes cannot be checked.

Parameters
- symbol: Symbol
- meaning: SymbolFlags
- enclosingDeclaration: Node
- flags: NodeBuilderFlags
Returns EntityName

symbolToExpression

symbolToExpression(symbol: Symbol, meaning: SymbolFlags, enclosingDeclaration: Node, flags: NodeBuilderFlags): Expression

- Defined in lib/typescript.d.ts:2175
Note that the resulting nodes cannot be checked.

Parameters
- symbol: Symbol
- meaning: SymbolFlags
- enclosingDeclaration: Node
- flags: NodeBuilderFlags
Returns Expression

symbolToParameterDeclaration

symbolToParameterDeclaration(symbol: Symbol, enclosingDeclaration: Node, flags: NodeBuilderFlags): ParameterDeclaration

- Defined in lib/typescript.d.ts:2179
Note that the resulting nodes cannot be checked.

Parameters
- symbol: Symbol
- enclosingDeclaration: Node
- flags: NodeBuilderFlags
Returns ParameterDeclaration

symbolToString

symbolToString(symbol: Symbol, enclosingDeclaration?: Node, meaning?: SymbolFlags, flags?: SymbolFormatFlags): string

- Defined in lib/typescript.d.ts:2206
Parameters
- symbol: Symbol
- Optional enclosingDeclaration: Node
- Optional meaning: SymbolFlags
- Optional flags: SymbolFormatFlags
Returns string

symbolToTypeParameterDeclarations

symbolToTypeParameterDeclarations(symbol: Symbol, enclosingDeclaration: Node, flags: NodeBuilderFlags): NodeArray<TypeParameterDeclaration>

- Defined in lib/typescript.d.ts:2177
Note that the resulting nodes cannot be checked.

Parameters
- symbol: Symbol
- enclosingDeclaration: Node
- flags: NodeBuilderFlags
Returns NodeArray<TypeParameterDeclaration>

tryGetMemberInModuleExports

tryGetMemberInModuleExports(memberName: string, moduleSymbol: Symbol): Symbol

- Defined in lib/typescript.d.ts:2232
Parameters
- memberName: string
- moduleSymbol: Symbol
Returns Symbol

typeParameterToDeclaration

typeParameterToDeclaration(parameter: TypeParameter, enclosingDeclaration: Node, flags: NodeBuilderFlags): TypeParameterDeclaration

- Defined in lib/typescript.d.ts:2181
Note that the resulting nodes cannot be checked.

Parameters
- parameter: TypeParameter
- enclosingDeclaration: Node
- flags: NodeBuilderFlags
Returns TypeParameterDeclaration

typePredicateToString

typePredicateToString(predicate: TypePredicate, enclosingDeclaration?: Node, flags?: TypeFormatFlags): string

- Defined in lib/typescript.d.ts:2207
Parameters
- predicate: TypePredicate
- Optional enclosingDeclaration: Node
- Optional flags: TypeFormatFlags
Returns string

typeToString

typeToString(type: Type, enclosingDeclaration?: Node, flags?: TypeFormatFlags): string

- Defined in lib/typescript.d.ts:2205
Parameters
- type: Type
- Optional enclosingDeclaration: Node
- Optional flags: TypeFormatFlags
Returns string

typeToTypeNode

typeToTypeNode(type: Type, enclosingDeclaration: Node, flags: NodeBuilderFlags): TypeNode

- Defined in lib/typescript.d.ts:2165
Note that the resulting nodes cannot be checked.

Parameters
- type: Type
- enclosingDeclaration: Node
- flags: NodeBuilderFlags
Returns TypeNode

Hierarchy

Index

Methods

Methods

getAliasedSymbol

Parameters

symbol: Symbol

Returns Symbol

getAmbientModules

Returns Symbol[]

getApparentType

Parameters

type: Type

Returns Type

getAugmentedPropertiesOfType

Parameters

type: Type

Returns Symbol[]

getBaseConstraintOfType

Parameters

type: Type

Returns Type

getBaseTypeOfLiteralType

Parameters

type: Type

Returns Type

getBaseTypes

Parameters

type: InterfaceType

Returns BaseType[]

getConstantValue

Parameters

node: EnumMember | ElementAccessExpression | PropertyAccessExpression

Returns string | number

getContextualType

Parameters

node: Expression

Returns Type

getDeclaredTypeOfSymbol

Parameters

symbol: Symbol

Returns Type

getDefaultFromTypeParameter

Parameters

type: Type

Returns Type

getExportSpecifierLocalTargetSymbol

Parameters

location: Identifier | ExportSpecifier

Returns Symbol

getExportSymbolOfSymbol

Parameters

symbol: Symbol

Returns Symbol

getExportsOfModule

Parameters

moduleSymbol: Symbol

Returns Symbol[]

getFullyQualifiedName

Parameters

symbol: Symbol

Returns string

getIndexInfoOfType

Parameters

type: Type

kind: IndexKind

Returns IndexInfo

getIndexTypeOfType

Parameters

type: Type

kind: IndexKind

Returns Type

getJsxIntrinsicTagNamesAt

Parameters

location: Node

Returns Symbol[]

getNonNullableType

Parameters

type: Type

Returns Type