Cleanup

Sometimes you may need to do some cleanup when destroying a component or after a side-effect from a source update. Vide provides a function cleanup() which is used to queue a cleanup callback for the next time a reactive scope is rerun or destroyed, or when a stable scope is destroyed.

local mount = vide.mount
local source = vide.source
local cleanup = vide.cleanup

local function Timer()
    local count = source(0)

    local con = game:GetService("RunService").Heartbeat:Connect(function(dt)
        count(count() + dt)
    end)

    cleanup(function()
        con:Disconnect()
    end)

    return create "TextButton" {
        Position = UDim2.fromOffset(300, 300),
        Size = UDim2.fromOffset(200, 50),

        Text = function()
            return "seconds: " .. math.floor(count())
        end,
    }
end

local instance, destroy = root(function(destroy)
    local instance = Timer()
    return instance, destroy
end)

wait(5)

destroy() -- all queued cleanups are ran, heartbeat connection disconnected

In the above example, this allows us to disconnect the heartbeat connection when the scope responsible for creating the timer component is destroyed.

::: tip Roblox instances do not need to be explicitly destroyed for their memory to be freed, they only need to be parented to nil. So there is no need to use cleanup() to destroy instances. However, be wary of connecting a function that references an instance to an event from the same instance, this causes the instance to reference itself and never be freed. In such a case you would need to use cleanup() to disconnect this connection or to explicitly destroy the instance. :::

1.6 KiB Raw Blame History

Cleanup

1.6 KiB

Raw Blame History