Skip to the content

Kazu数

Generate checked Sudoku and logic puzzles, read native rules and hints, and draw or embed playable boards.

Kazu is the Japanese word 数 for number. About the name

Contents

Reference · Shikaku rules

encodeShikakufunction

Versioned public puzzle and placement data, with no hidden answer.

Import it

import { encodeShikaku } from "@johnmorrisdotca/kazu/shikaku";

Also exported from: @johnmorrisdotca/kazu

Definition

function encodeShikaku(game: ShikakuGame): string

Parameters

NameTypeDescription
gameShikakuGame

The current immutable game state.

Returns

string

Versioned public puzzle and placement data, with no hidden answer.

Examples

import type { ShikakuBoard } from "@johnmorrisdotca/kazu/shikaku";
import { encodeShikaku, newShikaku } from "@johnmorrisdotca/kazu/shikaku";

const shikakuBoard: ShikakuBoard = {"width":5,"height":5,"clues":[3,0,0,0,2,0,0,0,0,4,0,0,0,0,0,0,0,0,0,3,4,3,6,0,0]};
const shikakuGame = newShikaku(shikakuBoard);
console.log(encodeShikaku(shikakuGame));
{"version":1,"board":{"width":5,"height":5,"clues":[3,0,0,0,2,0,0,0,0,4,0,0,0,0,0,0,0,0,0,3,4,3,6,0,0]},"rectangles":[],"helped":false}

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/kazu 2.1.0.