hakowork/charm
3
0
Fork 0
mirror of https://github.com/littensy/charm.git synced 2026-10-20 17:51:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor!: rename derive, map

Browse source
This commit is contained in:
Richard 2024-05-26 21:31:28 -07:00
parent f2f7a16599
commit b715b81fec
18 changed files with 163 additions and 133 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -18,18 +18,15 @@
</div>
**Charm** is a Roblox state management library, inspired by [Jotai](https://jotai.org). Designed to be an alternative to [Reflex](https://littensy.github.io/reflex), Charm aims to bring an atomic and composable approach to your game's state.
**Charm** is an atomic state management library inspired by [Jotai](https://jotai.org). Designed to be a unique alternative to [Reflex](https://littensy.github.io/reflex), Charm aims to provide a simple and composable interface for your game's state.
> [!NOTE]
> Charm is incomplete and not ready for use.
> Charm is incomplete and not ready for production use.
## 📦 Setup
### TypeScript
Install Charm through your package manager of choice. \
[React](https://github.com/littensy/rbxts-react) is optional, but highly recommended.
```sh
npm install @rbxts/charm
yarn add @rbxts/charm
@ -49,17 +46,17 @@ Charm = "littensy/charm@VERSION"
### Charm
#### `atom(state)`
#### `atom(state, options?)`
#### `effect(callback)`
#### `subscribe(atom, listener)`
#### `derive(atom, equals?)`
#### `computed(atom, options?)`
#### `observe(atom, observer)`
#### `map(atom, mapper)`
#### `mapped(atom, mapper)`
#### `peek(atom)`