rl

rl is a simple reactive library for Luau, inspired by Vide's sources and effects system.

Installation

Pesde

# pesde add wiam/rl && pesde install

Wally

Add the following to your wally.toml, in the [dependencies] section:

rl = "wiam77/rl@<version>"

Then run:

# wally install

npm

# npm install @rbxts/rl

API Reference

You can read the API reference in rl's Pesde package page.

Demo

--!strict

local rl = require("path/to/rl")
local s = rl.state
local e = rl.effect

local name = s("john", true)
local login_year = s(2020)

local login_d = e(function(last_login : number)
	print(`{name.value}, it's been {login_year() - (last_login or 0)} years!`)
end)

login_year(2025) -- "wiam, it's been 5 years!"
login_year(2025) -- doesn't print because value didn't change
login_year(2025, true) -- "wiam, it's been 0 years!" - this prints since it's forced

name("doe") -- doesn't print because we are reading with name.value, and not name()

e(function(old_name : string)
	print(`hey {old_name}, your name has been changed to '{name()}'`)
end)

name("jane") -- "hey doe, your name has been changed to jane"
name("jane") -- "hey jane, your name has been changed to jane" - this one is forced by default

login_d()
login_year(2026) -- doesn't print because the effect was disconnected

rl.cleanup() -- disconnect all effects