Reference · Cube engine and views
summarizefunction
A record's scramble and turns in notation, the cube before and after, whether it ended solved, and its count of moves.
Import it
import { summarize } from "@johnmorrisdotca/kyuubu";
Definition
function summarize(record: SolveRecord): SolveSummary
Parameters
| Name | Type | Description |
|---|---|---|
record | SolveRecord | The solve record to summarize or write. |
Returns
SolveSummary
A record's scramble and turns in notation, the cube before and after, whether it ended solved, and its count of moves.
Examples
import { parseMoves, summarize } from "@johnmorrisdotca/kyuubu";
const moves = parseMoves("R U2", 3)!;
const record = { size: 3, scramble: parseMoves("R", 3)!, moves: parseMoves("R'", 3)!, ms: 1000, seed: "docs" };
console.log(summarize(record));{
size: 3,
scramble: 'R',
moves: "R'",
start: 'UUFUUFUUFRRRRRRRRRFFDFFDFFDDDBDDBDDBLLLLLLLLLUBBUBBUBB',
state: 'UUUUUUUUURRRRRRRRRFFFFFFFFFDDDDDDDDDLLLLLLLLLBBBBBBBBB',
solved: true,
count: 1
}What it prints (run when this page was built)