@mitchallen/connection-grid-square
Connection grid for square array
Installation
You must use npm 2.7.0 or higher because of the scoped package name.
$ npm init
$ npm install @mitchallen/connection-grid-square --save
Usage
"use strict";
let gridFactory = require("@mitchallen/connection-grid-square");
let xSize = 5;
let ySize = 6;
let grid = gridFactory.create({ x: xSize, y: ySize });Browser Usage:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Connection-Grid-Square Example</title>
<meta name="description" content="Connection Grid Square Example">
<script src="https://unpkg.com/@mitchallen/connection-grid-square@0.1.17/dist/connection-grid-square.min.js"></script>
<script>
var factory = window.MitchAllen.ConnectionGridSquare;
console.log(factory);
var xSize = 10, ySize = 5;
var sg = factory.create( { x: xSize, y: ySize } );
console.log(sg);
sg.log();
</script>
</head>
<body>
<h1>Connection Grid Square Example</h1>
</body>
</html>Documentation
Testing
To test, go to the root folder and type (sans $):
$ npm test
Repo(s)
- bitbucket.org/mitchallen/connection-grid-square.git
- github.com/mitchallen/connection-grid-square.git
Contributing
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
Version History
Version 0.1.9
- updated .npmignore
- updated dependencies
Version 0.1.8
- updated to latest version of grid-square and connection-grid-core
- updated test coverage to 100%
Version 0.1.7
- integrated travis-ci and codecov.io
Version 0.1.6
- installed latest version of @mitchallen/connection-grid-core
Version 0.1.5
- installed latest version of @mitchallen/connection-grid-core
- refactored documentation
Version 0.1.4
- corrected version history
Version 0.1.3
- installed latest version of @mitchallen/connection-grid-core
- updated npm scripts
- updated client example
- integrated jsdoc
Version 0.1.2
- error while publishing, trying again
Version 0.1.1
- added missing package dependency for @mitchallen/connection-grid-core
Version 0.1.0
- initial release