Skip to content

Browser

The Hyperjump browser is a hypermedia client for JRef. JRef is JSON with references such as { "$ref": "../people/1" }. The browser retrieves JRef documents over HTTP or from files. It follows the references between them for you so you can work with linked documents as if they were one value. This example gets the director of a film from an API written in JRef:

TypeScript
import { Hyperjump, jrefStep, jrefValue } from "@hyperjump/browser";
const h = new Hyperjump({
allowRetrieval: ["https://swapi.hyperjump.io/"]
});
const session = h.session();
const film = await session.get("https://swapi.hyperjump.io/api/films/1");
const director = await jrefStep(session, "director", film);
jrefValue(director); // "George Lucas"

A reference can refer to a value in another document, in a file, or on another server. When you step into a reference, the browser retrieves that value for you.

The browser also works with other media types as long as a parser can turn them into a JRef abstract syntax tree (AST). It reads plain JSON by default, and you can add your own media types and URL schemes.

  • Safe with documents you don’t trust. A document can’t make your app retrieve whatever it references. You choose what the browser can retrieve.
  • HTTP done properly. The browser caches responses according to their caching headers and revalidates stale ones. Concurrent requests for the same URL share one request.
  • Node.js and browsers. It runs on the server and in web browsers.

@hyperjump/json-schema builds on the Hyperjump browser.

Using version 1.x? Its docs are in the 1.x README.