[I] UnionVariant
One alternative of a union, with either a declared name or an anonymous symbol key.
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Modifier | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|---|
creating? | public | true | If the type is currently being created. | - | BaseType.creating |
decorators | public | DecoratorApplication[] | Applications used when finishing this type, including copied or synthesized applications. | - | DecoratedType.decorators |
entityKind | readonly | "Type" | Distinguishes semantic types from values and parameter constraints. | - | BaseType.entityKind |
instantiationParameters? | public | Type[] | Legacy instantiation metadata. The compiler’s type checker does not populate this field, so its absence does not indicate whether this type is a template instance. | - | BaseType.instantiationParameters |
isFinished | public | boolean | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | BaseType.isFinished |
kind | public | "UnionVariant" | Discriminant for a union alternative rather than the alternative’s value type. | BaseType.kind | - |
name | public | string | symbol | Declared variant name, or a unique symbol for an unnamed alternative. | - | - |
node? | public | UnionVariantNode | Node used to construct this type. If the node is undefined it means the type was dynamically built. With typekit for example. | BaseType.node | - |
type | public | Type | Type accepted by this alternative. | - | - |
union | public | Union | Owning union; flattened union expressions can reuse variants owned by another union. | - | - |