API Reference

This section provides detailed documentation for all the functions and types exported by the reactive-proxy-state library.

Core APIs

• reactive - Create reactive proxy objects
• ref - Create reactive references for primitive values
• computed - Create derived reactive state
• watchEffect - Run and automatically re-run functions when dependencies change
• watch - Watch specific reactive sources for changes
• updateState - Apply state change events to objects
• markRaw - Flag an object so it is never made reactive

Integrations

• trackVueReactiveEvents - Emit RPS StateEvents from Vue 3 reactivity
• Electron Bridge - Loop-safe bi-directional sync for Electron

Helper Functions

• isRef - Check if a value is a ref object
• unref - Unwrap a ref to get its inner value
• toRefs - Convert reactive object properties to individual refs
• isReactive - Check if an object is a reactive proxy
• toRaw - Retrieve the original (unproxied) object from a reactive proxy
• toRef - Create a ref linked to a property on an object
• triggerRef - Manually trigger effects that depend on a ref
• deepClone - Deep-clone any value with cycle detection
• deepToRaw - Convert reactive/ref structures into plain, clone-safe data
• traverse - Recursively access every property to establish reactive deps (used internally by watch)
• isComputed - Check if a value is a computed ref

Type Definitions

• Ref<T> - Type for ref objects
• ComputedRef<T> - Type for computed refs
• WritableComputedRef<T> - Type for writable computed refs
• WatchSource<T> - Type for sources that can be watched
• WatchEffect - Type for watch effect handlers
• WatchOptions - Type for watch options
• StateEvent - Type for state change events