# sudoku-engine

> Everything you need to build your own sudoku tool/app.

Latest version **0.2.0** (published 2016-03-28) · 0 weekly downloads

## Install

```sh
npm install sudoku-engine
pnpm add sudoku-engine
yarn add sudoku-engine
bun add sudoku-engine
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2016-03-28 |
| First published | 2016-03-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | linusu |

## Links

- npm: https://www.npmjs.com/package/sudoku-engine
- Repository: https://github.com/linusu/node-sudoku-engine
- Homepage: https://github.com/linusu/node-sudoku-engine#readme
- Issues: https://github.com/linusu/node-sudoku-engine/issues
- npm.io page: https://npm.io/package/sudoku-engine

## Recent versions

- 0.2.0 (latest) — 2016-03-28
- 0.1.2 — 2016-03-28
- 0.1.1 — 2016-03-28
- 0.1.0 — 2016-03-28

## README

# Sudoku Engine

Everything you need to build your own sudoku tool/app.

## Installation

```sh
npm install --save sudoku-engine
```

## Usage

```javascript
const sudoku = require('sudoku-engine')
const board = sudoku.generateSolution()

sudoku.printBoard(board)
```

## API

### `.generateSolution() -> Board`

Generate and return a solved board.

### `.validateSolution(board) -> Boolean`

Validate that a board holds a valid solution. Returns a boolean.

### `.printBoard(board)`

Prints a board to the console.

---
_Source: https://npm.io/package/sudoku-engine · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._