Reference · Pipes, rules and solving
referenceKeyfunction
The key a reference set is kept under.
Import it
import { referenceKey } from "@johnmorrisdotca/suido";Definition
function referenceKey(side: number, kind: Kind, wrap: boolean): stringParameters
| Name | Type | Description |
|---|---|---|
side | number | A side index from 0 north to 3 west, or reference-board side length specified by the signature. |
kind | Kind | The native network, drains or inlet-outlet rule. |
wrap | boolean | Whether opposite board edges connect. |
Returns
string
The key a reference set is kept under.
Examples
import { referenceKey } from "@johnmorrisdotca/suido";
console.log(referenceKey(5,"network",false));5What it prints (run when this page was built)