Class: UnionType<T>
compiler.UnionType
Represents a union type, which is a type that can be one of multiple types.
Since
0.12.0
Type parameters
| Name | Type |
|---|---|
T |
extends ProcessedType[] = [ProcessedType, ProcessedType] |
Hierarchy
-
↳
UnionType
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new UnionType<T>(unionTypes, identifier?)
Type parameters
| Name | Type |
|---|---|
T |
extends ProcessedType[] = [ProcessedType, ProcessedType] |
Parameters
| Name | Type |
|---|---|
unionTypes |
T |
identifier? |
string |
Overrides
Defined in
kipper/core/src/compiler/semantics/types/base/union-type.ts:30
Properties
_identifier
• Protected Readonly _identifier: string
Inherited from
Defined in
kipper/core/src/compiler/semantics/types/base/type.ts:9
unionTypes
• Readonly unionTypes: T
The types that this union type can be.
Since
0.12.0
Defined in
kipper/core/src/compiler/semantics/types/base/union-type.ts:28
Accessors
identifier
• get identifier(): string
The identifier of this type.
Returns
string
Inherited from
ProcessedType.identifier
Defined in
kipper/core/src/compiler/semantics/types/base/processed-type.ts:19
isCompilable
• get isCompilable(): boolean
Returns whether the type is compilable.
This function exists, since during type checking an undefined/invalid type may be encountered that should still be stored using this class though (but NOT compiled!).
Since
0.10.0
Returns
boolean
Overrides
ProcessedType.isCompilable
Defined in
kipper/core/src/compiler/semantics/types/base/union-type.ts:35
isGeneric
• get isGeneric(): boolean
Returns whether the type is a generic type.
This is false unless overridden by a subclass.
Since
0.12.0
Returns
boolean
Inherited from
ProcessedType.isGeneric
Defined in
kipper/core/src/compiler/semantics/types/base/processed-type.ts:38
isUnion
• get isUnion(): true
Returns whether the type is a union type. This is always true.
Since
0.12.0
Returns
true
Overrides
ProcessedType.isUnion
Defined in
kipper/core/src/compiler/semantics/types/base/union-type.ts:20
Methods
assertAssignableTo
▸ assertAssignableTo(type, propertyName?, argumentName?): void
Asserts that this type is assignable to the given type.
Throws
TypeError If the types are not assignable.
Since
0.12.0
Parameters
| Name | Type | Description |
|---|---|---|
type |
ProcessedType |
The type to check against. |
propertyName? |
string |
The name of the property that is being assigned. This is used for error messages. |
argumentName? |
string |
The name of the argument that is being assigned to. This is used for error messages. |
Returns
void
Overrides
ProcessedType.assertAssignableTo
Defined in
kipper/core/src/compiler/semantics/types/base/union-type.ts:39
getCompilableType
▸ getCompilableType(): CompilableType
Gets the compilable type for this type.
This function throws an error instead of returning undefined, since it's intended to be used in circumstances, where only due to a bug the type is not compilable. As such, it makes sense to strictly assert it will be compilable, unless an error occurs.
Throws
UndefinedType If the isCompilable is false, which should only occur if the identifier is of type UndefinedType.
Since
0.10.0
Returns
Inherited from
ProcessedType.getCompilableType
Defined in
kipper/core/src/compiler/semantics/types/base/processed-type.ts:60
isAssignableTo
▸ isAssignableTo(type): boolean
Returns whether this type is assignable to the given type. This discards any error messages.
This simply returns whether the assertAssignableTo function throws an error or not.
Since
0.12.0
Parameters
| Name | Type | Description |
|---|---|---|
type |
ProcessedType |
The type to check against. |
Returns
boolean
Inherited from
Defined in
kipper/core/src/compiler/semantics/types/base/processed-type.ts:84
toString
▸ toString(): string
Returns the full string representation of this type.
This also includes generic type arguments if this type is a generic type.
Since
0.12.0
Returns
string
Inherited from
Defined in
kipper/core/src/compiler/semantics/types/base/processed-type.ts:93