Class: GenericBuiltInType<T>
compiler.GenericBuiltInType
Represents a generic built-in type that is used in the type analysis phase.
Since
0.12.0
Type parameters
Name | Type |
---|---|
T |
extends GenericTypeArguments |
Hierarchy
-
↳
GenericBuiltInType
Implements
GenericType
<T
>
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• Protected
new GenericBuiltInType<T
>(identifier
, genericTypeArguments
)
Type parameters
Name | Type |
---|---|
T |
extends { identifier : string ; type : ProcessedType | ProcessedType [] }[] |
Parameters
Name | Type |
---|---|
identifier |
KipperBuiltInTypeLiteral |
genericTypeArguments |
T |
Overrides
Defined in
kipper/core/src/compiler/semantics/types/base/generic-built-in-type.ts:18
Properties
_identifier
• Protected
Readonly
_identifier: string
Implementation of
Inherited from
Defined in
kipper/core/src/compiler/semantics/types/base/type.ts:9
genericTypeArguments
• Readonly
genericTypeArguments: T
The generic type arguments for this type.
Since
0.12.0
Implementation of
GenericType.genericTypeArguments
Defined in
kipper/core/src/compiler/semantics/types/base/generic-built-in-type.ts:16
interchangeableTypes
▪ Static
Readonly
interchangeableTypes: string
[]
Inherited from
BuiltInType.interchangeableTypes
Defined in
kipper/core/src/compiler/semantics/types/base/built-in-type.ts:13
Accessors
identifier
• get
identifier(): string
The identifier of this type.
Returns
string
Implementation of
GenericType.identifier
Inherited from
BuiltInType.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 is usually true for built-in types, but for generics it depends on the generic type arguments.
Since
0.11.0
Returns
boolean
Implementation of
GenericType.isCompilable
Inherited from
BuiltInType.isCompilable
Defined in
kipper/core/src/compiler/semantics/types/base/built-in-type.ts:25
isGeneric
• get
isGeneric(): true
Returns whether the type is a generic type.
This is ALWAYS true, since this is a generic type.
Since
0.12.0
Returns
true
Implementation of
Overrides
BuiltInType.isGeneric
Defined in
kipper/core/src/compiler/semantics/types/base/generic-built-in-type.ts:35
isUnion
• get
isUnion(): boolean
Returns whether the type is a union type.
Since
0.12.0
Returns
boolean
Implementation of
GenericType.isUnion
Inherited from
BuiltInType.isUnion
Defined in
kipper/core/src/compiler/semantics/types/base/processed-type.ts:46
Methods
assertAssignableTo
▸ Abstract
assertAssignableTo(type
, propertyName?
, argumentName?
): void
Asserts that this type is assignable to another type.
This will check for generic type arguments as well.
Pasram
type The type to check against.
Throws
AssignmentTypeError If the types are not assignable.
Throws
PropertyAssignmentTypeError If a property is not assignable.
Throws
ArgumentAssignmentTypeError If an argument is not assignable.
Since
0.12.0
Parameters
Name | Type | Description |
---|---|---|
type |
ProcessedType |
- |
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
Implementation of
GenericType.assertAssignableTo
Overrides
BuiltInType.assertAssignableTo
Defined in
kipper/core/src/compiler/semantics/types/base/generic-built-in-type.ts:54
changeGenericTypeArguments
▸ Abstract
changeGenericTypeArguments(genericTypeArguments
): GenericType
<T
>
Changes the generic type arguments for this generic type and returns a new generic type instance with the new arguments where the types have been adjusted.
Since
0.12.0
Parameters
Name | Type | Description |
---|---|---|
genericTypeArguments |
T |
The new generic type arguments. |
Returns
GenericType
<T
>
Implementation of
GenericType.changeGenericTypeArguments
Defined in
kipper/core/src/compiler/semantics/types/base/generic-built-in-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
Implementation of
Inherited from
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
Implementation of
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
Implementation of
Inherited from
Defined in
kipper/core/src/compiler/semantics/types/base/processed-type.ts:93