Skip to content

Improve type of PropertiesFor #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
checkraisefold wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve type of PropertiesFor #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions src/instances/create.luau
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,15 +188,20 @@ export type function PropertiesFor(class_name: type): type
current = current:readparent()
end

local nested_table_or_function_or_child = types.newtable()
-- Functions returning a child can return an array of children, or alike functions, nested to any level
local function_returns_child = types.newfunction()
local union =
types.unionof(nested_table_or_function_or_child, function_returns_child, instance, Action)
local child_only_union = types.unionof(function_returns_child, instance)

nested_table_or_function_or_child:setindexer(types.number, union)
function_returns_child:setreturns({ union })
-- TODO: Use a read only indexer when released to properly accept children which are subtypes of `Instance`
-- TODO: Nesting throws a type error, seemingly a solver bug caused whenever the keys are a union instead of direct type
-- Happens even with a union between `Instance` and `any`, but disappears when it's just `Instance`
local nested_table_or_function_or_child = types.newtable()
local nested_child_union = types.unionof(child_only_union, nested_table_or_function_or_child)
nested_table_or_function_or_child:setindexer(types.number, nested_child_union)
function_returns_child:setreturns({ nested_child_union })

properties:setindexer(types.number, types.optional(union))
local full_union = types.unionof(child_only_union, Action, properties)
properties:setindexer(types.number, types.optional(full_union))

return properties
end
Expand Down