documentation/__tests__/lib/walk.js

const walk = require('../../src/walk').walk;

describe('walk', function() {
  test('flat comments', function() {
    const comments = [{ name: 'Tom' }];

    function renamer(comment, options) {
      if (options) {
        comment.name = options.name;
      } else {
        comment.name = 'Tim';
      }
    }

    expect(walk(comments, renamer)).toEqual([{ name: 'Tim' }]);

    expect(walk(comments, renamer, { name: 'John' })).toEqual([
      { name: 'John' }
    ]);
  });

  test('nested comments', function() {
    const comments = [
      {
        name: 'Tom',
        members: {
          static: [
            {
              name: 'Billy'
            }
          ]
        }
      }
    ];

    function renamer(comment, options) {
      if (options) {
        comment.name = options.name;
      } else {
        comment.name = 'Tim';
      }
    }

    expect(walk(comments, renamer)).toEqual([
      {
        name: 'Tim',
        members: {
          static: [
            {
              name: 'Tim'
            }
          ]
        }
      }
    ]);

    expect(
      walk(comments, renamer, {
        name: 'Bob'
      })
    ).toEqual([
      {
        name: 'Bob',
        members: {
          static: [
            {
              name: 'Bob'
            }
          ]
        }
      }
    ]);
  });
});