hakowork/charm
3
0
Fork 0
mirror of https://github.com/littensy/charm.git synced 2026-10-22 21:01:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: note peek in migration guide

Browse source
This commit is contained in:
littensy 2026-03-22 13:09:29 -07:00
parent fd6b3efbb5
commit 9f7047d484
1 changed files with 1 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -963,6 +963,7 @@ For reference, a signal is a state container with a separated getter and setter
**What to look out for:** **What to look out for:**
1. Address all of the type errors introduced in your project after updating Charm. Most of them are caused by changes like: 1. Address all of the type errors introduced in your project after updating Charm. Most of them are caused by changes like:
- `peek()` was changed to `untracked()` for parity with other state managers
- The second arguments of `atom()` changed from an `options` table to an equality function - The second arguments of `atom()` changed from an `options` table to an equality function
- Removed the second argument of `computed()` (you can do your own equality checks since the computed callback now receives the previous value) - Removed the second argument of `computed()` (you can do your own equality checks since the computed callback now receives the previous value)
- Removed the cleanup argument in effect callbacks (`effect(function(cleanup) end)`) - Removed the cleanup argument in effect callbacks (`effect(function(cleanup) end)`)