Skip to content

Reference

This section maps the public Starbeam package and adapter surface. These pages are hand-written reference cards, not a generated API encyclopedia.

If you are choosing what to install first, start with Install Starbeam.

  • @starbeam/collections: reactive Map, Set, array, and object helpers for collection-shaped and object-shaped root state. Start with Collections or the Collections and objects concept guide.
  • @starbeam/universal: framework-neutral lifecycle APIs such as Resource, plus compatibility exports for lower-level primitives. See Universal APIs.
  • Framework adapters: @starbeam/react, @starbeam/preact, @starbeam/ember, @starbeam/vue, and @starbeam/svelte connect Starbeam to framework rendering and lifecycle. The Svelte adapter is a current experimental slice with reads and element resources but no component-resource or service helpers yet. See Framework adapters.
  • @starbeam/resource: resource APIs for reusable setup, sync, and cleanup abstractions. App code often reaches resources through @starbeam/universal or a framework adapter first. Start with Resources or Resources and lifecycle for the app-author model.
  • @starbeam/service: app-lifetime resource composition. Use it for shared state that should live with the app or framework root. App authors usually reach services through framework adapter helpers. Start with Services or Services and app lifetime.
  • @starbeam/reactive: lower-level primitives for authors building reactive storage or integration primitives. Most app and library models should start with @starbeam/collections and @starbeam/universal. See Reactive primitives.
  • @starbeam/use-strict-lifecycle: public React lifecycle infrastructure for library and adapter authors. App code should start with @starbeam/react.
  • @starbeam/core: deprecated compatibility alias for @starbeam/universal. Existing code can keep using it during the compatibility window; new code should not start there. See Core compatibility for migration notes.