Hoon literal syntax parsing and rendering. Approaching two nines of parity with hoon stdlib.
npm install @urbit/aura@urbit/auraHoon literal syntax parsing and rendering. Approaching two nines of parity with hoon stdlib.
Supports all standard auras (except @dr and @uc).
Atoms are native bigints. Top-level library functions reflect the hoon stdlib. Aliases are provided for your comfort. Summary of exports below.
``typescript`
const parse = slav;
const tryParse = slaw;
function valid(:aura, :string): boolean;
function slav(:aura, :string): bigint; // throws on failure
function slaw(:aura, :string): bigint | null;
function nuck(:string): coin | null;
`typescript`
const render = scot;
function scot(:aura, :bigint): string;
function rend(:coin): string;
We provide some utilities for desirable operations on specific auras. These too generally match their hoon stdlib equivalents.
`typescript``
const da = {
function toUnix(:bigint): number,
function fromUnix(:number): bigint,
};
const p = {
type rank = 'czar' | 'king' | 'duke' | 'earl' | 'pawn',
type size = 'galaxy' | 'star' | 'planet' | 'moon' | 'comet',
function cite(:bigint | string): string,
function sein(:bigint): bigint,
function sein(:string): string, // throws on bad input
function clan(:bigint | string): rank, // throws on bad input
function kind(:bigint | string): size, // throws on bad input
function rankToSize(:rank): size,
function sizeToRank(:size): rank,
};