Reference · Board and position elements
readEmbedPositionfunction
Reads a GNU position ID or bounded JSON position; null means invalid counts or input.
Import it
import { readEmbedPosition } from "@johnmorrisdotca/sugoroku/element";
Also exported from: @johnmorrisdotca/sugoroku/element/define
Definition
function readEmbedPosition(text: string | null, variant?: VariantKey, turn?: Side): Position | null
Parameters
| Name | Type | Description |
|---|---|---|
text | string | null | Position ID, JSON position, or null for the variant's start. |
variant (optional) | VariantKey | The native variant used for checker counts and layout. |
turn (optional) | Side | The on-roll side encoded by a GNU ID. |
Returns
Position | null
A complete position, or null for malformed or inconsistent input.
Examples
import { readEmbedPosition } from "@johnmorrisdotca/sugoroku/element";
console.log(readEmbedPosition("4HPwATDgc/ABMA")?.points[0].length);24What it prints (run when this page was built)