internal/checker/types.go (976 lines of code) (raw):
// MODIFIED IN THIS FORK: 2025-07-24 Aleksei Berezkin 5567c01219bf93fad344a80691da5df021923d10 WEB-74070 Supported the method IdeGetResolvedSignature
// MODIFIED IN THIS FORK: 2025-05-21 Piotr Tomiak dfd337df3e64d6fb2bc18c46bf4de05bcbea5a64 Support WebStorm types in LSP mode
package checker
import (
"slices"
"github.com/microsoft/typescript-go/internal/ast"
"github.com/microsoft/typescript-go/internal/collections"
"github.com/microsoft/typescript-go/internal/core"
"github.com/microsoft/typescript-go/internal/evaluator"
)
//go:generate go tool golang.org/x/tools/cmd/stringer -type=SignatureKind -output=stringer_generated.go
//go:generate go tool mvdan.cc/gofumpt -w stringer_generated.go
// ParseFlags
type ParseFlags uint32
const (
ParseFlagsNone ParseFlags = 0
ParseFlagsYield ParseFlags = 1 << 0
ParseFlagsAwait ParseFlags = 1 << 1
ParseFlagsType ParseFlags = 1 << 2
ParseFlagsIgnoreMissingOpenBrace ParseFlags = 1 << 4
ParseFlagsJSDoc ParseFlags = 1 << 5
)
type SignatureKind int32
const (
SignatureKindCall SignatureKind = iota
SignatureKindConstruct
)
type ContextFlags uint32
const (
ContextFlagsNone ContextFlags = 0
ContextFlagsSignature ContextFlags = 1 << 0 // Obtaining contextual signature
ContextFlagsNoConstraints ContextFlags = 1 << 1 // Don't obtain type variable constraints
ContextFlagsCompletions ContextFlags = 1 << 2 // Ignore inference to current node and parent nodes out to the containing call for completions
ContextFlagsSkipBindingPatterns ContextFlags = 1 << 3 // Ignore contextual types applied by binding patterns
)
type TypeFormatFlags uint32
const (
TypeFormatFlagsNone TypeFormatFlags = 0
TypeFormatFlagsNoTruncation TypeFormatFlags = 1 << 0 // Don't truncate typeToString result
TypeFormatFlagsWriteArrayAsGenericType TypeFormatFlags = 1 << 1 // Write Array<T> instead T[]
TypeFormatFlagsGenerateNamesForShadowedTypeParams TypeFormatFlags = 1 << 2 // When a type parameter T is shadowing another T, generate a name for it so it can still be referenced
TypeFormatFlagsUseStructuralFallback TypeFormatFlags = 1 << 3 // When an alias cannot be named by its symbol, rather than report an error, fallback to a structural printout if possible
// hole because there's a hole in node builder flags
TypeFormatFlagsWriteTypeArgumentsOfSignature TypeFormatFlags = 1 << 5 // Write the type arguments instead of type parameters of the signature
TypeFormatFlagsUseFullyQualifiedType TypeFormatFlags = 1 << 6 // Write out the fully qualified type name (eg. Module.Type, instead of Type)
// hole because `UseOnlyExternalAliasing` is here in node builder flags, but functions which take old flags use `SymbolFormatFlags` instead
TypeFormatFlagsSuppressAnyReturnType TypeFormatFlags = 1 << 8 // If the return type is any-like, don't offer a return type.
// hole because `WriteTypeParametersInQualifiedName` is here in node builder flags, but functions which take old flags use `SymbolFormatFlags` for this instead
TypeFormatFlagsMultilineObjectLiterals TypeFormatFlags = 1 << 10 // Always print object literals across multiple lines (only used to map into node builder flags)
TypeFormatFlagsWriteClassExpressionAsTypeLiteral TypeFormatFlags = 1 << 11 // Write a type literal instead of (Anonymous class)
TypeFormatFlagsUseTypeOfFunction TypeFormatFlags = 1 << 12 // Write typeof instead of function type literal
TypeFormatFlagsOmitParameterModifiers TypeFormatFlags = 1 << 13 // Omit modifiers on parameters
TypeFormatFlagsUseAliasDefinedOutsideCurrentScope TypeFormatFlags = 1 << 14 // For a `type T = ... ` defined in a different file, write `T` instead of its value, even though `T` can't be accessed in the current scope.
TypeFormatFlagsUseSingleQuotesForStringLiteralType TypeFormatFlags = 1 << 28 // Use single quotes for string literal type
TypeFormatFlagsNoTypeReduction TypeFormatFlags = 1 << 29 // Don't call getReducedType
TypeFormatFlagsOmitThisParameter TypeFormatFlags = 1 << 25
TypeFormatFlagsWriteCallStyleSignature TypeFormatFlags = 1 << 27 // Write construct signatures as call style signatures
// Error Handling
TypeFormatFlagsAllowUniqueESSymbolType TypeFormatFlags = 1 << 20 // This is bit 20 to align with the same bit in `NodeBuilderFlags`
// TypeFormatFlags exclusive
TypeFormatFlagsAddUndefined TypeFormatFlags = 1 << 17 // Add undefined to types of initialized, non-optional parameters
TypeFormatFlagsWriteArrowStyleSignature TypeFormatFlags = 1 << 18 // Write arrow style signature
// State
TypeFormatFlagsInArrayType TypeFormatFlags = 1 << 19 // Writing an array element type
TypeFormatFlagsInElementType TypeFormatFlags = 1 << 21 // Writing an array or union element type
TypeFormatFlagsInFirstTypeArgument TypeFormatFlags = 1 << 22 // Writing first type argument of the instantiated type
TypeFormatFlagsInTypeAlias TypeFormatFlags = 1 << 23 // Writing type in type alias declaration
)
const TypeFormatFlagsNodeBuilderFlagsMask = TypeFormatFlagsNoTruncation | TypeFormatFlagsWriteArrayAsGenericType | TypeFormatFlagsGenerateNamesForShadowedTypeParams | TypeFormatFlagsUseStructuralFallback | TypeFormatFlagsWriteTypeArgumentsOfSignature |
TypeFormatFlagsUseFullyQualifiedType | TypeFormatFlagsSuppressAnyReturnType | TypeFormatFlagsMultilineObjectLiterals | TypeFormatFlagsWriteClassExpressionAsTypeLiteral |
TypeFormatFlagsUseTypeOfFunction | TypeFormatFlagsOmitParameterModifiers | TypeFormatFlagsUseAliasDefinedOutsideCurrentScope | TypeFormatFlagsAllowUniqueESSymbolType | TypeFormatFlagsInTypeAlias |
TypeFormatFlagsUseSingleQuotesForStringLiteralType | TypeFormatFlagsNoTypeReduction | TypeFormatFlagsOmitThisParameter
type SymbolFormatFlags uint32
const (
SymbolFormatFlagsNone SymbolFormatFlags = 0
// Write symbols's type argument if it is instantiated symbol
// eg. class C<T> { p: T } <-- Show p as C<T>.p here
// var a: C<number>;
// var p = a.p; <--- Here p is property of C<number> so show it as C<number>.p instead of just C.p
SymbolFormatFlagsWriteTypeParametersOrArguments SymbolFormatFlags = 1 << 0
// Use only external alias information to get the symbol name in the given context
// eg. module m { export class c { } } import x = m.c;
// When this flag is specified m.c will be used to refer to the class instead of alias symbol x
SymbolFormatFlagsUseOnlyExternalAliasing SymbolFormatFlags = 1 << 1
// Build symbol name using any nodes needed, instead of just components of an entity name
SymbolFormatFlagsAllowAnyNodeKind SymbolFormatFlags = 1 << 2
// Prefer aliases which are not directly visible
SymbolFormatFlagsUseAliasDefinedOutsideCurrentScope SymbolFormatFlags = 1 << 3
// { [E.A]: 1 }
/** @internal */
SymbolFormatFlagsWriteComputedProps SymbolFormatFlags = 1 << 4
// Skip building an accessible symbol chain
/** @internal */
SymbolFormatFlagsDoNotIncludeSymbolChain SymbolFormatFlags = 1 << 5
)
// Ids
type TypeId uint32
// Links for referenced symbols
type SymbolReferenceLinks struct {
referenceKinds ast.SymbolFlags // Flags for the meanings of the symbol that were referenced
}
// Links for value symbols
type ValueSymbolLinks struct {
resolvedType *Type // Type of value symbol
writeType *Type
target *ast.Symbol
mapper *TypeMapper
nameType *Type
containingType *Type // Mapped type for mapped type property, containing union or intersection type for synthetic property
}
// Additional links for mapped symbols
type MappedSymbolLinks struct {
keyType *Type // Key type for mapped type member
syntheticOrigin *ast.Symbol // For a property on a mapped or spread type, points back to the original property
}
// Additional links for deferred type symbols
type DeferredSymbolLinks struct {
parent *Type // Source union/intersection of a deferred type
constituents []*Type // Calculated list of constituents for a deferred type
writeConstituents []*Type // Constituents of a deferred `writeType`
}
// Links for alias symbols
type AliasSymbolLinks struct {
immediateTarget *ast.Symbol // Immediate target of an alias. May be another alias. Do not access directly, use `checker.getImmediateAliasedSymbol` instead.
aliasTarget *ast.Symbol // Resolved (non-alias) target of an alias
referenced bool // True if alias symbol has been referenced as a value that can be emitted
typeOnlyDeclaration *ast.Node // First resolved alias declaration that makes the symbol only usable in type constructs
}
// Links for module symbols
type ModuleSymbolLinks struct {
resolvedExports ast.SymbolTable // Resolved exports of module or combined early- and late-bound static members of a class.
typeOnlyExportStarMap map[string]*ast.Node // Set on a module symbol when some of its exports were resolved through a 'export type * from "mod"' declaration
exportsChecked bool
}
type ReverseMappedSymbolLinks struct {
propertyType *Type
mappedType *Type // References a mapped type
constraintType *Type // References an index type
}
// Links for late-bound symbols
type LateBoundLinks struct {
lateSymbol *ast.Symbol
}
// Links for export type symbols
type ExportTypeLinks struct {
target *ast.Symbol // Target symbol
originatingImport *ast.Node // Import declaration which produced the symbol, present if the symbol is marked as uncallable but had call signatures in `resolveESModuleSymbol`
}
// Links for type aliases
type TypeAliasLinks struct {
declaredType *Type
typeParameters []*Type // Type parameters of type alias (undefined if non-generic)
instantiations map[string]*Type // Instantiations of generic type alias (undefined if non-generic)
isConstructorDeclaredProperty bool
}
// Links for declared types (type parameters, class types, interface types, enums)
type DeclaredTypeLinks struct {
declaredType *Type
interfaceChecked bool
indexSignaturesChecked bool
typeParametersChecked bool
}
// Links for switch clauses
type ExhaustiveState byte
const (
ExhaustiveStateUnknown ExhaustiveState = iota // Exhaustive state not computed
ExhaustiveStateComputing // Exhaustive state computation in progress
ExhaustiveStateFalse // Switch statement is not exhaustive
ExhaustiveStateTrue // Switch statement is exhaustive
)
type SwitchStatementLinks struct {
exhaustiveState ExhaustiveState // Switch statement exhaustiveness
switchTypesComputed bool
witnessesComputed bool
switchTypes []*Type
witnesses []string
}
type ArrayLiteralLinks struct {
indicesComputed bool
firstSpreadIndex int // Index of first spread expression (or -1 if none)
lastSpreadIndex int // Index of last spread expression (or -1 if none)
}
// Links for late-binding containers
type MembersOrExportsResolutionKind int
const (
MembersOrExportsResolutionKindResolvedExports MembersOrExportsResolutionKind = 0
MembersOrExportsResolutionKindResolvedMembers MembersOrExportsResolutionKind = 1
)
type MembersAndExportsLinks [2]ast.SymbolTable // Indexed by MembersOrExportsResolutionKind
// Links for synthetic spread properties
type SpreadLinks struct {
leftSpread *ast.Symbol // Left source for synthetic spread property
rightSpread *ast.Symbol // Right source for synthetic spread property
}
// Links for variances of type aliases and interface types
type VarianceLinks struct {
variances []VarianceFlags
}
type VarianceFlags uint32
const (
VarianceFlagsInvariant VarianceFlags = 0 // Neither covariant nor contravariant
VarianceFlagsCovariant VarianceFlags = 1 << 0 // Covariant
VarianceFlagsContravariant VarianceFlags = 1 << 1 // Contravariant
VarianceFlagsBivariant VarianceFlags = VarianceFlagsCovariant | VarianceFlagsContravariant // Both covariant and contravariant
VarianceFlagsIndependent VarianceFlags = 1 << 2 // Unwitnessed type parameter
VarianceFlagsVarianceMask VarianceFlags = VarianceFlagsInvariant | VarianceFlagsCovariant | VarianceFlagsContravariant | VarianceFlagsIndependent // Mask containing all measured variances without the unmeasurable flag
VarianceFlagsUnmeasurable VarianceFlags = 1 << 3 // Variance result is unusable - relationship relies on structural comparisons which are not reflected in generic relationships
VarianceFlagsUnreliable VarianceFlags = 1 << 4 // Variance result is unreliable - checking may produce false negatives, but not false positives
VarianceFlagsAllowsStructuralFallback = VarianceFlagsUnmeasurable | VarianceFlagsUnreliable
)
type IndexSymbolLinks struct {
filteredIndexSymbolCache map[string]*ast.Symbol // Symbol with applicable declarations
}
type MarkedAssignmentSymbolLinks struct {
lastAssignmentPos int32
hasDefiniteAssignment bool // Symbol is definitely assigned somewhere
}
type accessibleChainCacheKey struct {
useOnlyExternalAliasing bool
location *ast.Node
meaning ast.SymbolFlags
}
type ContainingSymbolLinks struct {
extendedContainersByFile map[ast.NodeId][]*ast.Symbol // Symbols of nodes which which logically contain this one, cached by file the request is made within
extendedContainers *[]*ast.Symbol // Containers (other than the parent) which this symbol is aliased in
accessibleChainCache map[accessibleChainCacheKey][]*ast.Symbol
}
type AccessFlags uint32
const (
AccessFlagsNone AccessFlags = 0
AccessFlagsIncludeUndefined AccessFlags = 1 << 0
AccessFlagsNoIndexSignatures AccessFlags = 1 << 1
AccessFlagsWriting AccessFlags = 1 << 2
AccessFlagsCacheSymbol AccessFlags = 1 << 3
AccessFlagsAllowMissing AccessFlags = 1 << 4
AccessFlagsExpressionPosition AccessFlags = 1 << 5
AccessFlagsReportDeprecated AccessFlags = 1 << 6
AccessFlagsSuppressNoImplicitAnyError AccessFlags = 1 << 7
AccessFlagsContextual AccessFlags = 1 << 8
AccessFlagsPersistent = AccessFlagsIncludeUndefined
)
type NodeCheckFlags uint32
const (
NodeCheckFlagsNone NodeCheckFlags = 0
NodeCheckFlagsTypeChecked NodeCheckFlags = 1 << 0 // Node has been type checked
NodeCheckFlagsLexicalThis NodeCheckFlags = 1 << 1 // Lexical 'this' reference
NodeCheckFlagsCaptureThis NodeCheckFlags = 1 << 2 // Lexical 'this' used in body
NodeCheckFlagsCaptureNewTarget NodeCheckFlags = 1 << 3 // Lexical 'new.target' used in body
NodeCheckFlagsSuperInstance NodeCheckFlags = 1 << 4 // Instance 'super' reference
NodeCheckFlagsSuperStatic NodeCheckFlags = 1 << 5 // Static 'super' reference
NodeCheckFlagsContextChecked NodeCheckFlags = 1 << 6 // Contextual types have been assigned
NodeCheckFlagsMethodWithSuperPropertyAccessInAsync NodeCheckFlags = 1 << 7 // A method that contains a SuperProperty access in an async context.
NodeCheckFlagsMethodWithSuperPropertyAssignmentInAsync NodeCheckFlags = 1 << 8 // A method that contains a SuperProperty assignment in an async context.
NodeCheckFlagsCaptureArguments NodeCheckFlags = 1 << 9 // Lexical 'arguments' used in body
NodeCheckFlagsEnumValuesComputed NodeCheckFlags = 1 << 10 // Values for enum members have been computed, and any errors have been reported for them.
NodeCheckFlagsLoopWithCapturedBlockScopedBinding NodeCheckFlags = 1 << 12 // Loop that contains block scoped variable captured in closure
NodeCheckFlagsContainsCapturedBlockScopeBinding NodeCheckFlags = 1 << 13 // Part of a loop that contains block scoped variable captured in closure
NodeCheckFlagsCapturedBlockScopedBinding NodeCheckFlags = 1 << 14 // Block-scoped binding that is captured in some function
NodeCheckFlagsBlockScopedBindingInLoop NodeCheckFlags = 1 << 15 // Block-scoped binding with declaration nested inside iteration statement
NodeCheckFlagsNeedsLoopOutParameter NodeCheckFlags = 1 << 16 // Block scoped binding whose value should be explicitly copied outside of the converted loop
NodeCheckFlagsAssignmentsMarked NodeCheckFlags = 1 << 17 // Parameter assignments have been marked
NodeCheckFlagsContainsConstructorReference NodeCheckFlags = 1 << 18 // Class or class element that contains a binding that references the class constructor.
NodeCheckFlagsConstructorReference NodeCheckFlags = 1 << 29 // Binding to a class constructor inside of the class's body.
NodeCheckFlagsContainsClassWithPrivateIdentifiers NodeCheckFlags = 1 << 20 // Marked on all block-scoped containers containing a class with private identifiers.
NodeCheckFlagsContainsSuperPropertyInStaticInitializer NodeCheckFlags = 1 << 21 // Marked on all block-scoped containers containing a static initializer with 'super.x' or 'super[x]'.
NodeCheckFlagsInCheckIdentifier NodeCheckFlags = 1 << 22
NodeCheckFlagsPartiallyTypeChecked NodeCheckFlags = 1 << 23 // Node has been partially type checked
NodeCheckFlagsInitializerIsUndefined NodeCheckFlags = 1 << 24
NodeCheckFlagsInitializerIsUndefinedComputed NodeCheckFlags = 1 << 25
)
// Common links
type NodeLinks struct {
flags NodeCheckFlags // Set of flags specific to Node
declarationRequiresScopeChange core.Tristate // Set by `useOuterVariableScopeInParameter` in checker when downlevel emit would change the name resolution scope inside of a parameter.
hasReportedStatementInAmbientContext bool // Cache boolean if we report statements in ambient context
}
type SymbolNodeLinks struct {
resolvedSymbol *ast.Symbol // Resolved symbol associated with node
}
type TypeNodeLinks struct {
resolvedType *Type // Resolved type associated with node
outerTypeParameters []*Type // Outer type parameters of anonymous object type
}
// Links for enum members
type EnumMemberLinks struct {
value evaluator.Result // Constant value of enum member
}
// Links for assertion expressions
type AssertionLinks struct {
exprType *Type // Assertion expression type
}
// SourceFile links
type SourceFileLinks struct {
typeChecked bool
deferredNodes collections.OrderedSet[*ast.Node]
identifierCheckNodes []*ast.Node
localJsxNamespace string
localJsxFragmentNamespace string
localJsxFactory *ast.EntityName
localJsxFragmentFactory *ast.EntityName
jsxFragmentType *Type
}
// Signature specific links
type SignatureLinks struct {
resolvedSignature *Signature // Cached signature of signature node or call expression
effectsSignature *Signature // Signature with possible control flow effects
decoratorSignature *Signature // Signature for decorator as if invoked by the runtime
}
type TypeFlags uint32
// Note that for types of different kinds, the numeric values of TypeFlags determine the order
// computed by the CompareTypes function and therefore the order of constituent types in union types.
// Since union type processing often bails out early when a result is known, it is important to order
// TypeFlags in increasing order of potential type complexity. In particular, indexed access and
// conditional types should sort last as those types are potentially recursive and possibly infinite.
const (
TypeFlagsNone TypeFlags = 0
TypeFlagsAny TypeFlags = 1 << 0
TypeFlagsUnknown TypeFlags = 1 << 1
TypeFlagsUndefined TypeFlags = 1 << 2
TypeFlagsNull TypeFlags = 1 << 3
TypeFlagsVoid TypeFlags = 1 << 4
TypeFlagsString TypeFlags = 1 << 5
TypeFlagsNumber TypeFlags = 1 << 6
TypeFlagsBigInt TypeFlags = 1 << 7
TypeFlagsBoolean TypeFlags = 1 << 8
TypeFlagsESSymbol TypeFlags = 1 << 9 // Type of symbol primitive introduced in ES6
TypeFlagsStringLiteral TypeFlags = 1 << 10
TypeFlagsNumberLiteral TypeFlags = 1 << 11
TypeFlagsBigIntLiteral TypeFlags = 1 << 12
TypeFlagsBooleanLiteral TypeFlags = 1 << 13
TypeFlagsUniqueESSymbol TypeFlags = 1 << 14 // unique symbol
TypeFlagsEnumLiteral TypeFlags = 1 << 15 // Always combined with StringLiteral, NumberLiteral, or Union
TypeFlagsEnum TypeFlags = 1 << 16 // Numeric computed enum member value (must be right after EnumLiteral, see getSortOrderFlags)
TypeFlagsNonPrimitive TypeFlags = 1 << 17 // intrinsic object type
TypeFlagsNever TypeFlags = 1 << 18 // Never type
TypeFlagsTypeParameter TypeFlags = 1 << 19 // Type parameter
TypeFlagsObject TypeFlags = 1 << 20 // Object type
TypeFlagsIndex TypeFlags = 1 << 21 // keyof T
TypeFlagsTemplateLiteral TypeFlags = 1 << 22 // Template literal type
TypeFlagsStringMapping TypeFlags = 1 << 23 // Uppercase/Lowercase type
TypeFlagsSubstitution TypeFlags = 1 << 24 // Type parameter substitution
TypeFlagsIndexedAccess TypeFlags = 1 << 25 // T[K]
TypeFlagsConditional TypeFlags = 1 << 26 // T extends U ? X : Y
TypeFlagsUnion TypeFlags = 1 << 27 // Union (T | U)
TypeFlagsIntersection TypeFlags = 1 << 28 // Intersection (T & U)
TypeFlagsReserved1 TypeFlags = 1 << 29 // Used by union/intersection type construction
TypeFlagsReserved2 TypeFlags = 1 << 30 // Used by union/intersection type construction
TypeFlagsReserved3 TypeFlags = 1 << 31
TypeFlagsAnyOrUnknown = TypeFlagsAny | TypeFlagsUnknown
TypeFlagsNullable = TypeFlagsUndefined | TypeFlagsNull
TypeFlagsLiteral = TypeFlagsStringLiteral | TypeFlagsNumberLiteral | TypeFlagsBigIntLiteral | TypeFlagsBooleanLiteral
TypeFlagsUnit = TypeFlagsEnum | TypeFlagsLiteral | TypeFlagsUniqueESSymbol | TypeFlagsNullable
TypeFlagsFreshable = TypeFlagsEnum | TypeFlagsLiteral
TypeFlagsStringOrNumberLiteral = TypeFlagsStringLiteral | TypeFlagsNumberLiteral
TypeFlagsStringOrNumberLiteralOrUnique = TypeFlagsStringLiteral | TypeFlagsNumberLiteral | TypeFlagsUniqueESSymbol
TypeFlagsDefinitelyFalsy = TypeFlagsStringLiteral | TypeFlagsNumberLiteral | TypeFlagsBigIntLiteral | TypeFlagsBooleanLiteral | TypeFlagsVoid | TypeFlagsUndefined | TypeFlagsNull
TypeFlagsPossiblyFalsy = TypeFlagsDefinitelyFalsy | TypeFlagsString | TypeFlagsNumber | TypeFlagsBigInt | TypeFlagsBoolean
TypeFlagsIntrinsic = TypeFlagsAny | TypeFlagsUnknown | TypeFlagsString | TypeFlagsNumber | TypeFlagsBigInt | TypeFlagsESSymbol | TypeFlagsVoid | TypeFlagsUndefined | TypeFlagsNull | TypeFlagsNever | TypeFlagsNonPrimitive
TypeFlagsStringLike = TypeFlagsString | TypeFlagsStringLiteral | TypeFlagsTemplateLiteral | TypeFlagsStringMapping
TypeFlagsNumberLike = TypeFlagsNumber | TypeFlagsNumberLiteral | TypeFlagsEnum
TypeFlagsBigIntLike = TypeFlagsBigInt | TypeFlagsBigIntLiteral
TypeFlagsBooleanLike = TypeFlagsBoolean | TypeFlagsBooleanLiteral
TypeFlagsEnumLike = TypeFlagsEnum | TypeFlagsEnumLiteral
TypeFlagsESSymbolLike = TypeFlagsESSymbol | TypeFlagsUniqueESSymbol
TypeFlagsVoidLike = TypeFlagsVoid | TypeFlagsUndefined
TypeFlagsPrimitive = TypeFlagsStringLike | TypeFlagsNumberLike | TypeFlagsBigIntLike | TypeFlagsBooleanLike | TypeFlagsEnumLike | TypeFlagsESSymbolLike | TypeFlagsVoidLike | TypeFlagsNull
TypeFlagsDefinitelyNonNullable = TypeFlagsStringLike | TypeFlagsNumberLike | TypeFlagsBigIntLike | TypeFlagsBooleanLike | TypeFlagsEnumLike | TypeFlagsESSymbolLike | TypeFlagsObject | TypeFlagsNonPrimitive
TypeFlagsDisjointDomains = TypeFlagsNonPrimitive | TypeFlagsStringLike | TypeFlagsNumberLike | TypeFlagsBigIntLike | TypeFlagsBooleanLike | TypeFlagsESSymbolLike | TypeFlagsVoidLike | TypeFlagsNull
TypeFlagsUnionOrIntersection = TypeFlagsUnion | TypeFlagsIntersection
TypeFlagsStructuredType = TypeFlagsObject | TypeFlagsUnion | TypeFlagsIntersection
TypeFlagsTypeVariable = TypeFlagsTypeParameter | TypeFlagsIndexedAccess
TypeFlagsInstantiableNonPrimitive = TypeFlagsTypeVariable | TypeFlagsConditional | TypeFlagsSubstitution
TypeFlagsInstantiablePrimitive = TypeFlagsIndex | TypeFlagsTemplateLiteral | TypeFlagsStringMapping
TypeFlagsInstantiable = TypeFlagsInstantiableNonPrimitive | TypeFlagsInstantiablePrimitive
TypeFlagsStructuredOrInstantiable = TypeFlagsStructuredType | TypeFlagsInstantiable
TypeFlagsObjectFlagsType = TypeFlagsAny | TypeFlagsNullable | TypeFlagsNever | TypeFlagsObject | TypeFlagsUnion | TypeFlagsIntersection
TypeFlagsSimplifiable = TypeFlagsIndexedAccess | TypeFlagsConditional
TypeFlagsSingleton = TypeFlagsAny | TypeFlagsUnknown | TypeFlagsString | TypeFlagsNumber | TypeFlagsBoolean | TypeFlagsBigInt | TypeFlagsESSymbol | TypeFlagsVoid | TypeFlagsUndefined | TypeFlagsNull | TypeFlagsNever | TypeFlagsNonPrimitive
// 'TypeFlagsNarrowable' types are types where narrowing actually narrows.
// This *should* be every type other than null, undefined, void, and never
TypeFlagsNarrowable = TypeFlagsAny | TypeFlagsUnknown | TypeFlagsStructuredOrInstantiable | TypeFlagsStringLike | TypeFlagsNumberLike | TypeFlagsBigIntLike | TypeFlagsBooleanLike | TypeFlagsESSymbol | TypeFlagsUniqueESSymbol | TypeFlagsNonPrimitive
// The following flags are aggregated during union and intersection type construction
TypeFlagsIncludesMask = TypeFlagsAny | TypeFlagsUnknown | TypeFlagsPrimitive | TypeFlagsNever | TypeFlagsObject | TypeFlagsUnion | TypeFlagsIntersection | TypeFlagsNonPrimitive | TypeFlagsTemplateLiteral | TypeFlagsStringMapping
// The following flags are used for different purposes during union and intersection type construction
TypeFlagsIncludesMissingType = TypeFlagsTypeParameter
TypeFlagsIncludesNonWideningType = TypeFlagsIndex
TypeFlagsIncludesWildcard = TypeFlagsIndexedAccess
TypeFlagsIncludesEmptyObject = TypeFlagsConditional
TypeFlagsIncludesInstantiable = TypeFlagsSubstitution
TypeFlagsIncludesConstrainedTypeVariable = TypeFlagsReserved1
TypeFlagsIncludesError = TypeFlagsReserved2
TypeFlagsNotPrimitiveUnion = TypeFlagsAny | TypeFlagsUnknown | TypeFlagsVoid | TypeFlagsNever | TypeFlagsObject | TypeFlagsIntersection | TypeFlagsIncludesInstantiable
)
type ObjectFlags uint32
// Types included in TypeFlags.ObjectFlagsType have an objectFlags property. Some ObjectFlags
// are specific to certain types and reuse the same bit position. Those ObjectFlags require a check
// for a certain TypeFlags value to determine their meaning.
const (
ObjectFlagsNone ObjectFlags = 0
ObjectFlagsClass ObjectFlags = 1 << 0 // Class
ObjectFlagsInterface ObjectFlags = 1 << 1 // Interface
ObjectFlagsReference ObjectFlags = 1 << 2 // Generic type reference
ObjectFlagsTuple ObjectFlags = 1 << 3 // Synthesized generic tuple type
ObjectFlagsAnonymous ObjectFlags = 1 << 4 // Anonymous
ObjectFlagsMapped ObjectFlags = 1 << 5 // Mapped
ObjectFlagsInstantiated ObjectFlags = 1 << 6 // Instantiated anonymous or mapped type
ObjectFlagsObjectLiteral ObjectFlags = 1 << 7 // Originates in an object literal
ObjectFlagsEvolvingArray ObjectFlags = 1 << 8 // Evolving array type
ObjectFlagsObjectLiteralPatternWithComputedProperties ObjectFlags = 1 << 9 // Object literal pattern with computed properties
ObjectFlagsReverseMapped ObjectFlags = 1 << 10 // Object contains a property from a reverse-mapped type
ObjectFlagsJsxAttributes ObjectFlags = 1 << 11 // Jsx attributes type
ObjectFlagsJSLiteral ObjectFlags = 1 << 12 // Object type declared in JS - disables errors on read/write of nonexisting members
ObjectFlagsFreshLiteral ObjectFlags = 1 << 13 // Fresh object literal
ObjectFlagsArrayLiteral ObjectFlags = 1 << 14 // Originates in an array literal
ObjectFlagsPrimitiveUnion ObjectFlags = 1 << 15 // Union of only primitive types
ObjectFlagsContainsWideningType ObjectFlags = 1 << 16 // Type is or contains undefined or null widening type
ObjectFlagsContainsObjectOrArrayLiteral ObjectFlags = 1 << 17 // Type is or contains object literal type
ObjectFlagsNonInferrableType ObjectFlags = 1 << 18 // Type is or contains anyFunctionType or silentNeverType
ObjectFlagsCouldContainTypeVariablesComputed ObjectFlags = 1 << 19 // CouldContainTypeVariables flag has been computed
ObjectFlagsCouldContainTypeVariables ObjectFlags = 1 << 20 // Type could contain a type variable
ObjectFlagsMembersResolved ObjectFlags = 1 << 21 // Members have been resolved
ObjectFlagsClassOrInterface = ObjectFlagsClass | ObjectFlagsInterface
ObjectFlagsRequiresWidening = ObjectFlagsContainsWideningType | ObjectFlagsContainsObjectOrArrayLiteral
ObjectFlagsPropagatingFlags = ObjectFlagsContainsWideningType | ObjectFlagsContainsObjectOrArrayLiteral | ObjectFlagsNonInferrableType
ObjectFlagsInstantiatedMapped = ObjectFlagsMapped | ObjectFlagsInstantiated
// Object flags that uniquely identify the kind of ObjectType
ObjectFlagsObjectTypeKindMask = ObjectFlagsClassOrInterface | ObjectFlagsReference | ObjectFlagsTuple | ObjectFlagsAnonymous | ObjectFlagsMapped | ObjectFlagsReverseMapped | ObjectFlagsEvolvingArray | ObjectFlagsInstantiationExpressionType | ObjectFlagsSingleSignatureType
// Flags that require TypeFlags.Object
ObjectFlagsContainsSpread = 1 << 22 // Object literal contains spread operation
ObjectFlagsObjectRestType = 1 << 23 // Originates in object rest declaration
ObjectFlagsInstantiationExpressionType = 1 << 24 // Originates in instantiation expression
ObjectFlagsSingleSignatureType = 1 << 25 // A single signature type extracted from a potentially broader type
ObjectFlagsIsClassInstanceClone = 1 << 26 // Type is a clone of a class instance type
// Flags that require TypeFlags.Object and ObjectFlags.Reference
ObjectFlagsIdenticalBaseTypeCalculated = 1 << 27 // has had `getSingleBaseForNonAugmentingSubtype` invoked on it already
ObjectFlagsIdenticalBaseTypeExists = 1 << 28 // has a defined cachedEquivalentBaseType member
// Flags that require TypeFlags.UnionOrIntersection or TypeFlags.Substitution
ObjectFlagsIsGenericTypeComputed = 1 << 22 // IsGenericObjectType flag has been computed
ObjectFlagsIsGenericObjectType = 1 << 23 // Union or intersection contains generic object type
ObjectFlagsIsGenericIndexType = 1 << 24 // Union or intersection contains generic index type
ObjectFlagsIsGenericType = ObjectFlagsIsGenericObjectType | ObjectFlagsIsGenericIndexType
// Flags that require TypeFlags.Union
ObjectFlagsContainsIntersections = 1 << 25 // Union contains intersections
ObjectFlagsIsUnknownLikeUnionComputed = 1 << 26 // IsUnknownLikeUnion flag has been computed
ObjectFlagsIsUnknownLikeUnion = 1 << 27 // Union of null, undefined, and empty object type
// Flags that require TypeFlags.Intersection
ObjectFlagsIsNeverIntersectionComputed = 1 << 25 // IsNeverLike flag has been computed
ObjectFlagsIsNeverIntersection = 1 << 26 // Intersection reduces to never
ObjectFlagsIsConstrainedTypeVariable = 1 << 27 // T & C, where T's constraint and C are primitives, object, or {}
)
// TypeAlias
type TypeAlias struct {
symbol *ast.Symbol
typeArguments []*Type
}
func (a *TypeAlias) Symbol() *ast.Symbol {
if a == nil {
return nil
}
return a.symbol
}
func (a *TypeAlias) TypeArguments() []*Type {
if a == nil {
return nil
}
return a.typeArguments
}
// Type
type Type struct {
flags TypeFlags
objectFlags ObjectFlags
id TypeId
symbol *ast.Symbol
alias *TypeAlias
checker *Checker
data TypeData // Type specific data
}
func (t *Type) Id() TypeId {
return t.id
}
func (t *Type) Flags() TypeFlags {
return t.flags
}
func (t *Type) ObjectFlags() ObjectFlags {
return t.objectFlags
}
func (t *Type) Alias() *TypeAlias {
return t.alias
}
// Casts for concrete struct types
func (t *Type) AsIntrinsicType() *IntrinsicType { return t.data.(*IntrinsicType) }
func (t *Type) AsLiteralType() *LiteralType { return t.data.(*LiteralType) }
func (t *Type) AsUniqueESSymbolType() *UniqueESSymbolType { return t.data.(*UniqueESSymbolType) }
func (t *Type) AsTupleType() *TupleType { return t.data.(*TupleType) }
func (t *Type) AsInstantiationExpressionType() *InstantiationExpressionType {
return t.data.(*InstantiationExpressionType)
}
func (t *Type) AsMappedType() *MappedType { return t.data.(*MappedType) }
func (t *Type) AsReverseMappedType() *ReverseMappedType { return t.data.(*ReverseMappedType) }
func (t *Type) AsEvolvingArrayType() *EvolvingArrayType { return t.data.(*EvolvingArrayType) }
func (t *Type) AsTypeParameter() *TypeParameter { return t.data.(*TypeParameter) }
func (t *Type) AsUnionType() *UnionType { return t.data.(*UnionType) }
func (t *Type) AsIntersectionType() *IntersectionType { return t.data.(*IntersectionType) }
func (t *Type) AsIndexType() *IndexType { return t.data.(*IndexType) }
func (t *Type) AsIndexedAccessType() *IndexedAccessType { return t.data.(*IndexedAccessType) }
func (t *Type) AsTemplateLiteralType() *TemplateLiteralType { return t.data.(*TemplateLiteralType) }
func (t *Type) AsStringMappingType() *StringMappingType { return t.data.(*StringMappingType) }
func (t *Type) AsSubstitutionType() *SubstitutionType { return t.data.(*SubstitutionType) }
func (t *Type) AsConditionalType() *ConditionalType { return t.data.(*ConditionalType) }
// Casts for embedded struct types
func (t *Type) AsConstrainedType() *ConstrainedType { return t.data.AsConstrainedType() }
func (t *Type) AsStructuredType() *StructuredType { return t.data.AsStructuredType() }
func (t *Type) AsObjectType() *ObjectType { return t.data.AsObjectType() }
func (t *Type) AsTypeReference() *TypeReference { return t.data.AsTypeReference() }
func (t *Type) AsInterfaceType() *InterfaceType { return t.data.AsInterfaceType() }
func (t *Type) AsUnionOrIntersectionType() *UnionOrIntersectionType {
return t.data.AsUnionOrIntersectionType()
}
func (t *Type) Distributed() []*Type {
switch {
case t.flags&TypeFlagsUnion != 0:
return t.AsUnionType().types
case t.flags&TypeFlagsNever != 0:
return nil
}
return []*Type{t}
}
// Common accessors
func (t *Type) Target() *Type {
switch {
case t.flags&TypeFlagsObject != 0:
return t.AsObjectType().target
case t.flags&TypeFlagsTypeParameter != 0:
return t.AsTypeParameter().target
case t.flags&TypeFlagsIndex != 0:
return t.AsIndexType().target
case t.flags&TypeFlagsStringMapping != 0:
return t.AsStringMappingType().target
case t.flags&TypeFlagsObject != 0 && t.objectFlags&ObjectFlagsMapped != 0:
return t.AsMappedType().target
}
panic("Unhandled case in Type.Target")
}
func (t *Type) Mapper() *TypeMapper {
switch {
case t.flags&TypeFlagsObject != 0:
return t.AsObjectType().mapper
case t.flags&TypeFlagsTypeParameter != 0:
return t.AsTypeParameter().mapper
case t.flags&TypeFlagsConditional != 0:
return t.AsConditionalType().mapper
}
panic("Unhandled case in Type.Mapper")
}
func (t *Type) Types() []*Type {
switch {
case t.flags&TypeFlagsUnionOrIntersection != 0:
return t.AsUnionOrIntersectionType().types
case t.flags&TypeFlagsTemplateLiteral != 0:
return t.AsTemplateLiteralType().types
}
panic("Unhandled case in Type.Types")
}
func (t *Type) TargetInterfaceType() *InterfaceType {
return t.AsTypeReference().target.AsInterfaceType()
}
func (t *Type) TargetTupleType() *TupleType {
return t.AsTypeReference().target.AsTupleType()
}
func (t *Type) Symbol() *ast.Symbol {
return t.symbol
}
func (t *Type) IsUnion() bool {
return t.flags&TypeFlagsUnion != 0
}
func (t *Type) IsString() bool {
return t.flags&TypeFlagsString != 0
}
func (t *Type) IsIntersection() bool {
return t.flags&TypeFlagsIntersection != 0
}
func (t *Type) IsStringLiteral() bool {
return t.flags&TypeFlagsStringLiteral != 0
}
func (t *Type) IsNumberLiteral() bool {
return t.flags&TypeFlagsNumberLiteral != 0
}
func (t *Type) IsBigIntLiteral() bool {
return t.flags&TypeFlagsBigIntLiteral != 0
}
func (t *Type) IsEnumLiteral() bool {
return t.flags&TypeFlagsEnumLiteral != 0
}
func (t *Type) IsBooleanLike() bool {
return t.flags&TypeFlagsBooleanLike != 0
}
func (t *Type) IsStringLike() bool {
return t.flags&TypeFlagsStringLike != 0
}
func (t *Type) IsClass() bool {
return t.objectFlags&ObjectFlagsClass != 0
}
func (t *Type) IsTypeParameter() bool {
return t.flags&TypeFlagsTypeParameter != 0
}
func (t *Type) IsIndex() bool {
return t.flags&TypeFlagsIndex != 0
}
func (t *Type) IsTupleType() bool {
return isTupleType(t)
}
// TypeData
type TypeData interface {
AsType() *Type
AsConstrainedType() *ConstrainedType
AsStructuredType() *StructuredType
AsObjectType() *ObjectType
AsTypeReference() *TypeReference
AsInterfaceType() *InterfaceType
AsUnionOrIntersectionType() *UnionOrIntersectionType
}
// TypeBase
type TypeBase struct {
Type
}
func (t *TypeBase) AsType() *Type { return &t.Type }
func (t *TypeBase) AsConstrainedType() *ConstrainedType { return nil }
func (t *TypeBase) AsStructuredType() *StructuredType { return nil }
func (t *TypeBase) AsObjectType() *ObjectType { return nil }
func (t *TypeBase) AsTypeReference() *TypeReference { return nil }
func (t *TypeBase) AsInterfaceType() *InterfaceType { return nil }
func (t *TypeBase) AsUnionOrIntersectionType() *UnionOrIntersectionType { return nil }
// IntrinsicTypeData
type IntrinsicType struct {
TypeBase
intrinsicName string
}
func (t *IntrinsicType) IntrinsicName() string { return t.intrinsicName }
// LiteralTypeData
type LiteralType struct {
TypeBase
value any // string | jsnum.Number | bool | PseudoBigInt | nil (computed enum)
freshType *Type // Fresh version of type
regularType *Type // Regular version of type
}
func (t *LiteralType) Value() any {
return t.value
}
func (t *LiteralType) String() string {
return ValueToString(t.value)
}
func (t *LiteralType) FreshType() *Type {
return t.freshType
}
// UniqueESSymbolTypeData
type UniqueESSymbolType struct {
TypeBase
name string
}
// ConstrainedType (type with computed base constraint)
type ConstrainedType struct {
TypeBase
resolvedBaseConstraint *Type
}
func (t *ConstrainedType) AsConstrainedType() *ConstrainedType { return t }
// StructuredType (base of all types with members)
type StructuredType struct {
ConstrainedType
members ast.SymbolTable
properties []*ast.Symbol
signatures []*Signature // Signatures (call + construct)
callSignatureCount int // Count of call signatures
indexInfos []*IndexInfo
objectTypeWithoutAbstractConstructSignatures *Type
}
func (t *StructuredType) AsStructuredType() *StructuredType { return t }
func (t *StructuredType) CallSignatures() []*Signature {
return slices.Clip(t.signatures[:t.callSignatureCount])
}
func (t *StructuredType) ConstructSignatures() []*Signature {
return slices.Clip(t.signatures[t.callSignatureCount:])
}
func (t *StructuredType) Properties() []*ast.Symbol {
return t.properties
}
// Except for tuple type references and reverse mapped types, all object types have an associated symbol.
// Possible object type instances are listed in the following.
// InterfaceType:
// ObjectFlagsClass: Originating non-generic class type
// ObjectFlagsClass|ObjectFlagsReference: Originating generic class type
// ObjectFlagsInterface: Originating non-generic interface type
// ObjectFlagsInterface|ObjectFlagsReference: Originating generic interface type
// TupleType:
// ObjectFlagsReference|ObjectFlagsTuple: Originating generic tuple type (synthesized)
// TypeReference
// ObjectFlagsReference: Instantiated generic class, interface, or tuple type
// ObjectType:
// ObjectFlagsAnonymous: Originating anonymous object type
// ObjectFlagsAnonymous|ObjectFlagsInstantiated: Instantiated anonymous object type
// MappedType:
// ObjectFlagsMapped: Originating mapped type
// ObjectFlagsMapped|ObjectFlagsInstantiated: Instantiated mapped type
// InstantiationExpressionType:
// ObjectFlagsAnonymous|ObjectFlagsInstantiationExpression: Originating instantiation expression type
// ObjectFlagsAnonymous|ObjectFlagsInstantiated|ObjectFlagsInstantiationExpression: Instantiated instantiation expression type
// ReverseMappedType:
// ObjectFlagsAnonymous|ObjectFlagsReverseMapped: Reverse mapped type
// EvolvingArrayType:
// ObjectFlagsEvolvingArray: Evolving array type
type ObjectType struct {
StructuredType
target *Type // Target of instantiated type
mapper *TypeMapper // Type mapper for instantiated type
instantiations map[string]*Type // Map of type instantiations
}
func (t *ObjectType) AsObjectType() *ObjectType { return t }
// TypeReference (instantiation of an InterfaceType)
type TypeReference struct {
ObjectType
node *ast.Node // TypeReferenceNode | ArrayTypeNode | TupleTypeNode when deferred, else nil
resolvedTypeArguments []*Type
}
func (t *TypeReference) AsTypeReference() *TypeReference { return t }
// InterfaceType (when generic, serves as reference to instantiation of itself)
type InterfaceType struct {
TypeReference
allTypeParameters []*Type // Type parameters (outer + local + thisType)
outerTypeParameterCount int // Count of outer type parameters
thisType *Type // The "this" type (nil if none)
baseTypesResolved bool
declaredMembersResolved bool
resolvedBaseConstructorType *Type
resolvedBaseTypes []*Type
declaredMembers ast.SymbolTable // Declared members
declaredCallSignatures []*Signature // Declared call signatures
declaredConstructSignatures []*Signature // Declared construct signatures
declaredIndexInfos []*IndexInfo // Declared index signatures
}
func (t *InterfaceType) AsInterfaceType() *InterfaceType { return t }
func (t *InterfaceType) OuterTypeParameters() []*Type {
if len(t.allTypeParameters) == 0 {
return nil
}
return slices.Clip(t.allTypeParameters[:t.outerTypeParameterCount])
}
func (t *InterfaceType) LocalTypeParameters() []*Type {
if len(t.allTypeParameters) == 0 {
return nil
}
return slices.Clip(t.allTypeParameters[t.outerTypeParameterCount : len(t.allTypeParameters)-1])
}
func (t *InterfaceType) TypeParameters() []*Type {
if len(t.allTypeParameters) == 0 {
return nil
}
return slices.Clip(t.allTypeParameters[:len(t.allTypeParameters)-1])
}
// TupleType
type ElementFlags uint32
const (
ElementFlagsNone ElementFlags = 0
ElementFlagsRequired ElementFlags = 1 << 0 // T
ElementFlagsOptional ElementFlags = 1 << 1 // T?
ElementFlagsRest ElementFlags = 1 << 2 // ...T[]
ElementFlagsVariadic ElementFlags = 1 << 3 // ...T
ElementFlagsFixed = ElementFlagsRequired | ElementFlagsOptional
ElementFlagsVariable = ElementFlagsRest | ElementFlagsVariadic
ElementFlagsNonRequired = ElementFlagsOptional | ElementFlagsRest | ElementFlagsVariadic
ElementFlagsNonRest = ElementFlagsRequired | ElementFlagsOptional | ElementFlagsVariadic
)
type TupleElementInfo struct {
flags ElementFlags
labeledDeclaration *ast.Node // NamedTupleMember | ParameterDeclaration | nil
}
func (t *TupleElementInfo) TupleElementFlags() ElementFlags { return t.flags }
func (t *TupleElementInfo) LabeledDeclaration() *ast.Node { return t.labeledDeclaration }
func (i *TupleElementInfo) ElementFlags() ElementFlags {
return i.flags
}
type TupleType struct {
InterfaceType
elementInfos []TupleElementInfo
minLength int // Number of required or variadic elements
fixedLength int // Number of initial required or optional elements
combinedFlags ElementFlags
readonly bool
}
func (t *TupleType) FixedLength() int { return t.fixedLength }
func (t *TupleType) ElementFlags() []ElementFlags {
elementFlags := make([]ElementFlags, len(t.elementInfos))
for i, info := range t.elementInfos {
elementFlags[i] = info.flags
}
return elementFlags
}
// SingleSignatureType
type SingleSignatureType struct {
ObjectType
outerTypeParameters []*Type
}
func (t *TupleType) ElementInfos() []TupleElementInfo { return t.elementInfos }
// InstantiationExpressionType
type InstantiationExpressionType struct {
ObjectType
node *ast.Node
}
// MappedType
type MappedType struct {
ObjectType
declaration *ast.MappedTypeNode
typeParameter *Type
constraintType *Type
nameType *Type
templateType *Type
modifiersType *Type
resolvedApparentType *Type
containsError bool
}
// ReverseMappedType
type ReverseMappedType struct {
ObjectType
source *Type
mappedType *Type
constraintType *Type
}
// EvolvingArrayType
type EvolvingArrayType struct {
ObjectType
elementType *Type
finalArrayType *Type
}
// UnionOrIntersectionTypeData
type UnionOrIntersectionType struct {
StructuredType
types []*Type
propertyCache ast.SymbolTable
propertyCacheWithoutFunctionPropertyAugment ast.SymbolTable
resolvedProperties []*ast.Symbol
}
func (t *UnionOrIntersectionType) AsUnionOrIntersectionType() *UnionOrIntersectionType { return t }
// UnionType
type UnionType struct {
UnionOrIntersectionType
resolvedReducedType *Type
regularType *Type
origin *Type // Denormalized union, intersection, or index type in which union originates
keyPropertyName string // Property with unique unit type that exists in every object/intersection in union type
constituentMap map[*Type]*Type // Constituents keyed by unit type discriminants
}
// IntersectionType
type IntersectionType struct {
UnionOrIntersectionType
resolvedApparentType *Type
uniqueLiteralFilledInstantiation *Type // Instantiation with type parameters mapped to never type
}
// TypeParameter
type TypeParameter struct {
ConstrainedType
constraint *Type
target *Type
mapper *TypeMapper
isThisType bool
resolvedDefaultType *Type
}
func (t *TypeParameter) IsThisType() bool {
return t.isThisType
}
// IndexFlags
type IndexFlags uint32
const (
IndexFlagsNone IndexFlags = 0
IndexFlagsStringsOnly IndexFlags = 1 << 0
IndexFlagsNoIndexSignatures IndexFlags = 1 << 1
IndexFlagsNoReducibleCheck IndexFlags = 1 << 2
)
// IndexType
type IndexType struct {
ConstrainedType
target *Type
indexFlags IndexFlags
}
// IndexedAccessType
type IndexedAccessType struct {
ConstrainedType
objectType *Type
indexType *Type
accessFlags AccessFlags // Only includes AccessFlags.Persistent
}
func (t *IndexedAccessType) ObjectType() *Type {
return t.objectType
}
func (t *IndexedAccessType) IndexType() *Type {
return t.indexType
}
type TemplateLiteralType struct {
ConstrainedType
texts []string // Always one element longer than types
types []*Type // Always at least one element
}
func (t *TemplateLiteralType) Texts() []string {
return t.texts
}
type StringMappingType struct {
ConstrainedType
target *Type
}
type SubstitutionType struct {
ConstrainedType
baseType *Type // Target type
constraint *Type // Constraint that target type is known to satisfy
}
func (t *SubstitutionType) BaseType() *Type {
return t.baseType
}
type ConditionalRoot struct {
node *ast.ConditionalTypeNode
checkType *Type
extendsType *Type
isDistributive bool
inferTypeParameters []*Type
outerTypeParameters []*Type
instantiations map[string]*Type
alias *TypeAlias
}
type ConditionalType struct {
ConstrainedType
root *ConditionalRoot
checkType *Type
extendsType *Type
resolvedTrueType *Type
resolvedFalseType *Type
resolvedInferredTrueType *Type // The `trueType` instantiated with the `combinedMapper`, if present
resolvedDefaultConstraint *Type
resolvedConstraintOfDistributive *Type
mapper *TypeMapper
combinedMapper *TypeMapper
}
func (t *ConditionalType) CheckType() *Type {
return t.checkType
}
func (t *ConditionalType) ExtendsType() *Type {
return t.extendsType
}
// SignatureFlags
type SignatureFlags uint32
const (
SignatureFlagsNone SignatureFlags = 0
// Propagating flags
SignatureFlagsHasRestParameter SignatureFlags = 1 << 0 // Indicates last parameter is rest parameter
SignatureFlagsHasLiteralTypes SignatureFlags = 1 << 1 // Indicates signature is specialized
SignatureFlagsConstruct SignatureFlags = 1 << 2 // Indicates signature is a construct signature
SignatureFlagsAbstract SignatureFlags = 1 << 3 // Indicates signature comes from an abstract class, abstract construct signature, or abstract constructor type
// Non-propagating flags
SignatureFlagsIsInnerCallChain SignatureFlags = 1 << 4 // Indicates signature comes from a CallChain nested in an outer OptionalChain
SignatureFlagsIsOuterCallChain SignatureFlags = 1 << 5 // Indicates signature comes from a CallChain that is the outermost chain of an optional expression
SignatureFlagsIsUntypedSignatureInJSFile SignatureFlags = 1 << 6 // Indicates signature is from a js file and has no types
SignatureFlagsIsNonInferrable SignatureFlags = 1 << 7 // Indicates signature comes from a non-inferrable type
SignatureFlagsIsSignatureCandidateForOverloadFailure SignatureFlags = 1 << 8
// We do not propagate `IsInnerCallChain` or `IsOuterCallChain` to instantiated signatures, as that would result in us
// attempting to add `| undefined` on each recursive call to `getReturnTypeOfSignature` when
// instantiating the return type.
SignatureFlagsPropagatingFlags = SignatureFlagsHasRestParameter | SignatureFlagsHasLiteralTypes | SignatureFlagsConstruct | SignatureFlagsAbstract | SignatureFlagsIsUntypedSignatureInJSFile | SignatureFlagsIsSignatureCandidateForOverloadFailure
SignatureFlagsCallChainFlags = SignatureFlagsIsInnerCallChain | SignatureFlagsIsOuterCallChain
)
// Signature
type Signature struct {
flags SignatureFlags
minArgumentCount int32
resolvedMinArgumentCount int32
declaration *ast.Node
typeParameters []*Type
parameters []*ast.Symbol
thisParameter *ast.Symbol
resolvedReturnType *Type
resolvedTypePredicate *TypePredicate
target *Signature
mapper *TypeMapper
isolatedSignatureType *Type
composite *CompositeSignature
}
func (s *Signature) TypeParameters() []*Type {
return s.typeParameters
}
func (s *Signature) Declaration() *ast.Node {
return s.declaration
}
func (s *Signature) Target() *Signature {
return s.target
}
func (s *Signature) ThisParameter() *ast.Symbol {
return s.thisParameter
}
func (s *Signature) ReturnType() *Type {
return s.resolvedReturnType
}
func (s *Signature) Parameters() []*ast.Symbol {
return s.parameters
}
func (s *Signature) HasRestParameter() bool {
return s.flags&SignatureFlagsHasRestParameter != 0
}
func (s *Signature) IsSignatureCandidateForOverloadFailure() bool {
return s.flags&SignatureFlagsIsSignatureCandidateForOverloadFailure != 0
}
type CompositeSignature struct {
isUnion bool // True for union, false for intersection
signatures []*Signature // Individual signatures
}
type TypePredicateKind int32
const (
TypePredicateKindThis TypePredicateKind = iota
TypePredicateKindIdentifier
TypePredicateKindAssertsThis
TypePredicateKindAssertsIdentifier
)
type TypePredicate struct {
kind TypePredicateKind
parameterIndex int32
parameterName string
t *Type
}
func (typePredicate *TypePredicate) Type() *Type {
return typePredicate.t
}
// IndexInfo
type IndexInfo struct {
keyType *Type
valueType *Type
isReadonly bool
declaration *ast.Node // IndexSignatureDeclaration
components []*ast.Node // ElementWithComputedPropertyName
}
func (i *IndexInfo) KeyType() *Type {
return i.keyType
}
func (i *IndexInfo) ValueType() *Type {
return i.valueType
}
func (i *IndexInfo) IsReadonly() bool {
return i.isReadonly
}
func (i *IndexInfo) Declaration() *ast.Node {
return i.declaration
}
/**
* Ternary values are defined such that
* x & y picks the lesser in the order False < Unknown < Maybe < True, and
* x | y picks the greater in the order False < Unknown < Maybe < True.
* Generally, Ternary.Maybe is used as the result of a relation that depends on itself, and
* Ternary.Unknown is used as the result of a variance check that depends on itself. We make
* a distinction because we don't want to cache circular variance check results.
*/
type Ternary int8
const (
TernaryFalse Ternary = 0
TernaryUnknown Ternary = 1
TernaryMaybe Ternary = 3
TernaryTrue Ternary = -1
)
type TypeComparer func(s *Type, t *Type, reportErrors bool) Ternary
type LanguageFeatureMinimumTargetMap struct {
Exponentiation core.ScriptTarget
AsyncFunctions core.ScriptTarget
ForAwaitOf core.ScriptTarget
AsyncGenerators core.ScriptTarget
AsyncIteration core.ScriptTarget
ObjectSpreadRest core.ScriptTarget
RegularExpressionFlagsDotAll core.ScriptTarget
BindinglessCatch core.ScriptTarget
BigInt core.ScriptTarget
NullishCoalesce core.ScriptTarget
OptionalChaining core.ScriptTarget
LogicalAssignment core.ScriptTarget
TopLevelAwait core.ScriptTarget
ClassFields core.ScriptTarget
PrivateNamesAndClassStaticBlocks core.ScriptTarget
RegularExpressionFlagsHasIndices core.ScriptTarget
ShebangComments core.ScriptTarget
UsingAndAwaitUsing core.ScriptTarget
ClassAndClassElementDecorators core.ScriptTarget
RegularExpressionFlagsUnicodeSets core.ScriptTarget
}
var LanguageFeatureMinimumTarget = LanguageFeatureMinimumTargetMap{
Exponentiation: core.ScriptTargetES2016,
AsyncFunctions: core.ScriptTargetES2017,
ForAwaitOf: core.ScriptTargetES2018,
AsyncGenerators: core.ScriptTargetES2018,
AsyncIteration: core.ScriptTargetES2018,
ObjectSpreadRest: core.ScriptTargetES2018,
RegularExpressionFlagsDotAll: core.ScriptTargetES2018,
BindinglessCatch: core.ScriptTargetES2019,
BigInt: core.ScriptTargetES2020,
NullishCoalesce: core.ScriptTargetES2020,
OptionalChaining: core.ScriptTargetES2020,
LogicalAssignment: core.ScriptTargetES2021,
TopLevelAwait: core.ScriptTargetES2022,
ClassFields: core.ScriptTargetES2022,
PrivateNamesAndClassStaticBlocks: core.ScriptTargetES2022,
RegularExpressionFlagsHasIndices: core.ScriptTargetES2022,
ShebangComments: core.ScriptTargetESNext,
UsingAndAwaitUsing: core.ScriptTargetESNext,
ClassAndClassElementDecorators: core.ScriptTargetESNext,
RegularExpressionFlagsUnicodeSets: core.ScriptTargetESNext,
}
// Aliases for types
type StringLiteralType = Type