mirror of
https://github.com/centau/vide.git
synced 2026-08-20 14:41:37 +00:00
94 lines
1.9 KiB
Markdown
94 lines
1.9 KiB
Markdown
# Reactivity API: Utility
|
|
|
|
## cleanup()
|
|
|
|
Runs a callback anytime a reactive scope is reran or destroyed.
|
|
|
|
- **Type**
|
|
|
|
```lua
|
|
function cleanup(callback: () -> ())
|
|
function cleanup(obj: Destroyable)
|
|
function cleanup(obj: Disconnectable)
|
|
|
|
type Destroyable = { destroy: () -> () }
|
|
type Disconnectable = { disconnect: () -> () }
|
|
```
|
|
|
|
- **Example**
|
|
|
|
```lua
|
|
local data = source(1)
|
|
|
|
effect(function()
|
|
local label = create "TextLabel" { Text = data() }
|
|
|
|
cleanup(function()
|
|
label:Destroy()
|
|
end)
|
|
end)
|
|
```
|
|
|
|
## untrack()
|
|
|
|
Runs a given function where any sources read will not be tracked by a reactive
|
|
scope.
|
|
|
|
- **Type**
|
|
|
|
```lua
|
|
function untrack<T>(source: () -> T): T
|
|
```
|
|
|
|
- **Details**
|
|
|
|
Updates made to a source passed to `untrack()` will not cause updates to
|
|
anything depending on that source.
|
|
|
|
- **Example**
|
|
|
|
```lua
|
|
local a = source(0)
|
|
local b = source(0)
|
|
|
|
local sum = derive(function()
|
|
return a() + untrack(b)
|
|
end)
|
|
|
|
print(sum()) -- 0
|
|
b(1)
|
|
print(sum()) -- 0
|
|
a(1)
|
|
print(sum()) -- 2
|
|
```
|
|
|
|
## read()
|
|
|
|
Utility used to read a value that is either a primitive or a source. Sources
|
|
read can still be tracked inside a reactive scope.
|
|
|
|
- **Type**
|
|
|
|
```lua
|
|
function read<T>(value: T | () -> T): T
|
|
```
|
|
|
|
## batch()
|
|
|
|
Runs a given function where any source updates made within the function do not
|
|
trigger effects until after the function runs.
|
|
|
|
- **Type**
|
|
|
|
```lua
|
|
function batch(fn: () -> ())
|
|
```
|
|
|
|
- **Details**
|
|
|
|
Improves performance when an effect depends on multiple sources, and those
|
|
sources need to be updated. Updating those sources inside a batch call will
|
|
only cause the effect to run once after the batch call ends instead of after
|
|
each time a source is updated.
|
|
|
|
--------------------------------------------------------------------------------
|