dgeni-packages/base/services/extractLinks.js

A collection of dgeni packages for generating documentation from source code

var htmlparser = require("htmlparser2");

/**
 * @dgService extractLinks
 * @description
 * Extracts the links and references from a given html
 * @param {String} html The html
 */
module.exports = function extractLinks() {
  return html => {
    const result = {hrefs: [], names: []};
    const parser = new htmlparser.Parser({
      onopentag(name, attribs) {

        // Parse anchor elements, extracting href and name
        if (name === 'a') {
          if (attribs.href) {
            result.hrefs.push(attribs.href);
          }
          if (attribs.name) {
            result.names.push(attribs.name);
          }
        }

        // Extract id from other elements
        if(attribs.id) {
          result.names.push(attribs.id);
        }
      }
    }, {
      decodeEntities: true
    });
    parser.write(html);
    parser.end();
    return result;
  };
};