Skip to content
yarunoka.dev

Installation

View Markdown

Terminal window
npm install @yarunoka/builder @yarunoka/core

@yarunoka/core is a peer dependency, so it is installed explicitly: your application owns the engine version, and the builder drives that instance. The package registers nothing, runs no install scripts, and has no bootstrapping step.

Node.js 26 or newer has Temporal built in and needs no polyfill — see Requirements. For runtimes without the Temporal API, install a polyfill once, in your application:

Terminal window
npm install temporal-polyfill
import 'temporal-polyfill/global';

The polyfill belongs to the application rather than to this package — an environment that has Temporal natively should not carry one, and only the application knows which environments it runs in.

import { createYrnkBuilder } from '@yarunoka/builder';
const builder = createYrnkBuilder();
builder.getState().timezone; // "" — a new draft, nothing typed yet
builder.errors().length; // > 0 — an empty draft is not a document yet