JSPM

tree-visitor-async

0.4.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 13
  • Score
    100M100P100Q60195F
  • License MIT

Visit nodes in the tree asynchronously and sequentially. Supports promises.

Package Exports

  • tree-visitor-async

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tree-visitor-async) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Tree Visitor Async

Visit nodes in the tree asynchronously and sequentially. Support promises.

Asynchronous version of Tree Visitor. Actions can return a promise and .visit() returns a promise.

Example

var fs = require('fs');
var Q = require('q');
var VisitorAsync = require('tree-visitor-async');

var nodes = [
    { type: 'import', value: 'path/to/file1' },
    { type: 'import', value: 'path/to/file2' },
];
var visitorAsync = new VisitorAsync({
    import: function (importNode) {
        var deferred = Q.defer();
        fs.readFile(importNode.value, 'utf8', function (err, content) {
            if (err) return deferred.reject(err);
            console.log(content);
            deferred.resolve(content);
        });
        return deferred.promise;
    }
});
visitorAsync.visit(nodes).then(function () {
    this === visitorAsync;
    console.log('done');
});

Actions are passed to the returned promise as fulfill callbacks. So, for example, if an action throws an error or returns a rejected promise, subsequent nodes won't be visited.

this keyword in the fulfill callbacks and the reject callbacks refers the visitor object (e.g., visitorAsync in the previous example).