Nutty Peanut Marshmallow

    snapdragon-visit

    1.0.0 • Public • Published

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

    visit and mapVisit methods for snapdragon nodes.

    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-visit

    Usage

    Use snapdragon-visit in your node.js library with the following line of code:

    const visit = require('snapdragon-visit');

    API

    visit

    Visit the given node with the specified function, the calls mapVisit if node.nodes exists.

    Params

    • node {Object}: (required) Instance of snapdragon-node, or if a plain object is passed it will be converted to an instance of snapdragon-node.
    • fn {Function}: (required)
    • parent {Object}: (optional) Instance of snapdragon-node to use as the node.parent
    • returns {Object}: Returns the given node.

    Example

    const ast = new Node({type: 'root'});
    visit(ast, function(node) {
      node.val = '*';
    });
    console.log(ast.val);
    //=> '*'

    mapVisit

    Calls visit on each node in node.nodes.

    Params

    • node {Object}
    • fn {Function}
    • returns {Object}: Returns the given node.

    Example

    var node = new Node({type: 'star', val: ''});
    var ast = new Node({type: 'root', nodes: []});
    ast.push(node);
     
    visit.map(ast, function(node) {
      if (node.type === 'star') {
        node.val = '*';
      }
    });
     
    console.log(node.val);
    //=> '*'

    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

    Related projects

    You might also be interested in these projects:

    • snapdragon-node: Snapdragon utility for creating a new AST node in custom code, such as plugins. | homepage
    • snapdragon-token: Create a snapdragon token. Used by the snapdragon lexer, but can also be used by… more | homepage
    • snapdragon: Easy-to-use plugin system for creating powerful, fast and versatile parsers and compilers, with built-in source-map… more | homepage

    Author

    Jon Schlinkert

    License

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


    This file was generated by verb-generate-readme, v0.6.0, on November 21, 2017.

    Install

    npm i snapdragon-visit

    DownloadsWeekly Downloads

    2

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert