Reference · Rules, generation and deductions
Settingstype
Board dimensions and rules used to deal and validate a game.
Import it
import type { Settings } from "@johnmorrisdotca/jirai";Definition
type Settings = {
shape?: "rectangle" | "heart" | "star" | "hexagon";
width: number;
height: number;
mines: number;
grid: Grid;
noGuess: boolean;
opening: "safe" | "clear";
seed: number;
};Members
| Name | Type | Description |
|---|---|---|
shape (optional) | "rectangle" | "heart" | "star" | "hexagon" | undefined | Shape omits cells; rectangle is the compatible default. Wrap requires rectangle. |
width | number | |
height | number | |
mines | number | |
grid | Grid | |
noGuess | boolean | Only accept boards the deduction solver finishes from the opening. |
opening | "safe" | "clear" | The opening and every neighbour are safe, not only the first cell. |
seed | number |
Examples
import type { Settings } from "@johnmorrisdotca/jirai";
const settings: Settings={width:3,height:3,mines:1,grid:"square",noGuess:false,opening:"clear",seed:42};
const value: Settings = settings;
console.log(value);{
width: 3,
height: 3,
mines: 1,
grid: 'square',
noGuess: false,
opening: 'clear',
seed: 42
}What it prints (run when this page was built)