API reference

Every export of the three entrypoints, generated from the TSDoc in the source, so it always matches the code. The examples on these pages are checked like the ones in the guides: the core ones are run and their // => results asserted, and the /dom and /react ones are type-checked.

Looking for how and why rather than what? Each entrypoint has a guide, starting at Getting started.

Modules

Module	Description
@gabreusi/hyrax	The universal entrypoint: it runs in Node, browsers, Deno and Bun, with no DOM and no React.
@gabreusi/hyrax/dom	Utilities for the browser, with no framework. Every function is safe to import and call where there is no document (server-side rendering): it returns its fallback or does nothing.
@gabreusi/hyrax/react	Hooks and components for React 18 and 19, built on @gabreusi/hyrax/dom. They render on the server without a document, and the entrypoint is marked "use client".