hakowork/vide
3
0
Fork 0
mirror of https://github.com/centau/vide.git synced 2026-08-20 14:41:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Refactor

Browse source
This commit is contained in:
aaron 2024-06-20 17:36:25 +01:00
parent 67e87110c7
commit f2de9b0e63
25 changed files with 315 additions and 364 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/tut/crash-course/10-cleanup.md
View file

@ -3,7 +3,7 @@
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 destroyed, or when a stable scope is destroyed.
```lua
local mount = vide.mount
@ -31,14 +31,18 @@ local function Timer()
}
end
local unmount = mount(Timer)
local instance, destroy = root(function(destroy)
local instance = Timer()
return instance, destroy
end)
unmount() -- all queued cleanups are ran, heartbeat connection disconnected
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 reactive scope responsible for creating the timer component is
destroyed, such as when it is unmounted.
when the scope responsible for creating the timer component is destroyed.
::: tip
Roblox instances do not need to be explicitly destroyed for their