readCuboidMovefunction
One piece of notation read for this cuboid: R, R', R2, 2R', M2.
Import it
import { readCuboidMove } from "@johnmorrisdotca/kyuubu/cuboid";
Definition
function readCuboidMove(text: string, dims: CuboidDims): CuboidReading
Parameters
| Name | Type | Description |
|---|---|---|
text | string | The text to parse or format. |
dims | CuboidDims | The cuboid’s x, y and z dimensions, in that order. |
Returns
CuboidReading
One piece of notation read for this cuboid: R, R', R2, 2R', M2.
Examples
import { readCuboidMove } from "@johnmorrisdotca/kyuubu/cuboid";
const dims = [2, 3, 3] as const;
console.log(readCuboidMove("U", dims));{ fault: 'half-turn-only' }What it prints (run when this page was built)