jsdoc-parser-extended/lib/__tests__/features/PrototypalModules.test.js

Extended JSDoc parser.

var assert = require('assert');
var TestUtils = require('../../TestUtils');
var K = require('../../constants');
var findWhere = require('lodash').findWhere;
var parseInline = TestUtils.parseInline;

describe('CJS::Parser - Prototypal modules', function() {
  it('parses properties assigned to `this`', function() {
    var doc;
    var docs = parseInline(function() {;
      // /** @module */
      // function DragonHunter() {
      //   /**
      //    * @property {String}
      //    *           Hi!
      //    */
      //   this.someProperty = 'a';
      // }
    });

    assert.equal(docs.length, 2);

    doc = findWhere(docs, { name: 'someProperty' });

    assert.ok(doc);
    assert.equal(doc.receiver, 'DragonHunter');
    assert.equal(doc.type, 'String');
    assert.equal(doc.nodeInfo.type, 'Literal');
    assert.equal(doc.nodeInfo.value, 'a');
    assert.equal(doc.nodeInfo.scope, K.SCOPE_INSTANCE);
  });

  it('parses prototype methods', function() {
    var doc;
    var docs = parseInline(function() {;
      // /** @module */
      // function DragonHunter() {}
      //
      // /**
      //  * Do something.
      //  */
      // DragonHunter.prototype.someMethod = function() {};
    });

    assert.equal(docs.length, 2);

    doc = findWhere(docs, { id: 'DragonHunter#someMethod' });

    assert.ok(doc);
    assert.equal(doc.type, K.TYPE_FUNCTION);
    assert.equal(doc.receiver, 'DragonHunter');
    assert.equal(doc.nodeInfo.scope, K.SCOPE_PROTOTYPE);
  });

  it('parses prototype properties', function() {
    var doc;
    var docs = parseInline(function() {;
      // /** @module */
      // function DragonHunter() {}
      //
      // /**
      //  * Do something.
      //  */
      // DragonHunter.prototype.someProperty = 'a';
    });

    assert.equal(docs.length, 2);

    doc = findWhere(docs, { id: 'DragonHunter@someProperty' });

    assert.ok(doc);
    assert.equal(doc.type, K.TYPE_LITERAL);
    assert.equal(doc.receiver, 'DragonHunter');
    assert.equal(doc.nodeInfo.scope, K.SCOPE_PROTOTYPE);
  });
});