@reactivex/rxjs/tools/custom-esdoc-plugin.js

Reactive Extensions for modern JavaScript

function getTagValue(tag, tagName) {
  var unknownTags = tag.unknown;
  if (!unknownTags) {
    return null;
  }
  var unknownTagsLength = unknownTags.length;
  for (var i = 0; i < unknownTagsLength; i++) {
    if (unknownTags[i].tagName === tagName) {
      return unknownTags[i].tagValue;
    }
  }
  return null;
}

function getLongname(ev, name) {
  var index = ev.data.tag.findIndex(function (t) {
    return t.name === name;
  });
  if (index === -1) {
    throw new Error('could not find longname for unknown tag named "' + name +
      '"');
  } else {
    return ev.data.tag[index].longname;
  }
}

/**
 * Fixes ESDoc structure by moving all "add-able" operator functions
 * (either prototype operator or static operator) under the Observable class.
 * Looks for the "@owner" tag, then moves the thing to that owner. "@owner" is
 * usually "Observable", but may be something else.
 */
exports.onHandleTag = function onHandleTag(ev) {
  var tagsLen = ev.data.tag.length;
  for (var i = 0; i < tagsLen; i++) {
    var tag = ev.data.tag[i];
    var owner = getTagValue(tag, '@owner');
    var name = getTagValue(tag, '@name');
    var isStatic = getTagValue(tag, '@static');
    var noImport = getTagValue(tag, '@noimport');
    var isHidden = getTagValue(tag, '@hide');
    if (name) {
      tag.name = name;
    }
    if (noImport) {
      delete tag.importPath;
      delete tag.importStyle;
    }
    if (isHidden) {
      ev.data.tag[i].builtinExternal = true;
    }
    if (owner && owner === 'Observable') {
      var ownerLongname = getLongname(ev, owner);
      tag.kind = 'method';
      tag.static = false;
      tag.memberof = ownerLongname;
      if (isStatic) {
        tag.static = true;
      }
      delete tag.importPath;
      delete tag.importStyle;
    }
  }
  return ev;
};