Intersection Types
BrighterScript Intersection Types are a way to define a type that combines the members of multiple types. They are similar to Intersection Types found in other languages, such as TypeScript.
Syntax
Intersection types can be declared with the following syntax: <type> and <type>. For example, the parameter to the function below could be meets both the interfaces HasId and HasUrl:
interface HasId
id as string
end interface
interface HasUrl
url as string
end interface
function getUrlWithQueryId(value as HasId and HasUrl) as string
return value.url + "?id=" + value.id
end functionAny number of inner types, including classes or interfaces, could be part of an intersection:
interface HasId
id as string
end interface
interface HasUrl
url as string
end interface
interface HasSize
width as integer
height as integer
end interface
function getUrlWithQuerySize(value as HasUrl and HasId and HasSize) as string
return value.url + `?id=${value.id}&w=${value.width}&h=${value.height}`
end functionMembers and Validation
A diagnostic error will be raised when a member is accessed that is not a member of any of the types of a union. Note also that if a member is not the same type in each of the types in the union, it will itself be considered an intersection.
sub testIntersection(value as {id as string} and {id as integer})
' This is an error - "value.id" is of type "string AND integer"
printInteger(value.id)
end sub
sub printInteger(x as integer)
print x
end subTranspilation
Since Brightscript does not have intersection types natively, intersection types will be transpiled as dynamic.
interface HasRadius
radius as float
end interface
interface Point
x as float
y as float
end interface
function getCircleDetails(circle as HasRadius and Point) as string
return "Circle: radius=" + circle.radius.toStr() + ", center=" + circle.x.toStr() + "," + circle.y.toStr()
end functionView the transpiled BrightScript code
function getCircleDetails(circle as dynamic) as string
return "Circle: radius=" + circle.radius.ToStr() + ", center=" + circle.x.toStr() + "," + circle.y.toStr()
end function