Skip to the content

Kazu documentation

Kazu API: every export

Every export of every entry point, each with its own page. This page keeps the addresses the old one-page reference had.

@johnmorrisdotca/kazu/draw

drawKazufunction

A PUZZLE AS SVG TEXT: the grid with its printed numbers, whatever has been written in it, pencil marks, and everything the kind of puzzle prints: the heavier rules round the boxes or a Jigsaw's regions, the shaded diagonals, a cage's dashed outline with its sum, the more-than marks between cells, and the tower clues round the edge.

drawShikakufunction

SVG text with only the public clues and the player's rectangles.

KAZU_CELLconstant

The units of a cell, and the margin round the drawing.

KAZU_NAMESconstant

Bilingual puzzle names, aliases, rules, origins and introductory copy by native kind.

KAZU_SIZE_NAMESconstant

What each side is for, under its size on a chooser: the quick one, the usual one, the long one.

KAZU_STRINGSconstant

Native English and Japanese labels, announcements and interpolation templates for the number grid.

KAZU_STYLEconstant

THE STYLE a Kazu drawing wears: the colours of its board as custom properties, and the one rule that matters for a puzzle played with fingers: nothing in the drawing can be selected, dragged or double-tapped.

kazuCellNamefunction

A cell as a screen reader names it: "row 3, column 5".

kazuGeometryfunction

Where everything is in the drawing of a puzzle of this kind and side.

KazuGeometrytype

WHERE EVERYTHING IS IN A DRAWING, so a page of your own can play it: the drawing is a square of side units, every cell cell units across, and a Towers square sits inside a ring one cell deep that holds its clues.

KazuLanguagetype

THE WORDS A KAZU BOARD SAYS, in English and Japanese: what a screen reader hears of the drawing, the buttons and lines under a playable board, and what a hint says.

kazuLanguageOffunction

The language a piece of text is in: Japanese for anything starting ja, English for everything else.

KazuNametype

WHAT EACH PUZZLE IS CALLED, and what it is, in English and Japanese: the name a player searches for, its Japanese name, a line saying how it is played, and a few lines of rules.

kazuNameOffunction

What a puzzle is called in a language, as a screen reader says it.

kazuSayfunction

A line in a language, with its values filled in; the line itself if there is none by that name.

kazuWherefunction

The words for the groups a number is ruled out by, for a hint's line: "its row, column and box".

ShikakuDrawOptionstype

Current Shikaku marks or entries, selection, errors and native SVG appearance choices.

@johnmorrisdotca/kazu/play

ensureKazuPlayStylefunction

Put the style in the page once: in the document's head, or in the shadow root the host is in.

KAZU_PLAY_STYLEconstant

THE STYLE a playable Kazu board wears (mountKazu, <kazu-board>): the drawing's own (KAZU_STYLE) and the board's box, its number pad, its buttons and its lines of words.

kazuClockTextfunction

A time taken, as a clock shows it: m:ss, and h:mm:ss past an hour.

KazuMounttype

The native mounted number grid, its current game/detail, controls and cleanup methods.

KazuMountOptionstype

The puzzle, optional solution/progress, assistance, controls and event callbacks for mounting a number grid.

KazuMountSettingstype

Everything about how a mounted board plays that can change while it is on the page.

mountKazufunction

Draw a puzzle into host and play it.

mountShikakufunction

A rectangle player in any element; mount once, update appearance with set, destroy on unmount.

SHIKAKU_STRINGSconstant

Native English and Japanese labels and announcements for Shikaku.

ShikakuDrawOptionstype

Current Shikaku marks or entries, selection, errors and native SVG appearance choices.

ShikakuLanguagetype

The native English or Japanese display language for Shikaku.

ShikakuMounttype

The mounted Shikaku game and progress, native controls and cleanup handle.

ShikakuMountOptionstype

The initial Shikaku board, native progress, appearance and host event callbacks.

ShikakuPiecestype

A supported native Shikaku mark or piece appearance.

@johnmorrisdotca/kazu/element

defineBoardfunction

Register a standard or custom board tag without replacing a definition.

KAZU_EMBED_OPTION_KEYSconstant

Every mounted-board option, kept complete by TypeScript and checked by the builder.

KazuBoardclass

Native custom element with reflected setup and presentation.

@johnmorrisdotca/kazu/element/define

defineBoardfunction

Register a standard or custom board tag without replacing a definition.

KAZU_EMBED_OPTION_KEYSconstant

Every mounted-board option, kept complete by TypeScript and checked by the builder.

KazuBoardclass

Native custom element with reflected setup and presentation.

@johnmorrisdotca/kazu/shikaku

checkShikakufunction

A finished partition is checked against the rules, never against a stored answer.

decodeShikakufunction

Read a native saved Shikaku game, or null for invalid board data or progress.

encodeShikakufunction

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

generateShikakufunction

Seeded rectangles packed into the board, one number each, with an independently counted, unique answer.

generateShikakuChallengefunction

Generate a seeded Shikaku puzzle with a verified unique answer; unsupported inputs or exhausted attempts throw.

hintShikakufunction

A rectangle is offered only when the remaining partition has one proved answer.

isShikakuBoardfunction

Whether dimensions and area clues describe a possible partition.

newShikakufunction

Begin with a copy of just the public clues; a generated answer is never kept in play.

placeShikakufunction

Place a rectangle, replacing any it touches.

rateShikakufunction

Rates a board with one answer by solving it with the first rule, with the first two, with all three, then by supposing.

SHIKAKU_CHALLENGE_PACKSconstant

Three short, named challenge routes using the regular seeded unique-puzzle generator.

SHIKAKU_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateShikaku.

SHIKAKU_SIZESconstant

The sides on offer for a square board; any side from 2 to SHIKAKU_MOST_SIDE can be made.

ShikakuBoardtype

One area clue per rectangle; zero is an unnumbered cell.

shikakuCandidatesfunction

All legal rectangles for a numbered cell, in a stable order.

shikakuCellsfunction

Cells of a bounded rectangle, or null for invalid coordinates.

ShikakuChallengetype

The named route, board shape, difficulty and seed of one Shikaku challenge.

ShikakuChecktype

The Shikaku completion result and cells that violate its native rules.

shikakuFinishedfunction

Whether this Shikaku game satisfies its complete native rules.

ShikakuGametype

The immutable Shikaku board, current entries or marks, undo history and assistance state.

ShikakuLeveltype

A native difficulty tier for generated Shikaku puzzles.

ShikakuPackKeytype

One of the square, wide or tall native Shikaku challenge routes.

ShikakuPuzzletype

A seeded Shikaku board with its verified solution and native difficulty tier.

ShikakuSolvetype

A bounded Shikaku solve result: answer count, first solution, node work and whether the search completed.

undoShikakufunction

Return the Shikaku game with its previous marks or entries restored, or unchanged when there is no undo history.

@johnmorrisdotca/kazu/shikaku/play

mountShikakufunction

A rectangle player in any element; mount once, update appearance with set, destroy on unmount.

SHIKAKU_STRINGSconstant

Native English and Japanese labels and announcements for Shikaku.

ShikakuDrawOptionstype

Current Shikaku marks or entries, selection, errors and native SVG appearance choices.

ShikakuLanguagetype

The native English or Japanese display language for Shikaku.

ShikakuMounttype

The mounted Shikaku game and progress, native controls and cleanup handle.

ShikakuMountOptionstype

The initial Shikaku board, native progress, appearance and host event callbacks.

ShikakuPiecestype

A supported native Shikaku mark or piece appearance.

@johnmorrisdotca/kazu/shikaku/draw

drawShikakufunction

SVG text with only the public clues and the player's rectangles.

ShikakuDrawOptionstype

Current Shikaku marks or entries, selection, errors and native SVG appearance choices.

@johnmorrisdotca/kazu/hitori

checkHitorifunction

Checks unshaded row and column duplicates, adjacent shades, and white connectivity.

decodeHitorifunction

Read a native saved Hitori game, or null for invalid board data or progress.

encodeHitorifunction

Versioned public clue and mark data; the generated answer is not saved.

generateHitorifunction

Makes a seeded puzzle and proves its answer is the only one.

hintHitorifunction

Gives one next shade in the unique minimal solution, if uniqueness was proved.

HITORI_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateHitori.

HITORI_SIZESconstant

The sides on offer; any side from 4 to HITORI_MOST_SIDE is a board isHitoriBoard takes.

HitoriBoardtype

Hitori dimensions and printed clues in their native row-major representation.

HitoriGametype

The immutable Hitori board, current entries or marks, undo history and assistance state.

HitoriLeveltype

A native difficulty tier for generated Hitori puzzles.

hitoriNeighborsfunction

Read orthogonally adjacent cells on a square Hitori board.

HitoriPuzzletype

A seeded Hitori board with its verified solution and native difficulty tier.

HitoriRatingtype

How hard a board is, measured by solving it.

HitoriSolvetype

A bounded Hitori solve result: answer count, first solution, node work and whether the search completed.

isHitoriBoardfunction

Whether the value has valid native Hitori dimensions, clues and data.

newHitorifunction

Create the initial immutable Hitori game from a valid board.

rateHitorifunction

Rates a board with one answer by solving it: with the plain rules, with the whites-stay-together rule, then by supposing.

restartHitorifunction

Return the Hitori game reset to its initial entries or marks.

shadeHitorifunction

Apply the requested native Hitori entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

solveHitorifunction

Counts distinct minimal shade patterns: an answer shades only squares that settle a duplicate, so extra shades are never a second answer.

undoHitorifunction

Return the Hitori game with its previous marks or entries restored, or unchanged when there is no undo history.

@johnmorrisdotca/kazu/hitori/play

HITORI_STRINGSconstant

Native English and Japanese labels and announcements for Hitori.

HitoriDrawOptionstype

Current Hitori marks or entries, selection, errors and native SVG appearance choices.

HitoriLanguagetype

The native English or Japanese display language for Hitori.

HitoriMounttype

The mounted Hitori game and progress, native controls and cleanup handle.

HitoriMountOptionstype

The initial Hitori board, native progress, appearance and host event callbacks.

HitoriPiecestype

A supported native Hitori mark or piece appearance.

mountHitorifunction

A keyboard- and touch-friendly Hitori player, mounted in any host element.

@johnmorrisdotca/kazu/hitori/draw

drawHitorifunction

SVG text contains only the public numbers and the player's marks.

HitoriDrawOptionstype

Current Hitori marks or entries, selection, errors and native SVG appearance choices.

@johnmorrisdotca/kazu/nurikabe

checkNurikabefunction

Checks island areas and separation, the connected sea, and the ban on 2×2 sea blocks.

decodeNurikabefunction

Read a native saved Nurikabe game, or null for invalid board data or progress.

encodeNurikabefunction

Encode the Nurikabe board and current game as native resumable text.

generateNurikabefunction

Seeded symmetries of original 5×5 layouts are returned only after the solver proves uniqueness.

hintNurikabefunction

Find a native Nurikabe hint, or null when no actionable hint is available.

isNurikabeBoardfunction

Whether the value has valid native Nurikabe dimensions, clues and data.

markNurikabeSeafunction

Apply the requested native Nurikabe entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

newNurikabefunction

Create the initial immutable Nurikabe game from a valid board.

NurikabeBoardtype

Nurikabe dimensions and printed clues in their native row-major representation.

NurikabeGametype

The immutable Nurikabe board, current entries or marks, undo history and assistance state.

nurikabeNeighborsfunction

Read orthogonally adjacent cells on a square Nurikabe board.

NurikabePuzzletype

A seeded Nurikabe board with its verified solution.

NurikabeSolvetype

A bounded Nurikabe solve result: answer count, first solution, node work and whether the search completed.

restartNurikabefunction

Return the Nurikabe game reset to its initial entries or marks.

solveNurikabefunction

Counts valid island placements and checks the remaining cells as the sea under a finite budget.

undoNurikabefunction

Return the Nurikabe game with its previous marks or entries restored, or unchanged when there is no undo history.

@johnmorrisdotca/kazu/nurikabe/play

mountNurikabefunction

A keyboard- and touch-friendly Nurikabe player, mounted in any host element.

NURIKABE_STRINGSconstant

Native English and Japanese labels and announcements for Nurikabe.

NurikabeDrawOptionstype

Current Nurikabe marks or entries, selection, errors and native SVG appearance choices.

NurikabeLanguagetype

The native English or Japanese display language for Nurikabe.

NurikabeMounttype

The mounted Nurikabe game and progress, native controls and cleanup handle.

NurikabeMountOptionstype

The initial Nurikabe board, native progress, appearance and host event callbacks.

NurikabePiecestype

A supported native Nurikabe mark or piece appearance.

@johnmorrisdotca/kazu/nurikabe/draw

drawNurikabefunction

SVG text contains the numbered clues and the player's sea marks only.

NurikabeDrawOptionstype

Current Nurikabe marks or entries, selection, errors and native SVG appearance choices.

@johnmorrisdotca/kazu/akari

AKARI_DENSER_CROWDSconstant

When a level finds no board in AKARI_MOST_ATTEMPTS plain attempts (a large board of an easy level, mostly: one attempt in a hundred succeeds on a 14×14), the generator tries again with more black squares, each of these multiples of the usual share in turn, AKARI_DENSER_ATTEMPTS attempts at each.

AKARI_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateAkari.

AKARI_SIZESconstant

The sides the demo and the site offer for a square board; any side from 2 to AKARI_MOST_SIDE can be made.

AKARI_STRINGSconstant

Native English and Japanese labels and announcements for Akari.

AkariChecktype

The Akari completion result and cells that violate its native rules.

AkariDrawOptionstype

Current Akari marks or entries, selection, errors and native SVG appearance choices.

akariFinishedfunction

A game is finished only when its bulbs satisfy every rule and light every white square.

AkariGametype

The immutable Akari board, current entries or marks, undo history and assistance state.

AkariLanguagetype

The native English or Japanese display language for Akari.

AkariLeveltype

A native difficulty tier for generated Akari puzzles.

AkariMaterialtype

A supported material of the native Akari board.

AkariMounttype

The mounted Akari game and progress, native controls and cleanup handle.

AkariMountOptionstype

The initial Akari board, native progress, appearance and host event callbacks.

akariNeighboursfunction

Returns the orthogonally adjacent cells to a board position.

AkariPiecestype

A supported native Akari mark or piece appearance.

AkariProgresstype

The Akari constraint status of a partial board.

AkariPuzzletype

A seeded Akari board with its verified solution and native difficulty tier.

AkariRatingtype

How hard a board is, measured by solving it.

AkariSolvetype

A bounded Akari solve result: answer count, first solution, node work and whether the search completed.

akariVisiblefunction

White squares visible from a cell, including itself, stopping at black squares and edges.

checkAkarifunction

Checks a complete placement from the public rules, without consulting a stored answer.

decodeAkarifunction

Decodes a bounded save after validating the board and each placement.

drawAkarifunction

Draws the public clues and current bulbs as SVG.

encodeAkarifunction

Encodes only public clues and player placements.

generateAkarifunction

Makes a seeded board and proves it has one answer.

hintAkarifunction

Returns a missing bulb, or an extra bulb to remove, only after uniqueness is proved.

isAkariBoardfunction

Validates dimensions and the three public square kinds.

mountAkarifunction

Mounts the player in a host element; call destroy when the host is removed.

newAkarifunction

Starts a game with only its public board data.

progressAkarifunction

Reports immediate contradictions while allowing required clues to remain unsatisfied during play.

rateAkarifunction

Rates a board by solving it as a person would: with the rules alone (depth 0), then with one supposition at a time (depth 1), and anything beyond that is depth 2.

solveAkarifunction

Bounded constraint search over the rules in akariLogic.ts; a stopped proof is always marked incomplete.

toggleAkarifunction

Toggles a bulb on a white square and keeps one prior turn for undo.

undoAkarifunction

Restores the last bulb placement.

@johnmorrisdotca/kazu/akari/play

AkariDrawOptionstype

Current Akari marks or entries, selection, errors and native SVG appearance choices.

AkariLanguagetype

The native English or Japanese display language for Akari.

AkariMaterialtype

A supported material of the native Akari board.

AkariMounttype

The mounted Akari game and progress, native controls and cleanup handle.

AkariMountOptionstype

The initial Akari board, native progress, appearance and host event callbacks.

AkariPiecestype

A supported native Akari mark or piece appearance.

mountAkarifunction

Mounts the player in a host element; call destroy when the host is removed.

@johnmorrisdotca/kazu/akari/draw

AkariDrawOptionstype

Current Akari marks or entries, selection, errors and native SVG appearance choices.

drawAkarifunction

Draws the public clues and current bulbs as SVG.

@johnmorrisdotca/kazu/juosan

checkJuosanfunction

Checks public rules directly, independently of the solver and stored answer.

decodeJuosanfunction

Reads a bounded public save; malformed or incompatible data returns null.

drawJuosanfunction

Draws a public Juosan board as an SVG string.

encodeJuosanfunction

Serializes public clues, placements, and assisted status.

generateJuosanfunction

Makes an original small training puzzle and returns it only after uniqueness is proved.

hintJuosanfunction

Returns one next mark only when the public clues prove a unique answer.

isJuosanBoardfunction

Whether territories partition a bounded board and each territory is connected.

JUOSAN_LEVELSconstant

The native Juosan generation difficulty tiers.

JUOSAN_STRINGSconstant

Native English and Japanese labels and announcements for Juosan.

JuosanBoardtype

Juosan dimensions and printed clues in their native row-major representation.

JuosanChecktype

The Juosan completion result and cells that violate its native rules.

JuosanDrawOptionstype

Current Juosan marks or entries, selection, errors and native SVG appearance choices.

juosanFinishedfunction

Whether every cell is filled and the independent checker accepts the board.

JuosanGametype

The immutable Juosan board, current entries or marks, undo history and assistance state.

JuosanLanguagetype

The native English or Japanese display language for Juosan.

JuosanLeveltype

A native difficulty tier for generated Juosan puzzles.

JuosanMarktype

A blank, horizontal or vertical mark in a Juosan cell.

JuosanMounttype

The mounted Juosan game and progress, native controls and cleanup handle.

JuosanMountOptionstype

The initial Juosan board, native progress, appearance and host event callbacks.

JuosanPiecestype

A supported native Juosan mark or piece appearance.

JuosanPuzzletype

A seeded Juosan board with its verified solution and native difficulty tier.

JuosanSolvetype

A bounded Juosan solve result: answer count, first solution, node work and whether the search completed.

JuosanTerritorytype

A territory is a list of zero-based cell indexes and an absolute orientation difference.

juosanTerritoryAtfunction

Returns the index of the territory containing a cell, or -1 when absent.

mountJuosanfunction

Mounts a touch, mouse, and keyboard player into an existing page element.

newJuosanfunction

Starts a game with a copy of its public board and no generated answer.

restartJuosanfunction

Clears the board while retaining whether the player used a hint.

setJuosanMarkfunction

Writes a mark and records the previous state; invalid or unchanged moves are ignored.

solveJuosanfunction

Counts labeled solutions up to a limit; complete distinguishes exhaustion from cutoff.

undoJuosanfunction

Restores the preceding mark state, if one exists.

@johnmorrisdotca/kazu/juosan/play

JUOSAN_STRINGSconstant

Native English and Japanese labels and announcements for Juosan.

JuosanDrawOptionstype

Current Juosan marks or entries, selection, errors and native SVG appearance choices.

JuosanLanguagetype

The native English or Japanese display language for Juosan.

JuosanMounttype

The mounted Juosan game and progress, native controls and cleanup handle.

JuosanMountOptionstype

The initial Juosan board, native progress, appearance and host event callbacks.

JuosanPiecestype

A supported native Juosan mark or piece appearance.

mountJuosanfunction

Mounts a touch, mouse, and keyboard player into an existing page element.

@johnmorrisdotca/kazu/juosan/draw

drawJuosanfunction

Draws a public Juosan board as an SVG string.

JuosanDrawOptionstype

Current Juosan marks or entries, selection, errors and native SVG appearance choices.

@johnmorrisdotca/kazu/loop

checkLoopfunction

Checks all numbered cells, degree-two vertices, and one connected closed loop.

decodeLoopfunction

Read a native saved Loop game, or null for invalid board data or progress.

drawLoopfunction

Draws public clues and selected loop edges as an SVG board.

edgeVerticesfunction

Read the two vertex indices at the ends of a native Loop edge.

encodeLoopfunction

Encode the Loop board and current game as native resumable text.

generateLoopfunction

Makes a seeded puzzle and proves it has one answer.

hintLoopfunction

Find a native Loop hint, or null when no actionable hint is available.

isLoopBoardfunction

Whether the value has valid native Loop dimensions, clues and data.

LOOP_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateLoop.

LOOP_SIZESconstant

The sides on offer for a square board; any side from 2 to LOOP_MOST_SIDE can be made.

LoopBoardtype

Loop dimensions and printed clues in their native row-major representation.

loopCellEdgesfunction

Read the four edges around a cell, or null for a cell outside the board.

LoopChecktype

The Loop completion result and cells that violate its native rules.

LoopDrawOptionstype

Current Loop marks or entries, selection, errors and native SVG appearance choices.

loopEdgeCountfunction

An edge index is horizontal row-major first, then vertical row-major.

loopFinishedfunction

Whether this Loop game satisfies its complete native rules.

LoopGametype

The immutable Loop board, current entries or marks, undo history and assistance state.

loopHorizontalCountfunction

Count horizontal edges in the Loop board’s native edge numbering.

LoopLanguagetype

The native English or Japanese display language for Loop.

LoopLeveltype

A native difficulty tier for generated Loop puzzles.

LoopMaterialtype

A supported material of the native Loop board.

LoopMounttype

The mounted Loop game and progress, native controls and cleanup handle.

LoopMountOptionstype

The initial Loop board, native progress, appearance and host event callbacks.

LoopProgresstype

The Loop constraint status of a partial board.

LoopPuzzletype

A seeded Loop board with its verified solution and native difficulty tier.

LoopRatingtype

How hard a board is, measured by solving it.

LoopSolvetype

A bounded Loop solve result: answer count, first solution, node work and whether the search completed.

mountLoopfunction

Mounts an accessible dot-and-edge loop player in the given host element.

newLoopfunction

Create the initial immutable Loop game from a valid board.

progressLoopfunction

Reports overfilled clues and branched vertices during play without requiring a finished loop.

rateLoopfunction

Rates a board with one answer by solving it as a person would: with the rules, then by supposing one edge at a time.

solveLoopfunction

Counts loop solutions with the pruning in loopLogic.ts under explicit work bounds.

toggleLoopfunction

Apply the requested native Loop entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

undoLoopfunction

Return the Loop game with its previous marks or entries restored, or unchanged when there is no undo history.

@johnmorrisdotca/kazu/loop/play

LOOP_STRINGSconstant

Native English and Japanese labels and announcements for Loop.

LoopDrawOptionstype

Current Loop marks or entries, selection, errors and native SVG appearance choices.

LoopLanguagetype

The native English or Japanese display language for Loop.

LoopMaterialtype

A supported material of the native Loop board.

LoopMounttype

The mounted Loop game and progress, native controls and cleanup handle.

LoopMountOptionstype

The initial Loop board, native progress, appearance and host event callbacks.

mountLoopfunction

Mounts an accessible dot-and-edge loop player in the given host element.

@johnmorrisdotca/kazu/loop/draw

drawLoopfunction

Draws public clues and selected loop edges as an SVG board.

LoopDrawOptionstype

Current Loop marks or entries, selection, errors and native SVG appearance choices.

@johnmorrisdotca/kazu/masyu

checkMasyufunction

Validate a Masyu answer against the printed clues and complete native rules.

decodeMasyufunction

Read a native saved Masyu game, or null for invalid board data or progress.

encodeMasyufunction

Encode the Masyu board and current game as native resumable text.

generateMasyufunction

Seeded original loop layouts; every output is accepted only after a completed uniqueness proof.

hintMasyufunction

Find a native Masyu hint, or null when no actionable hint is available.

isMasyuBoardfunction

Whether the value has valid native Masyu dimensions, clues and data.

MasyuBoardtype

Masyu dimensions and printed clues in their native row-major representation.

MasyuChecktype

The Masyu completion result and cells that violate its native rules.

MasyuDrawOptionstype

Current Masyu marks or entries, selection, errors and native SVG appearance choices.

masyuFinishedfunction

Whether this Masyu game satisfies its complete native rules.

MasyuGametype

The immutable Masyu board, current entries or marks, undo history and assistance state.

MasyuMounttype

The mounted Masyu game and progress, native controls and cleanup handle.

MasyuMountOptionstype

The initial Masyu board, native progress, appearance and host event callbacks.

masyuNeighborsfunction

Read adjacent Masyu cells with the joining edge and direction.

MasyuPuzzletype

A seeded Masyu board with its verified solution.

MasyuSolvetype

A bounded Masyu solve result: answer count, first solution, node work and whether the search completed.

newMasyufunction

Create the initial immutable Masyu game from a valid board.

restartMasyufunction

Return the Masyu game reset to its initial entries or marks.

solveMasyufunction

Counts distinct single loops with local pearl rules; budget stops never claim a proof.

toggleMasyuEdgefunction

Apply the requested native Masyu entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

undoMasyufunction

Return the Masyu game with its previous marks or entries restored, or unchanged when there is no undo history.

@johnmorrisdotca/kazu/masyu/play

MASYU_STRINGSconstant

Native English and Japanese labels and announcements for Masyu.

MasyuDrawOptionstype

Current Masyu marks or entries, selection, errors and native SVG appearance choices.

MasyuMounttype

The mounted Masyu game and progress, native controls and cleanup handle.

MasyuMountOptionstype

The initial Masyu board, native progress, appearance and host event callbacks.

mountMasyufunction

Mount the native Masyu player in a host element and return its cleanup and control handle.

@johnmorrisdotca/kazu/masyu/draw

drawMasyufunction

Render the Masyu board and supplied current state as native SVG text.

MasyuDrawOptionstype

Current Masyu marks or entries, selection, errors and native SVG appearance choices.

@johnmorrisdotca/kazu/yajilin

checkYajilinfunction

Validate a Yajilin answer against the printed clues and complete native rules.

decodeYajilinfunction

Read a native saved Yajilin game, or null for invalid board data or progress.

encodeYajilinfunction

Encode the Yajilin board and current game as native resumable text.

generateYajilinfunction

Seeded original 5×5 families, accepted only after a completed uniqueness proof.

hintYajilinfunction

Find a native Yajilin hint, or null when no actionable hint is available.

isYajilinBoardfunction

Whether the value has valid native Yajilin dimensions, clues and data.

newYajilinfunction

Create the initial immutable Yajilin game from a valid board.

restartYajilinfunction

Return the Yajilin game reset to its initial entries or marks.

solveYajilinfunction

Counts public shade patterns whose remaining cells form the single required loop.

toggleYajilinEdgefunction

Apply the requested native Yajilin entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

toggleYajilinShadefunction

Apply the requested native Yajilin entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

undoYajilinfunction

Return the Yajilin game with its previous marks or entries restored, or unchanged when there is no undo history.

YajilinBoardtype

Yajilin dimensions and printed clues in their native row-major representation.

YajilinChecktype

The Yajilin completion result and cells that violate its native rules.

YajilinCluetype

An arrow direction and the required number of shaded cells in its ray.

YajilinDrawOptionstype

Current Yajilin marks or entries, selection, errors and native SVG appearance choices.

YajilinGametype

The immutable Yajilin board, current entries or marks, undo history and assistance state.

YajilinMounttype

The mounted Yajilin game and progress, native controls and cleanup handle.

YajilinMountOptionstype

The initial Yajilin board, native progress, appearance and host event callbacks.

YajilinPuzzletype

A seeded Yajilin board with its verified solution.

yajilinRayfunction

Read cells in the arrow’s indicated direction, excluding its own clue cell.

YajilinSolvetype

A bounded Yajilin solve result: answer count, first solution, node work and whether the search completed.

@johnmorrisdotca/kazu/yajilin/play

mountYajilinfunction

Mount the native Yajilin player in a host element and return its cleanup and control handle.

YAJILIN_STRINGSconstant

Native English and Japanese labels and announcements for Yajilin.

YajilinDrawOptionstype

Current Yajilin marks or entries, selection, errors and native SVG appearance choices.

YajilinMounttype

The mounted Yajilin game and progress, native controls and cleanup handle.

YajilinMountOptionstype

The initial Yajilin board, native progress, appearance and host event callbacks.

@johnmorrisdotca/kazu/yajilin/draw

drawYajilinfunction

Render the Yajilin board and supplied current state as native SVG text.

YajilinDrawOptionstype

Current Yajilin marks or entries, selection, errors and native SVG appearance choices.

@johnmorrisdotca/kazu/ripple

checkRipplefunction

Checks room permutations and the at-least-N-cell gap between equal N clues in a line.

decodeRipplefunction

Read a native saved Ripple game, or null for invalid board data or progress.

drawRipplefunction

Render the Ripple board and supplied current state as native SVG text.

encodeRipplefunction

Encode the Ripple board and current game as native resumable text.

generateRipplefunction

Builds a seeded block-room family and accepts it only after a bounded uniqueness proof.

hintRipplefunction

Offers a cell only when the current public entries leave one proved completion.

isRippleBoardfunction

Whether the value has valid native Ripple dimensions, clues and data.

mountRipplefunction

Mount the native Ripple player in a host element and return its cleanup and control handle.

newRipplefunction

Create the initial immutable Ripple game from a valid board.

progressRipplefunction

Partial progress check; missing entries are allowed, but impossible room/ripple pairs are flagged.

RIPPLE_STRINGSconstant

Native English and Japanese labels and announcements for Ripple.

RippleBoardtype

Ripple dimensions and printed clues in their native row-major representation.

RippleChecktype

The Ripple completion result and cells that violate its native rules.

RippleDrawOptionstype

Current Ripple marks or entries, selection, errors and native SVG appearance choices.

rippleFinishedfunction

Whether this Ripple game satisfies its complete native rules.

RippleGametype

The immutable Ripple board, current entries or marks, undo history and assistance state.

RippleLanguagetype

The native English or Japanese display language for Ripple.

RippleMounttype

The mounted Ripple game and progress, native controls and cleanup handle.

RippleMountOptionstype

The initial Ripple board, native progress, appearance and host event callbacks.

RipplePiecestype

A supported native Ripple mark or piece appearance.

RipplePuzzletype

A seeded Ripple board with its verified solution.

rippleRoomSizesfunction

Read the size of each room in a Ripple Effect board.

RippleSolvetype

A bounded Ripple solve result: answer count, first solution, node work and whether the search completed.

setRippleValuefunction

Apply the requested native Ripple entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

solveRipplefunction

Counts rule-valid fillings within an explicit node budget.

toggleRippleNotefunction

Apply the requested native Ripple entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

undoRipplefunction

Return the Ripple game with its previous marks or entries restored, or unchanged when there is no undo history.

@johnmorrisdotca/kazu/ripple/play

mountRipplefunction

Mount the native Ripple player in a host element and return its cleanup and control handle.

RIPPLE_STRINGSconstant

Native English and Japanese labels and announcements for Ripple.

RippleDrawOptionstype

Current Ripple marks or entries, selection, errors and native SVG appearance choices.

RippleMounttype

The mounted Ripple game and progress, native controls and cleanup handle.

RippleMountOptionstype

The initial Ripple board, native progress, appearance and host event callbacks.

@johnmorrisdotca/kazu/ripple/draw

drawRipplefunction

Render the Ripple board and supplied current state as native SVG text.

RippleDrawOptionstype

Current Ripple marks or entries, selection, errors and native SVG appearance choices.

@johnmorrisdotca/kazu/cross-sums

canReachfunction

Whether the remaining distinct digits can reach the target sum in the given slots.

checkCrossSumsfunction

Checks exact run sums and distinct digits independently of a stored answer.

CROSS_SUMS_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateCrossSums.

CROSS_SUMS_SIZESconstant

The sides on offer, counting the row and column of totals; any side from 5 to CROSS_SUMS_MAX_SIDE can be made.

CROSS_SUMS_STRINGSconstant

Native English and Japanese labels and announcements for CrossSums.

CrossSumsBoardtype

CrossSums dimensions and printed clues in their native row-major representation.

CrossSumsCelltype

A white digit cell or a black clue cell with optional across/down totals.

CrossSumsChecktype

The CrossSums completion result and cells that violate its native rules.

CrossSumsDrawOptionstype

Current CrossSums marks or entries, selection, errors and native SVG appearance choices.

CrossSumsGametype

The immutable CrossSums board, current entries or marks, undo history and assistance state.

CrossSumsLeveltype

A native difficulty tier for generated CrossSums puzzles.

CrossSumsMounttype

The mounted CrossSums game and progress, native controls and cleanup handle.

CrossSumsMountOptionstype

The initial CrossSums board, native progress, appearance and host event callbacks.

CrossSumsPuzzletype

A seeded CrossSums board with its verified solution and native difficulty tier.

CrossSumsRuntype

One across or down digit run, its clue cell, constituent cells and target sum.

crossSumsRunsfunction

Read across and down digit runs with their clue cells and totals.

CrossSumsSolvetype

A bounded CrossSums solve result: answer count, first solution, node work and whether the search completed.

decodeCrossSumsfunction

Read a native saved CrossSums game, or null for invalid board data or progress.

drawCrossSumsfunction

Render the CrossSums board and supplied current state as native SVG text.

encodeCrossSumsfunction

Encode the CrossSums board and current game as native resumable text.

enterCrossSumsfunction

Apply the requested native CrossSums entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

finishedCrossSumsfunction

Whether this CrossSums game satisfies its complete native rules.

generateCrossSumsfunction

Makes a seeded board of size squares a side (counting the row and column of totals) and proves it has one answer.

hintCrossSumsfunction

Find a native CrossSums hint, or null when no actionable hint is available.

isCrossSumsBoardfunction

Whether the value has valid native CrossSums dimensions, clues and data.

mountCrossSumsfunction

Mount the native CrossSums player in a host element and return its cleanup and control handle.

newCrossSumsfunction

Create the initial immutable CrossSums game from a valid board.

progressCrossSumsfunction

Allows unfinished runs while flagging duplicate digits and impossible remaining totals.

rateCrossSumsfunction

Rates a board with one answer by solving it: with the single-run rules, with the digit-that-must-appear rule, then by supposing.

restartCrossSumsfunction

Return the CrossSums game reset to its initial entries or marks.

solveCrossSumsfunction

Bounded exact counter over across and down runs; an interrupted search never proves uniqueness.

undoCrossSumsfunction

Return the CrossSums game with its previous marks or entries restored, or unchanged when there is no undo history.

@johnmorrisdotca/kazu/cross-sums/play

CROSS_SUMS_STRINGSconstant

Native English and Japanese labels and announcements for CrossSums.

CrossSumsMounttype

The mounted CrossSums game and progress, native controls and cleanup handle.

CrossSumsMountOptionstype

The initial CrossSums board, native progress, appearance and host event callbacks.

mountCrossSumsfunction

Mount the native CrossSums player in a host element and return its cleanup and control handle.

@johnmorrisdotca/kazu/cross-sums/draw

CrossSumsDrawOptionstype

Current CrossSums marks or entries, selection, errors and native SVG appearance choices.

drawCrossSumsfunction

Render the CrossSums board and supplied current state as native SVG text.

@johnmorrisdotca/kazu/regions

checkRegionsfunction

Checks region connectivity and area without consulting a generated answer.

decodeRegionsGamefunction

Read a native saved Regions game, or null for invalid board data or progress.

drawRegionsfunction

Render the Regions board and supplied current state as native SVG text.

encodeRegionsGamefunction

Encode the Regions board and current game as native resumable text.

entryRegionsfunction

Group connected cells carrying the same entry into candidate regions.

generateRegionsfunction

Makes a seeded puzzle and proves its answer is the only one.

hintRegionsfunction

Find a native Regions hint, or null when no actionable hint is available.

isRegionsBoardfunction

Whether the value has valid native Regions dimensions, clues and data.

newRegionsfunction

Create the initial immutable Regions game from a valid board.

rateRegionsfunction

Rates a board with one answer by solving it as a person would: with the rules, then by supposing one number at a time.

REGIONS_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateRegions.

REGIONS_SIZESconstant

The sides on offer for a square board; any side from 4 to REGIONS_MOST_SIDE can be made.

RegionsBoardtype

Regions dimensions and printed clues in their native row-major representation.

RegionsChecktype

The Regions completion result and cells that violate its native rules.

RegionsDrawOptionstype

Current Regions marks or entries, selection, errors and native SVG appearance choices.

regionsFinishedfunction

Whether this Regions game satisfies its complete native rules.

RegionsGametype

The immutable Regions board, current entries or marks, undo history and assistance state.

RegionsLeveltype

A native difficulty tier for generated Regions puzzles.

RegionsPuzzletype

A seeded Regions board with its verified solution and native difficulty tier.

RegionsSolvetype

A bounded Regions solve result: answer count, first solution, node work and whether the search completed.

restartRegionsfunction

Return the Regions game reset to its initial entries or marks.

setRegionsCellfunction

Apply the requested native Regions entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

undoRegionsfunction

Return the Regions game with its previous marks or entries restored, or unchanged when there is no undo history.

@johnmorrisdotca/kazu/regions/play

mountRegionsfunction

Mount the native Regions player in a host element and return its cleanup and control handle.

REGIONS_STRINGSconstant

Native English and Japanese labels and announcements for Regions.

RegionsDrawOptionstype

Current Regions marks or entries, selection, errors and native SVG appearance choices.

RegionsLanguagetype

The native English or Japanese display language for Regions.

RegionsMounttype

The mounted Regions game and progress, native controls and cleanup handle.

RegionsMountOptionstype

The initial Regions board, native progress, appearance and host event callbacks.

RegionsPiecestype

A supported native Regions mark or piece appearance.

@johnmorrisdotca/kazu/regions/draw

drawRegionsfunction

Render the Regions board and supplied current state as native SVG text.

RegionsDrawOptionstype

Current Regions marks or entries, selection, errors and native SVG appearance choices.

@johnmorrisdotca/kazu/heyawake

checkHeyawakefunction

Validate a Heyawake answer against the printed clues and complete native rules.

checkRoomSpansfunction

Add unshaded straight-line room-span violations to the supplied error set.

decodeHeyawakefunction

Read a native saved Heyawake game, or null for invalid board data or progress.

drawHeyawakefunction

Render the Heyawake board and supplied current state as native SVG text.

encodeHeyawakefunction

Encode the Heyawake board and current game as native resumable text.

generateHeyawakefunction

Generate a seeded Heyawake puzzle with a verified unique answer; unsupported inputs or exhausted attempts throw.

HeyawakeBoardtype

Heyawake dimensions and printed clues in their native row-major representation.

heyawakeCellsfunction

Read room cells, or null for a room outside this board.

HeyawakeChecktype

The Heyawake completion result and cells that violate its native rules.

HeyawakeDrawOptionstype

Current Heyawake marks or entries, selection, errors and native SVG appearance choices.

heyawakeFinishedfunction

Whether this Heyawake game satisfies its complete native rules.

HeyawakeGametype

The immutable Heyawake board, current entries or marks, undo history and assistance state.

HeyawakeLeveltype

A native difficulty tier for generated Heyawake puzzles.

HeyawakeMounttype

The mounted Heyawake game and progress, native controls and cleanup handle.

HeyawakeMountOptionstype

The initial Heyawake board, native progress, appearance and host event callbacks.

HeyawakePuzzletype

A seeded Heyawake board with its verified solution and native difficulty tier.

HeyawakeRoomtype

A rectangular room and its optional required black-cell count.

HeyawakeSolvetype

A bounded Heyawake solve result: answer count, first solution, node work and whether the search completed.

heyawakeWordsfunction

Read the native English or Japanese Heyawake labels.

hintHeyawakefunction

Find a native Heyawake hint, or null when no actionable hint is available.

isHeyawakeBoardfunction

Whether the value has valid native Heyawake dimensions, clues and data.

mountHeyawakefunction

Mount the native Heyawake player in a host element and return its cleanup and control handle.

newHeyawakefunction

Create the initial immutable Heyawake game from a valid board.

restartHeyawakefunction

Return the Heyawake game reset to its initial entries or marks.

roomForCellfunction

Read the containing room index for each Heyawake cell.

setHeyawakeCellfunction

Apply the requested native Heyawake entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

solveHeyawakefunction

Search for Heyawake answers up to the solution and node limits; completion distinguishes a proved result from exhausted work.

undoHeyawakefunction

Return the Heyawake game with its previous marks or entries restored, or unchanged when there is no undo history.

@johnmorrisdotca/kazu/heyawake/play

HeyawakeMounttype

The mounted Heyawake game and progress, native controls and cleanup handle.

HeyawakeMountOptionstype

The initial Heyawake board, native progress, appearance and host event callbacks.

mountHeyawakefunction

Mount the native Heyawake player in a host element and return its cleanup and control handle.

@johnmorrisdotca/kazu/heyawake/draw

drawHeyawakefunction

Render the Heyawake board and supplied current state as native SVG text.

HeyawakeDrawOptionstype

Current Heyawake marks or entries, selection, errors and native SVG appearance choices.

@johnmorrisdotca/kazu

AKARI_DENSER_CROWDSconstant

When a level finds no board in AKARI_MOST_ATTEMPTS plain attempts (a large board of an easy level, mostly: one attempt in a hundred succeeds on a 14×14), the generator tries again with more black squares, each of these multiples of the usual share in turn, AKARI_DENSER_ATTEMPTS attempts at each.

AKARI_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateAkari.

AKARI_SIZESconstant

The sides the demo and the site offer for a square board; any side from 2 to AKARI_MOST_SIDE can be made.

AKARI_STRINGSconstant

Native English and Japanese labels and announcements for Akari.

AkariChecktype

The Akari completion result and cells that violate its native rules.

AkariDrawOptionstype

Current Akari marks or entries, selection, errors and native SVG appearance choices.

akariFinishedfunction

A game is finished only when its bulbs satisfy every rule and light every white square.

AkariGametype

The immutable Akari board, current entries or marks, undo history and assistance state.

AkariLanguagetype

The native English or Japanese display language for Akari.

AkariLeveltype

A native difficulty tier for generated Akari puzzles.

AkariMaterialtype

A supported material of the native Akari board.

AkariMounttype

The mounted Akari game and progress, native controls and cleanup handle.

AkariMountOptionstype

The initial Akari board, native progress, appearance and host event callbacks.

akariNeighboursfunction

Returns the orthogonally adjacent cells to a board position.

AkariPiecestype

A supported native Akari mark or piece appearance.

AkariProgresstype

The Akari constraint status of a partial board.

AkariPuzzletype

A seeded Akari board with its verified solution and native difficulty tier.

AkariRatingtype

How hard a board is, measured by solving it.

AkariSolvetype

A bounded Akari solve result: answer count, first solution, node work and whether the search completed.

akariVisiblefunction

White squares visible from a cell, including itself, stopping at black squares and edges.

answerOffunction

The whole grid as a cells code: what checkKazu takes as an answer.

boxedLayoutfunction

Rows, columns and boxes; with diagonal, the two long diagonals as well.

Boxestype

Where the boxes are on a Sudoku grid: how many rows and columns of cells each box holds.

boxOffunction

The box a cell is in, numbered row-major from 0.

Cagetype

A cage: the cells in it and the sum of the numbers inside.

CAGE_LETTERSconstant

The letters that name a cage in a code: up to sixty-two cages.

cageOutlinefunction

THE DASHED OUTLINE OF EVERY CAGE, as line segments in cell units: each cage drawn a little inside its own edge, the way a printed Killer Sudoku draws it, so a cage reads as a shape within the box rules rather than as one of them.

canReachfunction

Whether the remaining distinct digits can reach the target sum in the given slots.

checkAkarifunction

Checks a complete placement from the public rules, without consulting a stored answer.

checkCrossSumsfunction

Checks exact run sums and distinct digits independently of a stored answer.

checkHeyawakefunction

Validate a Heyawake answer against the printed clues and complete native rules.

checkHitorifunction

Checks unshaded row and column duplicates, adjacent shades, and white connectivity.

checkJuosanfunction

Checks public rules directly, independently of the solver and stored answer.

checkKazufunction

Whether an answer solves a puzzle: O(cells), no search, nothing remembered between calls.

checkLoopfunction

Checks all numbered cells, degree-two vertices, and one connected closed loop.

checkMasyufunction

Validate a Masyu answer against the printed clues and complete native rules.

checkNurikabefunction

Checks island areas and separation, the connected sea, and the ban on 2×2 sea blocks.

checkRegionsfunction

Checks region connectivity and area without consulting a generated answer.

checkRipplefunction

Checks room permutations and the at-least-N-cell gap between equal N clues in a line.

checkRoomSpansfunction

Add unshaded straight-line room-span violations to the supplied error set.

checkShikakufunction

A finished partition is checked against the rules, never against a stored answer.

checkYajilinfunction

Validate a Yajilin answer against the printed clues and complete native rules.

clearCellfunction

Empty a cell of its number and its pencil marks.

cluesOffunction

Every clue a finished square makes true: what each side of it sees.

conflictsOffunction

THE CELLS THAT BREAK A RULE RIGHT NOW, read from the rules alone: no answer is needed, so it works on any puzzle, and it names a mistake the moment it is made rather than when it is checked.

countKazuSolutionsfunction

How many answers a puzzle has, up to limit (two by default, so "many" costs no more than "two"): 1 is a puzzle, 0 is a grid that cannot be finished, 2 is a guessing game.

CROSS_SUMS_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateCrossSums.

CROSS_SUMS_SIZESconstant

The sides on offer, counting the row and column of totals; any side from 5 to CROSS_SUMS_MAX_SIDE can be made.

CROSS_SUMS_STRINGSconstant

Native English and Japanese labels and announcements for CrossSums.

CrossSumsBoardtype

CrossSums dimensions and printed clues in their native row-major representation.

CrossSumsCelltype

A white digit cell or a black clue cell with optional across/down totals.

CrossSumsChecktype

The CrossSums completion result and cells that violate its native rules.

CrossSumsDrawOptionstype

Current CrossSums marks or entries, selection, errors and native SVG appearance choices.

CrossSumsGametype

The immutable CrossSums board, current entries or marks, undo history and assistance state.

CrossSumsLeveltype

A native difficulty tier for generated CrossSums puzzles.

CrossSumsMounttype

The mounted CrossSums game and progress, native controls and cleanup handle.

CrossSumsMountOptionstype

The initial CrossSums board, native progress, appearance and host event callbacks.

CrossSumsPuzzletype

A seeded CrossSums board with its verified solution and native difficulty tier.

CrossSumsRuntype

One across or down digit run, its clue cell, constituent cells and target sum.

crossSumsRunsfunction

Read across and down digit runs with their clue cells and totals.

CrossSumsSolvetype

A bounded CrossSums solve result: answer count, first solution, node work and whether the search completed.

decodeAkarifunction

Decodes a bounded save after validating the board and each placement.

decodeCellsfunction

".3.1" at a side of 2 → [0, 3, 0, 1], or null for a string that is not a grid of that size: the wrong length, a value past the side, a stray character.

decodeCrossSumsfunction

Read a native saved CrossSums game, or null for invalid board data or progress.

decodeHeyawakefunction

Read a native saved Heyawake game, or null for invalid board data or progress.

decodeHitorifunction

Read a native saved Hitori game, or null for invalid board data or progress.

decodeJigsawfunction

The cells and regions a Jigsaw's givens say, or null for a string that is not a Jigsaw of this side.

decodeJuosanfunction

Reads a bounded public save; malformed or incompatible data returns null.

decodeKillerfunction

The cells and cages a code says, or null for one that is not a whole, well-formed puzzle: every cell named to a cage, every cage used, and a sum for each.

decodeLoopfunction

Read a native saved Loop game, or null for invalid board data or progress.

decodeMasyufunction

Read a native saved Masyu game, or null for invalid board data or progress.

decodeMoreOrLessfunction

Decode native Futoshiki numbers and less-than relations, or null for an invalid code.

decodeNotesfunction

The pencil marks a code says (each cell a bit mask, bit v for the number v), or null for a code that is not one for a grid of this side.

decodeNurikabefunction

Read a native saved Nurikabe game, or null for invalid board data or progress.

decodeRegionsfunction

Regions row-major, one letter each, or null for a string that is not that.

decodeRegionsGamefunction

Read a native saved Regions game, or null for invalid board data or progress.

decodeRipplefunction

Read a native saved Ripple game, or null for invalid board data or progress.

decodeRunfunction

The entries a run's code says, or null for a code that is not a run of this side.

decodeShikakufunction

Read a native saved Shikaku game, or null for invalid board data or progress.

decodeStepsfunction

The grids a step log holds, each cells characters long, or null for a log that does not read as one.

decodeTowersfunction

The cells and clues a code says, or null for a string that is not a Towers puzzle of this size.

decodeYajilinfunction

Read a native saved Yajilin game, or null for invalid board data or progress.

drawAkarifunction

Draws the public clues and current bulbs as SVG.

drawCrossSumsfunction

Render the CrossSums board and supplied current state as native SVG text.

drawHeyawakefunction

Render the Heyawake board and supplied current state as native SVG text.

drawJuosanfunction

Draws a public Juosan board as an SVG string.

drawLoopfunction

Draws public clues and selected loop edges as an SVG board.

drawRegionsfunction

Render the Regions board and supplied current state as native SVG text.

drawRipplefunction

Render the Ripple board and supplied current state as native SVG text.

edgeVerticesfunction

Read the two vertex indices at the ends of a native Loop edge.

EMPTY_CELLconstant

A GRID OF NUMBERS AS A STRING: for an address, a POST body, and a kept run.

encodeAkarifunction

Encodes only public clues and player placements.

encodeCrossSumsfunction

Encode the CrossSums board and current game as native resumable text.

encodeHeyawakefunction

Encode the Heyawake board and current game as native resumable text.

encodeHitorifunction

Versioned public clue and mark data; the generated answer is not saved.

encodeJigsawfunction

A Jigsaw's givens: the cells, then the regions, one letter a cell.

encodeJuosanfunction

Serializes public clues, placements, and assisted status.

encodeKillerfunction

A Sum Cages puzzle's givens: the cells, then which cage each cell is in, then each cage's sum.

encodeLoopfunction

Encode the Loop board and current game as native resumable text.

encodeMasyufunction

Encode the Masyu board and current game as native resumable text.

encodeMoreOrLessfunction

Encode grid numbers and less-than relations as the native Futoshiki givens code.

encodeNotesfunction

Pencil marks as a code: for each cell that has any, its index in base 36 (two characters) and its marks as one number in base 36 (four characters); nothing at all for a grid with none.

encodeNurikabefunction

Encode the Nurikabe board and current game as native resumable text.

encodeRegionsfunction

The region of every cell as a letter, a for the first region and so on: one character a cell.

encodeRegionsGamefunction

Encode the Regions board and current game as native resumable text.

encodeRipplefunction

Encode the Ripple board and current game as native resumable text.

encodeRunfunction

The entries of a run as its code.

encodeShikakufunction

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

encodeStepsfunction

THE STEPS OF A PUZZLE, written down so a scrubber has them when the puzzle is picked up again.

encodeTowersfunction

Encode grid numbers and four sides of visibility clues as native Skyscrapers givens.

encodeYajilinfunction

Encode the Yajilin board and current game as native resumable text.

enterCrossSumsfunction

Apply the requested native CrossSums entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

enterNumberfunction

Write a number into a cell (0 empties it).

entryRegionsfunction

Group connected cells carrying the same entry into candidate regions.

finishedCrossSumsfunction

Whether this CrossSums game satisfies its complete native rules.

freshKazuSeedfunction

A new seed, from Math.random or the stream given: anywhere in the range.

gameConflictsfunction

The cells that break a rule now (conflictsOf).

generateAkarifunction

Makes a seeded board and proves it has one answer.

generateCrossSumsfunction

Makes a seeded board of size squares a side (counting the row and column of totals) and proves it has one answer.

generateDiagonalfunction

A Diagonal Sudoku (Sudoku X): Sudoku with the two long diagonals as groups too.

generateHeyawakefunction

Generate a seeded Heyawake puzzle with a verified unique answer; unsupported inputs or exhausted attempts throw.

generateHitorifunction

Makes a seeded puzzle and proves its answer is the only one.

generateJigsawfunction

A Jigsaw Sudoku of this side, level and seed: 5, 6, 7 or 9.

generateJuosanfunction

Makes an original small training puzzle and returns it only after uniqueness is proved.

generateKazufunction

A puzzle of any of the six, from a seed: the one door.

generateLoopfunction

Makes a seeded puzzle and proves it has one answer.

generateMasyufunction

Seeded original loop layouts; every output is accepted only after a completed uniqueness proof.

generateMoreOrLessfunction

A Futoshiki (More or Less) of this side, level and seed: 4, 5, 6 or 7.

generateNumberPlacefunction

A Sudoku (Number Place) of this side, level and seed: 4, 6, 9, 16 or 25.

generateNurikabefunction

Seeded symmetries of original 5×5 layouts are returned only after the solver proves uniqueness.

generateRegionsfunction

Makes a seeded puzzle and proves its answer is the only one.

generateRipplefunction

Builds a seeded block-room family and accepts it only after a bounded uniqueness proof.

generateShikakufunction

Seeded rectangles packed into the board, one number each, with an independently counted, unique answer.

generateShikakuChallengefunction

Generate a seeded Shikaku puzzle with a verified unique answer; unsupported inputs or exhausted attempts throw.

generateSumCagesfunction

A Killer Sudoku (Sum Cages) of this side, level and seed: 6 or 9.

generateTowersfunction

A Skyscrapers (Towers) puzzle of this side, level and seed: 4, 5, 6 or 7.

generateYajilinfunction

Seeded original 5×5 families, accepted only after a completed uniqueness proof.

HeyawakeBoardtype

Heyawake dimensions and printed clues in their native row-major representation.

heyawakeCellsfunction

Read room cells, or null for a room outside this board.

HeyawakeChecktype

The Heyawake completion result and cells that violate its native rules.

HeyawakeDrawOptionstype

Current Heyawake marks or entries, selection, errors and native SVG appearance choices.

heyawakeFinishedfunction

Whether this Heyawake game satisfies its complete native rules.

HeyawakeGametype

The immutable Heyawake board, current entries or marks, undo history and assistance state.

HeyawakeLeveltype

A native difficulty tier for generated Heyawake puzzles.

HeyawakeMounttype

The mounted Heyawake game and progress, native controls and cleanup handle.

HeyawakeMountOptionstype

The initial Heyawake board, native progress, appearance and host event callbacks.

HeyawakePuzzletype

A seeded Heyawake board with its verified solution and native difficulty tier.

HeyawakeRoomtype

A rectangular room and its optional required black-cell count.

HeyawakeSolvetype

A bounded Heyawake solve result: answer count, first solution, node work and whether the search completed.

heyawakeWordsfunction

Read the native English or Japanese Heyawake labels.

hintAkarifunction

Returns a missing bulb, or an extra bulb to remove, only after uniqueness is proved.

hintCrossSumsfunction

Find a native CrossSums hint, or null when no actionable hint is available.

hintHeyawakefunction

Find a native Heyawake hint, or null when no actionable hint is available.

hintHitorifunction

Gives one next shade in the unique minimal solution, if uniqueness was proved.

hintJuosanfunction

Returns one next mark only when the public clues prove a unique answer.

hintKazufunction

The next cell a person could fill in, and why (see KazuHint).

hintLoopfunction

Find a native Loop hint, or null when no actionable hint is available.

hintMasyufunction

Find a native Masyu hint, or null when no actionable hint is available.

hintNurikabefunction

Find a native Nurikabe hint, or null when no actionable hint is available.

hintRegionsfunction

Find a native Regions hint, or null when no actionable hint is available.

hintRipplefunction

Offers a cell only when the current public entries leave one proved completion.

hintShikakufunction

A rectangle is offered only when the remaining partition has one proved answer.

hintYajilinfunction

Find a native Yajilin hint, or null when no actionable hint is available.

HITORI_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateHitori.

HITORI_SIZESconstant

The sides on offer; any side from 4 to HITORI_MOST_SIDE is a board isHitoriBoard takes.

HitoriBoardtype

Hitori dimensions and printed clues in their native row-major representation.

HitoriGametype

The immutable Hitori board, current entries or marks, undo history and assistance state.

HitoriLeveltype

A native difficulty tier for generated Hitori puzzles.

hitoriNeighborsfunction

Read orthogonally adjacent cells on a square Hitori board.

HitoriPuzzletype

A seeded Hitori board with its verified solution and native difficulty tier.

HitoriRatingtype

How hard a board is, measured by solving it.

HitoriSolvetype

A bounded Hitori solve result: answer count, first solution, node work and whether the search completed.

isAkariBoardfunction

Validates dimensions and the three public square kinds.

isCrossSumsBoardfunction

Whether the value has valid native CrossSums dimensions, clues and data.

isHeyawakeBoardfunction

Whether the value has valid native Heyawake dimensions, clues and data.

isHitoriBoardfunction

Whether the value has valid native Hitori dimensions, clues and data.

isJuosanBoardfunction

Whether territories partition a bounded board and each territory is connected.

isKazuGivensfunction

Whether a puzzle's givens are a well-formed puzzle of that kind and side at all (a Jigsaw's regions sound, every code readable).

isKazuKindfunction

Whether a value is one of the six keys.

isKazuLevelfunction

Whether a value is one of the three levels.

isKazuSeedfunction

Whether a value is a seed this package takes: a whole number from 1 to KAZU_SEED_MOST.

isKazuSizefunction

Whether this puzzle can be made at this side.

isLoopBoardfunction

Whether the value has valid native Loop dimensions, clues and data.

isMasyuBoardfunction

Whether the value has valid native Masyu dimensions, clues and data.

isNurikabeBoardfunction

Whether the value has valid native Nurikabe dimensions, clues and data.

isPrintedfunction

Whether a cell was printed with its number: it never changes.

isRegionsBoardfunction

Whether the value has valid native Regions dimensions, clues and data.

isRippleBoardfunction

Whether the value has valid native Ripple dimensions, clues and data.

isShikakuBoardfunction

Whether dimensions and area clues describe a possible partition.

isSolvedfunction

Whether the grid is full and right, by the rules alone (checkKazu): every puzzle has exactly one answer, so a grid that keeps every rule IS that answer.

isYajilinBoardfunction

Whether the value has valid native Yajilin dimensions, clues and data.

JUOSAN_LEVELSconstant

The native Juosan generation difficulty tiers.

JUOSAN_STRINGSconstant

Native English and Japanese labels and announcements for Juosan.

JuosanBoardtype

Juosan dimensions and printed clues in their native row-major representation.

JuosanChecktype

The Juosan completion result and cells that violate its native rules.

JuosanDrawOptionstype

Current Juosan marks or entries, selection, errors and native SVG appearance choices.

juosanFinishedfunction

Whether every cell is filled and the independent checker accepts the board.

JuosanGametype

The immutable Juosan board, current entries or marks, undo history and assistance state.

JuosanLanguagetype

The native English or Japanese display language for Juosan.

JuosanLeveltype

A native difficulty tier for generated Juosan puzzles.

JuosanMarktype

A blank, horizontal or vertical mark in a Juosan cell.

JuosanMounttype

The mounted Juosan game and progress, native controls and cleanup handle.

JuosanMountOptionstype

The initial Juosan board, native progress, appearance and host event callbacks.

JuosanPiecestype

A supported native Juosan mark or piece appearance.

JuosanPuzzletype

A seeded Juosan board with its verified solution and native difficulty tier.

JuosanSolvetype

A bounded Juosan solve result: answer count, first solution, node work and whether the search completed.

JuosanTerritorytype

A territory is a list of zero-based cell indexes and an absolute orientation difference.

juosanTerritoryAtfunction

Returns the index of the territory containing a cell, or -1 when absent.

KAZU_BOXESconstant

A 9×9 has 3×3 boxes and a 4×4 has 2×2; a 6×6 has boxes two rows tall and three columns wide, which is the one people get wrong and the reason this is a table rather than a square root.

KAZU_CHECK_REASONSconstant

Why checkKazu will not take an answer, as a stable code and the English clause it says: {name} is a gap the check's values fill.

KAZU_KIND_OF_SITE_KINDconstant

The names itsutsu.com gave the six in its code, to the keys here: what a site's stored kind becomes.

KAZU_KINDSconstant

THE SIX PUZZLES, and what each offers: the keys, the sizes and the levels.

KAZU_LEVELSconstant

How hard a puzzle is made: what the solver needed.

KAZU_SEED_MOSTconstant

The most a seed can be: a whole number from 1 to 2³¹ − 1, so it travels in an address as a plain integer.

KAZU_SPECSconstant

Supported sizes, native default size and givens-code limits for each number-grid kind.

KAZU_STEPS_KEPTconstant

How many grids a step log keeps: the newest, so a long puzzle's log has a ceiling.

KazuChecktype

The verdict on a submitted answer: { ok: true }, or { ok: false, reason, code, values }: reason is in the words the site has always used, and code and values say the same in a form a site can put in its own language (KAZU_CHECK_REASONS).

KazuCheckCodetype

A reason checkKazu can give, by its stable code.

KazuCheckValuestype

The numbers and names that fill a reason's gaps, by the gap's name (see KAZU_CHECK_REASONS for each code's).

kazuClockTextfunction

A time taken, as a clock shows it: m:ss, and h:mm:ss past an hour.

KazuGametype

A PUZZLE IN PLAY, as pure functions: what has been written, the pencil marks, and how to take a step back.

KazuGameOptionstype

Optional entries and pencil-note masks to restore when creating a native number-grid game.

KazuGivenstype

WHAT A PUZZLE WAS PRINTED WITH, read from its givens code: the printed cells, and for a Jigsaw its regions, for Sum Cages its cages, for More or Less its marks, for Towers its clues.

kazuGuessDepthfunction

How many guesses, each followed by everything reasoning then finds, a person needs to finish the puzzle: 0 when reasoning alone finishes it (easy), 1 when one guess does (medium), more when more (hard); Infinity when there is no answer.

kazuHashfunction

A short fingerprint of a puzzle's givens (FNV-1a, eight hex characters): the same puzzle, however it was kept, has the same one.

KazuHinttype

A HINT: the next cell a person could fill in by looking, and why.

KazuKindtype

One of the six native number-grid puzzle kinds.

KazuLeveltype

One of the native easy, medium or hard generation tiers.

kazuProgressfunction

How far along it is: cells with a number (printed or written) out of all of them.

KazuPuzzletype

One puzzle, made from a seed or read back from its codes.

kazuRefusalfunction

A refusal: { ok: false }, the English reason (the clause of the code with the values in its gaps), the code and the values.

layoutOfGivensfunction

The groups that must each hold every number once, for the four kinds made of groups; null for More or Less and Towers, which only have rows and columns.

lineFromfunction

The cells a clue looks along, nearest first: the clue at at on the top looks down column at, on the bottom up it, on the left along row at to the right, on the right along it to the left.

LOOP_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateLoop.

LOOP_SIZESconstant

The sides on offer for a square board; any side from 2 to LOOP_MOST_SIDE can be made.

LoopBoardtype

Loop dimensions and printed clues in their native row-major representation.

loopCellEdgesfunction

Read the four edges around a cell, or null for a cell outside the board.

LoopChecktype

The Loop completion result and cells that violate its native rules.

LoopDrawOptionstype

Current Loop marks or entries, selection, errors and native SVG appearance choices.

loopEdgeCountfunction

An edge index is horizontal row-major first, then vertical row-major.

loopFinishedfunction

Whether this Loop game satisfies its complete native rules.

LoopGametype

The immutable Loop board, current entries or marks, undo history and assistance state.

loopHorizontalCountfunction

Count horizontal edges in the Loop board’s native edge numbering.

LoopLanguagetype

The native English or Japanese display language for Loop.

LoopLeveltype

A native difficulty tier for generated Loop puzzles.

LoopMaterialtype

A supported material of the native Loop board.

LoopMounttype

The mounted Loop game and progress, native controls and cleanup handle.

LoopMountOptionstype

The initial Loop board, native progress, appearance and host event callbacks.

LoopProgresstype

The Loop constraint status of a partial board.

LoopPuzzletype

A seeded Loop board with its verified solution and native difficulty tier.

LoopRatingtype

How hard a board is, measured by solving it.

LoopSolvetype

A bounded Loop solve result: answer count, first solution, node work and whether the search completed.

Marktype

A mark: the cell at less holds a smaller number than the cell at more.

markNurikabeSeafunction

Apply the requested native Nurikabe entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

MasyuBoardtype

Masyu dimensions and printed clues in their native row-major representation.

MasyuChecktype

The Masyu completion result and cells that violate its native rules.

MasyuDrawOptionstype

Current Masyu marks or entries, selection, errors and native SVG appearance choices.

masyuFinishedfunction

Whether this Masyu game satisfies its complete native rules.

MasyuGametype

The immutable Masyu board, current entries or marks, undo history and assistance state.

MasyuMounttype

The mounted Masyu game and progress, native controls and cleanup handle.

MasyuMountOptionstype

The initial Masyu board, native progress, appearance and host event callbacks.

masyuNeighborsfunction

Read adjacent Masyu cells with the joining edge and direction.

MasyuPuzzletype

A seeded Masyu board with its verified solution.

MasyuSolvetype

A bounded Masyu solve result: answer count, first solution, node work and whether the search completed.

mountAkarifunction

Mounts the player in a host element; call destroy when the host is removed.

mountCrossSumsfunction

Mount the native CrossSums player in a host element and return its cleanup and control handle.

mountHeyawakefunction

Mount the native Heyawake player in a host element and return its cleanup and control handle.

mountJuosanfunction

Mounts a touch, mouse, and keyboard player into an existing page element.

mountLoopfunction

Mounts an accessible dot-and-edge loop player in the given host element.

mountRipplefunction

Mount the native Ripple player in a host element and return its cleanup and control handle.

neighboursfunction

The cells sharing an edge with index.

newAkarifunction

Starts a game with only its public board data.

newCrossSumsfunction

Create the initial immutable CrossSums game from a valid board.

newHeyawakefunction

Create the initial immutable Heyawake game from a valid board.

newHitorifunction

Create the initial immutable Hitori game from a valid board.

newJuosanfunction

Starts a game with a copy of its public board and no generated answer.

newKazuGamefunction

A game of a puzzle, or null for givens that are not a puzzle of that kind and side.

newLoopfunction

Create the initial immutable Loop game from a valid board.

newMasyufunction

Create the initial immutable Masyu game from a valid board.

newNurikabefunction

Create the initial immutable Nurikabe game from a valid board.

newRegionsfunction

Create the initial immutable Regions game from a valid board.

newRipplefunction

Create the initial immutable Ripple game from a valid board.

newShikakufunction

Begin with a copy of just the public clues; a generated answer is never kept in play.

newYajilinfunction

Create the initial immutable Yajilin game from a valid board.

NO_MARKconstant

The native code character for an absent Futoshiki relation.

noCluesfunction

Create empty visibility clues on all four sides of a square grid.

notesOffunction

Every value of a pencil-mark mask, smallest first.

numberCountsfunction

The numbers 1 up to the side, each with how many of it are on the grid: a pad greys a number that is all placed.

NurikabeBoardtype

Nurikabe dimensions and printed clues in their native row-major representation.

NurikabeGametype

The immutable Nurikabe board, current entries or marks, undo history and assistance state.

nurikabeNeighborsfunction

Read orthogonally adjacent cells on a square Nurikabe board.

NurikabePuzzletype

A seeded Nurikabe board with its verified solution.

NurikabeSolvetype

A bounded Nurikabe solve result: answer count, first solution, node work and whether the search completed.

placeShikakufunction

Place a rectangle, replacing any it touches.

progressAkarifunction

Reports immediate contradictions while allowing required clues to remain unsatisfied during play.

progressCrossSumsfunction

Allows unfinished runs while flagging duplicate digits and impossible remaining totals.

progressLoopfunction

Reports overfilled clues and branched vertices during play without requiring a finished loop.

progressRipplefunction

Partial progress check; missing entries are allowed, but impossible room/ripple pairs are flagged.

Randomtype

A number in [0, 1), like Math.random, from a stream a seed fixes.

rateAkarifunction

Rates a board by solving it as a person would: with the rules alone (depth 0), then with one supposition at a time (depth 1), and anything beyond that is depth 2.

rateCrossSumsfunction

Rates a board with one answer by solving it: with the single-run rules, with the digit-that-must-appear rule, then by supposing.

rateHitorifunction

Rates a board with one answer by solving it: with the plain rules, with the whites-stay-together rule, then by supposing.

rateLoopfunction

Rates a board with one answer by solving it as a person would: with the rules, then by supposing one edge at a time.

rateRegionsfunction

Rates a board with one answer by solving it as a person would: with the rules, then by supposing one number at a time.

rateShikakufunction

Rates a board with one answer by solving it with the first rule, with the first two, with all three, then by supposing.

readGivensfunction

The givens of a puzzle, or null for a code that is not one of that kind and side.

REGIONS_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateRegions.

REGIONS_SIZESconstant

The sides on offer for a square board; any side from 4 to REGIONS_MOST_SIDE can be made.

regionsAreSoundfunction

Whether region divides a size×size grid into size regions of size cells each, every one of them joined edge to edge.

RegionsBoardtype

Regions dimensions and printed clues in their native row-major representation.

RegionsChecktype

The Regions completion result and cells that violate its native rules.

RegionsDrawOptionstype

Current Regions marks or entries, selection, errors and native SVG appearance choices.

regionsFinishedfunction

Whether this Regions game satisfies its complete native rules.

RegionsGametype

The immutable Regions board, current entries or marks, undo history and assistance state.

RegionsLeveltype

A native difficulty tier for generated Regions puzzles.

RegionsPuzzletype

A seeded Regions board with its verified solution and native difficulty tier.

RegionsSolvetype

A bounded Regions solve result: answer count, first solution, node work and whether the search completed.

restartCrossSumsfunction

Return the CrossSums game reset to its initial entries or marks.

restartHeyawakefunction

Return the Heyawake game reset to its initial entries or marks.

restartHitorifunction

Return the Hitori game reset to its initial entries or marks.

restartJuosanfunction

Clears the board while retaining whether the player used a hint.

restartKazufunction

Start again: every entry and pencil mark gone, and nothing to undo.

restartMasyufunction

Return the Masyu game reset to its initial entries or marks.

restartNurikabefunction

Return the Nurikabe game reset to its initial entries or marks.

restartRegionsfunction

Return the Regions game reset to its initial entries or marks.

restartYajilinfunction

Return the Yajilin game reset to its initial entries or marks.

RIPPLE_STRINGSconstant

Native English and Japanese labels and announcements for Ripple.

RippleBoardtype

Ripple dimensions and printed clues in their native row-major representation.

RippleChecktype

The Ripple completion result and cells that violate its native rules.

RippleDrawOptionstype

Current Ripple marks or entries, selection, errors and native SVG appearance choices.

rippleFinishedfunction

Whether this Ripple game satisfies its complete native rules.

RippleGametype

The immutable Ripple board, current entries or marks, undo history and assistance state.

RippleLanguagetype

The native English or Japanese display language for Ripple.

RippleMounttype

The mounted Ripple game and progress, native controls and cleanup handle.

RippleMountOptionstype

The initial Ripple board, native progress, appearance and host event callbacks.

RipplePiecestype

A supported native Ripple mark or piece appearance.

RipplePuzzletype

A seeded Ripple board with its verified solution.

rippleRoomSizesfunction

Read the size of each room in a Ripple Effect board.

RippleSolvetype

A bounded Ripple solve result: answer count, first solution, node work and whether the search completed.

roomForCellfunction

Read the containing room index for each Heyawake cell.

seededRandomfunction

A stream of numbers in [0, 1) fixed by a seed.

Segmenttype

A line segment in cell units: where one part of a cage's dashed outline runs.

setHeyawakeCellfunction

Apply the requested native Heyawake entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

setJuosanMarkfunction

Writes a mark and records the previous state; invalid or unchanged moves are ignored.

setRegionsCellfunction

Apply the requested native Regions entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

setRippleValuefunction

Apply the requested native Ripple entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

shadeHitorifunction

Apply the requested native Hitori entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

SHIKAKU_CHALLENGE_PACKSconstant

Three short, named challenge routes using the regular seeded unique-puzzle generator.

SHIKAKU_LEVELSconstant

How hard a puzzle is made, by what a person must do to solve it; see rateShikaku.

SHIKAKU_SIZESconstant

The sides on offer for a square board; any side from 2 to SHIKAKU_MOST_SIDE can be made.

ShikakuBoardtype

One area clue per rectangle; zero is an unnumbered cell.

shikakuCandidatesfunction

All legal rectangles for a numbered cell, in a stable order.

shikakuCellsfunction

Cells of a bounded rectangle, or null for invalid coordinates.

ShikakuChallengetype

The named route, board shape, difficulty and seed of one Shikaku challenge.

ShikakuChecktype

The Shikaku completion result and cells that violate its native rules.

shikakuFinishedfunction

Whether this Shikaku game satisfies its complete native rules.

ShikakuGametype

The immutable Shikaku board, current entries or marks, undo history and assistance state.

ShikakuLeveltype

A native difficulty tier for generated Shikaku puzzles.

ShikakuPackKeytype

One of the square, wide or tall native Shikaku challenge routes.

ShikakuPuzzletype

A seeded Shikaku board with its verified solution and native difficulty tier.

ShikakuSolvetype

A bounded Shikaku solve result: answer count, first solution, node work and whether the search completed.

shuffledfunction

A copy of the list in a random order (Fisher–Yates, from the end); the list given is left alone.

solveAkarifunction

Bounded constraint search over the rules in akariLogic.ts; a stopped proof is always marked incomplete.

solveCrossSumsfunction

Bounded exact counter over across and down runs; an interrupted search never proves uniqueness.

solveHeyawakefunction

Search for Heyawake answers up to the solution and node limits; completion distinguishes a proved result from exhausted work.

solveHitorifunction

Counts distinct minimal shade patterns: an answer shades only squares that settle a duplicate, so extra shades are never a second answer.

solveJuosanfunction

Counts labeled solutions up to a limit; complete distinguishes exhaustion from cutoff.

solveKazufunction

The one answer a puzzle's givens allow, as a cells code, or null when they allow none, more than one, or the search ran past budget steps (Sudoku, Jigsaw, Diagonal and Sum Cages).

solveLoopfunction

Counts loop solutions with the pruning in loopLogic.ts under explicit work bounds.

solveMasyufunction

Counts distinct single loops with local pearl rules; budget stops never claim a proof.

solveNurikabefunction

Counts valid island placements and checks the remaining cells as the sea under a finite budget.

solveRipplefunction

Counts rule-valid fillings within an explicit node budget.

solveYajilinfunction

Counts public shade patterns whose remaining cells form the single required loop.

stepEntryfunction

The number a tap on the chosen cell puts in it: one more, and after the largest the cell empties, and then it starts again at 1.

symbolOffunction

How a value is written, in a code and on a cell: 1–9, then A–P.

toggleAkarifunction

Toggles a bulb on a white square and keeps one prior turn for undo.

toggleLoopfunction

Apply the requested native Loop entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

toggleMasyuEdgefunction

Apply the requested native Masyu entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

toggleNotefunction

Turn the pencil mark value on or off in a cell.

toggleRippleNotefunction

Apply the requested native Ripple entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

toggleYajilinEdgefunction

Apply the requested native Yajilin entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

toggleYajilinShadefunction

Apply the requested native Yajilin entry or mark to a new immutable game; invalid or fixed targets stay unchanged.

TOWER_SIDESconstant

Towers (Skyscrapers) as a string: the cells, then the clues around the edge.

TowerCluestype

Each side's clues, in reading order along it; 0 where there is none.

TowerSidetype

The top, bottom, left or right side of Skyscrapers visibility clues.

towersSeenfunction

How many towers show looking along heights from its first end: each one taller than every one before it.

undoAkarifunction

Restores the last bulb placement.

undoCrossSumsfunction

Return the CrossSums game with its previous marks or entries restored, or unchanged when there is no undo history.

undoHeyawakefunction

Return the Heyawake game with its previous marks or entries restored, or unchanged when there is no undo history.

undoHitorifunction

Return the Hitori game with its previous marks or entries restored, or unchanged when there is no undo history.

undoJuosanfunction

Restores the preceding mark state, if one exists.

undoKazufunction

Take back the last change.

undoLoopfunction

Return the Loop game with its previous marks or entries restored, or unchanged when there is no undo history.

undoMasyufunction

Return the Masyu game with its previous marks or entries restored, or unchanged when there is no undo history.

undoNurikabefunction

Return the Nurikabe game with its previous marks or entries restored, or unchanged when there is no undo history.

undoRegionsfunction

Return the Regions game with its previous marks or entries restored, or unchanged when there is no undo history.

undoRipplefunction

Return the Ripple game with its previous marks or entries restored, or unchanged when there is no undo history.

undoShikakufunction

Return the Shikaku game with its previous marks or entries restored, or unchanged when there is no undo history.

undoYajilinfunction

Return the Yajilin game with its previous marks or entries restored, or unchanged when there is no undo history.

valueOfSymbolfunction

The value a symbol names, or 0 for one that is not 1–9 or A–P (either case).

valuesOffunction

The whole grid as it stands: the printed numbers, and the player's where nothing is printed.

VERSIONconstant

The package's version.

YajilinBoardtype

Yajilin dimensions and printed clues in their native row-major representation.

YajilinChecktype

The Yajilin completion result and cells that violate its native rules.

YajilinCluetype

An arrow direction and the required number of shaded cells in its ray.

YajilinDrawOptionstype

Current Yajilin marks or entries, selection, errors and native SVG appearance choices.

YajilinGametype

The immutable Yajilin board, current entries or marks, undo history and assistance state.

YajilinMounttype

The mounted Yajilin game and progress, native controls and cleanup handle.

YajilinMountOptionstype

The initial Yajilin board, native progress, appearance and host event callbacks.

YajilinPuzzletype

A seeded Yajilin board with its verified solution.

yajilinRayfunction

Read cells in the arrow’s indicated direction, excluding its own clue cell.

YajilinSolvetype

A bounded Yajilin solve result: answer count, first solution, node work and whether the search completed.