@sphinxjs/utilities

Low-level helpers used internally by @sphinxjs/gettext and @sphinxjs/label.

Install

pnpm add @sphinxjs/utilities

API

loadSphinx(getter)

Accepts a SphinxGetter -- either a SphinxContextProps object or a () => SphinxContextProps function -- and returns the underlying Sphinx instance.

import { loadSphinx } from "@sphinxjs/utilities";
import { getSphinx } from "@sphinxjs/core";

const sphinx = loadSphinx(getSphinx); // function form
const sphinx2 = loadSphinx(getSphinx()); // object form

This normalisation means every higher-level function can accept either form without branching.

getDomainSphinx(domain)

Resolves the global Sphinx instance via getSphinx() and returns a domain-bound version of it.

import { getDomainSphinx } from "@sphinxjs/utilities";

const sphinx = getDomainSphinx("messages");