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

Limit cleanup() calls to once per scope

Browse source
This commit is contained in:
Aaron Smith 2023-08-22 11:46:56 +01:00
parent 2aebaf5abb
commit 0105e33fac
5 changed files with 63 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/api/reactivity-utility.md
View file

@ -2,7 +2,7 @@
## cleanup()
Runs a callback anytime a reactive scope is re-ran.
Runs a callback anytime a function scope is re-ran.
- **Type**
@ -10,6 +10,19 @@ Runs a callback anytime a reactive scope is re-ran.
function cleanup(callback: () -> ())
```
- **Details**
The primary purpose of this function is to provide a means of cleaning up
side effects caused by source updates and `watch()` updates.
The stack is inspected to find the function that calls `cleanup()`. The
callback passed is called anytime the caller is re-ran, and when the caller
finally garbage collects.
::: warning
Only one `cleanup()` call is allowed per function scope.
:::
- **Example**
```lua