snapdragon-visit

visit and mapVisit methods for snapdragon nodes.

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

Install

Install with npm:

1$ npm install --save snapdragon-visit

Usage

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

1const 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

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

mapVisit

Calls visit on each node in node.nodes.

Params

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

Example

1var node = new Node({type: 'star', val: ''});
2var ast = new Node({type: 'root', nodes: []});
3ast.push(node);
4
5visit.map(ast, function(node) {
6  if (node.type === 'star') {
7    node.val = '*';
8  }
9});
10
11console.log(node.val);
12//=> '*'

About

1$ npm install && npm test

1$ 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

• github/jonschlinkert
• twitter/jonschlinkert

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.