README.md
# peekdepth
[![build status](https://api.travis-ci.org/ecman/peekdepth.png)](https://travis-ci.org/ecman/peekdepth) [![codecov](https://codecov.io/gh/ecman/peekdepth/branch/master/graph/badge.svg)](https://codecov.io/gh/ecman/peekdepth) [![Code Climate](https://codeclimate.com/github/ecman/peekdepth/badges/gpa.svg)](https://codeclimate.com/github/ecman/peekdepth)
Get the max depth of a multi-dimensional array
# Usage
```js
const peekdepth = require('peekdepth');
let parentArray = ["parent"];
let childArray = ["child", parentArray];
let grandchildArray = ["grandchild", childArray, parentArray]
childArray.push(grandchildArray);
parentArray.push(childArray);
console.log('grandchildArray:', grandchildArray);
console.log('depth:', peekdepth(grandchildArray));
```
Output:
```text
grandchildArray: [ 'grandchild',
[ 'child', [ 'parent', [Circular] ], [Circular] ],
[ 'parent', [ 'child', [Circular], [Circular] ] ] ]
depth: 3
```