Typecasts
In BrighterScript, the inferred types of expressions can be explicitly changed through typecasts.
There are two ways of doing this - through inline typecasts, or through typecast statements.
Any expressions that has been typecast will be assumed to be that type.
Inline typecasts
To invoke an inline typecast, use the as <type> syntax after an expression. The whole typecast can also be enclosed in parentheses as well.
In this example, the node parameter is dynamic, but is cast to the built-in type roSgNode. roSgNode has an id property that is a string.
Due to the assignment, nodeId is also known to be a string.
Because of the typecast, the intellisense code completion also knows the type, so at the . after the typecast, members of roSgNode will be suggested.
Example:
function getPrefixedId(node, prefix as string) as string
nodeId = (node as roSgNode).id
return prefix + nodeId
end functionTypecast Statements
In order to specify all usages of an expression are explicitly set to a certain type, you can use a typecast statement.
Syntax:
typecast m as <type>
Rules:
Typecaststatements are only allowed at the top of files (along withimportandlibrarystatements), and as the first statement in a block (eg. function or if statement "then" block) or namespace.- There can be a maximum of one
typecaststatement per variable per block - Only runtime variables can be typecast
- Outside a function, only typecasting
mis supported - When used in a namespace, only the current namespace statement is affected - other namespace statements that contribute to the same namespaces do not have the typecast applied
This is very useful for components, so that the actual type of Associative Array m can narrowed to provide better validation.
pkg:/components/Widget.xml
<?xml version="1.0" encoding="utf-8" ?>
<component name="Widget" extends="Group">
<script uri="Widget.bs" />
<script uri="Widget.interface.bs" />
<interface>
<field id="enabled" type="boolean" value="false" />
<field id="state" type="string" />
</interface>
<children>
<label id="myLabel" />
</children>
</component>pkg:/components/Widget.interface.xml
interface WidgetObject
top as roSgNodeWidget
label as roSgNodeLabel
value as string
end interfacepkg:/components/Widget.bs
typecast m as WidgetObject
sub init
m.label = m.top.findNode("myLabel")
m.value = "Test"
m.top.state = "ok"
printDetails()
end sub
sub printDetails()
' all members of `m` are known
print m.top.subtype()
print m.label.text
print m.top.state
end subTypecast statements are also useful in inline functions to explicitly set the type of m:
interface Greeter
greeting as string
name as string
function doGreeting() as string
end interface
function createGreater(name as string) as Greeter
myGreeter = {
greeting: "Hello"
name: name
doGreeting: function () as string
typecast m as Greeter
return `${m.greeting} ${m.name} ' m is explicity set to be of type Greeter
end function
}
return myGreeter
end functionTypecast statements can be used for type narrowing as well:
function addOne(x) as integer
if isString(x)
typecast x as string
return x.toInt() + 1
else if isInteger(x)
typecast x as integer
return x + 1
end if
return 0
end function