mirror of
https://github.com/littensy/charm.git
synced 2026-10-20 17:51:37 +00:00
e9d8dffb02
* build: remove project json files Including Rojo project files in packages interferes with certain Wally packages that depend on roblox-ts packages * build: create project files for release
15 lines
654 B
TypeScript
15 lines
654 B
TypeScript
import { Selector } from "@rbxts/charm";
|
|
|
|
/**
|
|
* A hook that subscribes to changes in the given atom or selector. The
|
|
* component is re-rendered whenever the state changes.
|
|
*
|
|
* If the `dependencies` array is provided, the subscription to the atom or
|
|
* selector is re-created whenever the dependencies change. Otherwise, the
|
|
* subscription is created once when the component is mounted.
|
|
*
|
|
* @param callback The atom or selector to subscribe to.
|
|
* @param dependencies An array of values that the subscription depends on.
|
|
* @returns The current state.
|
|
*/
|
|
export function useAtom<State>(callback: Selector<State>, dependencies?: unknown[]): State;
|