# @laboralphy/grid

> A grid manager, to create resize and iterate over 2D-arrays of cells of any type.

Latest version **1.0.0** (published 2020-09-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install @laboralphy/grid
pnpm add @laboralphy/grid
yarn add @laboralphy/grid
bun add @laboralphy/grid
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-09-03 |
| First published | 2020-09-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | laboralphy |

## Links

- npm: https://www.npmjs.com/package/@laboralphy/grid
- Repository: https://github.com/laboralphy/o876-grid
- Homepage: https://github.com/laboralphy/o876-grid#readme
- Issues: https://github.com/laboralphy/o876-grid/issues
- npm.io page: https://npm.io/package/@laboralphy/grid

## Dependencies (1)

- [esm](https://npm.io/package/esm.md) ^3.2.25

## Recent versions

- 1.0.0 (latest) — 2020-09-03

## README

#O876 Grid
A grid manager.

## Definition
A grid is an array of arrays of cells.
This class allows you to simply resize a 2-dimensional array of cells. 
Each cell may hold any value of any type, including number, string, objects 
or other grids.

## a few examples

```application/javascript
// construct grid
const g = new Grid();

// define event when new cells are built
g.on('rebuild', data => data.cell = data.x * data.y);

// setting new size
g.width = 3;
g.height = 3;

// inspect grid
console.log(g.cells)
```

will print : 
```
[ [ 0, 0, 0 ], 
  [ 0, 1, 2 ], 
  [ 0, 2, 4 ] ]
```

when grid size changes, all cells are rebuilt

```application/javascript
const g = new Grid();
const f1 = data => data.cell = 1;
const f2 = data => data.cell = 2;

// set initial rebuild event handler
g.on('rebuild', f1);
g.width = 3;
g.height = 3;

// change rebuild event handler
g.off('rebuild', f1);
g.on('rebuild', f2);

// change size
g.width = 4;
g.height = 4;
console.log(g.cells)
```

will print : 
```
[ [ 2, 2, 2, 2 ], 
  [ 2, 2, 2, 2 ], 
  [ 2, 2, 2, 2 ], 
  [ 2, 2, 2, 2 ] ]
```

###lazy mode
In lazy mode this is not true :

```application/javascript
const g = new Grid();
g.lazy = true;

const f1 = data => data.cell = 'first';
const f2 = data => data.cell = 'second';

// set initial rebuild event handler
g.on('rebuild', f1);
g.width = 3;
g.height = 3;

// change rebuild event handler
g.off('rebuild', f1);
g.on('rebuild', f2);

// change size
g.width = 4;
g.height = 4;
console.log(g.cells)
```

will print : 
```
[ [ 'first', 'first', 'first', 'second' ], 
  [ 'first', 'first', 'first', 'second' ], 
  [ 'first', 'first', 'first', 'second' ], 
  [ 'second', 'second', 'second', 'second' ] ]
```

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