snapdragon-stack    

> Snapdragon utility for creating a stack.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

``sh
$ npm install --save snapdragon-stack
`

Usage

`js
const Stack = require('snapdragon-stack');
`

API

$3

Get the first element in the stack.

* returns {any}

Example

`js
const Stack = require('snapdragon-stack');
stack.push('a');
stack.push('b');
stack.push('c');
console.log(stack.first()); //=> 'a'
`

$3

Get the nth element from the end of the stack.

Params

* n {Number}
* returns {Object}

Example

`js
const stack = new Stack();
stack.push('aaa');
stack.push('bbb');
stack.push('ccc');
stack.push('ddd');
console.log(stack.lookbehind(1)); //=> 'ddd'
console.log(stack.lookbehind(2)); //=> 'ccc'
console.log(stack.lookbehind(3)); //=> 'bbb'
`

$3

Get the last element in the stack.

* returns {any}

Example

`js
const Stack = require('snapdragon-stack');
stack.push('a');
stack.push('b');
stack.push('c');
console.log(stack.last()); //=> 'c'
`

$3

Semantic alias for stack.last().

* returns {any}

Example

`js
const Stack = require('snapdragon-stack');
stack.push({ type: 'root' });
console.log(stack.current()); //=> { type: 'root' }
`

$3

Get the second-to-last item in the stack.

* returns {any}

Example

`js
const Stack = require('snapdragon-stack');
stack.push('a');
stack.push('b');
stack.push('c');
console.log(stack.prev()); //=> 'b'
`

$3

If the .first element in the stack is an object with a .nodes array, the first item from stack.first().nodes is returned.

* returns {any}

Example

`js
const Stack = require('snapdragon-stack');
const Node = require('snapdragon-node');

const node = new Node({ type: 'brace' });
node.push(new Node({ type: 'brace.open', value: '{' }));
node.push(new Node({ type: 'text', value: 'a,b,c' }));
node.push(new Node({ type: 'brace.close', value: '}' }));

stack.push(node);
console.log(stack.firstChild()); //=> Node { type: 'brace.open', value: '{' }
`

$3

If the .last element in the stack is an object with a .nodes array, the last item from last.nodes is returned.

* returns {any}

Example

`js
const Stack = require('snapdragon-stack');
const Node = require('snapdragon-node');

const node = new Node({ type: 'brace' });
node.push(new Node({ type: 'brace.open', value: '{' }));
node.push(new Node({ type: 'text', value: 'a,b,c' }));
node.push(new Node({ type: 'brace.close', value: '}' }));

stack.push(node);
console.log(stack.lastChild()); //=> Node { type: 'brace.close', value: '}' }
`

About

$3

Jon Schlinkert

* linkedin/in/jonschlinkert
* github/jonschlinkert
* twitter/jonschlinkert

$3

Copyright © 2018, Jon Schlinkert.
Released under the MIT License.

*

_This file was generated by verb-generate-readme, v0.6.0, on January 21, 2018._