snapdragon-stack

    2.1.0 • Public • Published

    snapdragon-stack NPM version NPM monthly downloads NPM total downloads Linux Build Status

    Snapdragon utility for creating a stack.

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

    Install

    Install with npm:

    $ npm install --save snapdragon-stack

    Usage

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

    API

    .first

    Get the first element in the stack.

    • returns {any}

    Example

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

    .lookbehind

    Get the nth element from the end of the stack.

    Params

    • n {Number}
    • returns {Object}

    Example

    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'

    .last

    Get the last element in the stack.

    • returns {any}

    Example

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

    .current

    Semantic alias for stack.last().

    • returns {any}

    Example

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

    .prev

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

    • returns {any}

    Example

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

    .firstChild

    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

    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: '{' }

    .lastChild

    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

    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

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

    Running Tests

    Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

    $ npm install && npm test
    Building docs

    (This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

    To generate the readme, run the following command:

    $ npm install -g verbose/verb#dev verb-generate-readme && verb

    Author

    Jon Schlinkert

    License

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


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

    Install

    npm i snapdragon-stack

    DownloadsWeekly Downloads

    24

    Version

    2.1.0

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert