@bartificer/linkify 2.3.5 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (97) hide show
  1. package/dist/index.js +1 -1
  2. package/docs/LinkData.class.mjs.html +93 -5
  3. package/docs/LinkTemplate.class.mjs.html +93 -5
  4. package/docs/Linkifier.class.mjs.html +99 -11
  5. package/docs/PageData.class.mjs.html +93 -5
  6. package/docs/defaults.mjs.html +116 -12
  7. package/docs/docdash-overrides.css +5 -0
  8. package/docs/externals.jsdoc.html +91 -4
  9. package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  10. package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  11. package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  12. package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  13. package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  14. package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  15. package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  16. package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  17. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  18. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +978 -0
  19. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  20. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  21. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  22. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  23. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +1049 -0
  24. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  25. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  26. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  27. package/docs/index.html +930 -7
  28. package/docs/index.js.html +139 -17
  29. package/docs/module-cheerio.html +189 -3
  30. package/docs/module-defaults.html +585 -3
  31. package/docs/module-link-data.LinkData.html +944 -0
  32. package/docs/module-link-data.html +222 -0
  33. package/docs/module-link-template.LinkTemplate.html +817 -0
  34. package/docs/module-link-template.html +222 -0
  35. package/docs/module-linkifier.Linkifier.html +2323 -0
  36. package/docs/module-linkifier.html +232 -0
  37. package/docs/module-linkify.html +806 -3
  38. package/docs/module-mustache.html +189 -3
  39. package/docs/module-node-fetch.html +189 -3
  40. package/docs/module-page-data.PageData.html +1788 -0
  41. package/docs/module-page-data.html +222 -0
  42. package/docs/module-title-case.html +189 -3
  43. package/docs/module-urijs.html +189 -3
  44. package/docs/module-url-slug.html +189 -3
  45. package/docs/module-utilities.html +1468 -3
  46. package/docs/scripts/collapse.js +39 -0
  47. package/docs/scripts/commonNav.js +28 -0
  48. package/docs/scripts/linenumber.js +25 -0
  49. package/docs/scripts/nav.js +12 -0
  50. package/docs/scripts/polyfill.js +4 -0
  51. package/docs/scripts/{third-party → prettify}/Apache-License-2.0.txt +202 -202
  52. package/docs/scripts/prettify/lang-css.js +2 -0
  53. package/docs/scripts/prettify/prettify.js +28 -0
  54. package/docs/scripts/search.js +99 -265
  55. package/docs/styles/jsdoc.css +776 -0
  56. package/docs/styles/prettify.css +80 -0
  57. package/docs/utilities.mjs.html +124 -5
  58. package/examples/clipboardURLToMarkdown.mjs +80 -1
  59. package/package.json +3 -2
  60. package/src/LinkData.class.mjs +2 -1
  61. package/src/LinkTemplate.class.mjs +2 -1
  62. package/src/Linkifier.class.mjs +8 -7
  63. package/src/PageData.class.mjs +2 -1
  64. package/src/defaults.mjs +26 -8
  65. package/src/index.js +48 -13
  66. package/src/utilities.mjs +33 -1
  67. package/docs/data/search.json +0 -1
  68. package/docs/fonts/Inconsolata-Regular.ttf +0 -0
  69. package/docs/fonts/OpenSans-Regular.ttf +0 -0
  70. package/docs/fonts/WorkSans-Bold.ttf +0 -0
  71. package/docs/module-LinkData.LinkData.html +0 -13
  72. package/docs/module-LinkData.html +0 -3
  73. package/docs/module-LinkTemplate.LinkTemplate.html +0 -3
  74. package/docs/module-LinkTemplate.html +0 -3
  75. package/docs/module-Linkifier.Linkifier.html +0 -3
  76. package/docs/module-Linkifier.html +0 -3
  77. package/docs/module-PageData.PageData.html +0 -15
  78. package/docs/module-PageData.html +0 -3
  79. package/docs/scripts/core.js +0 -726
  80. package/docs/scripts/core.min.js +0 -23
  81. package/docs/scripts/resize.js +0 -90
  82. package/docs/scripts/search.min.js +0 -6
  83. package/docs/scripts/third-party/fuse.js +0 -9
  84. package/docs/scripts/third-party/hljs-line-num-original.js +0 -369
  85. package/docs/scripts/third-party/hljs-line-num.js +0 -1
  86. package/docs/scripts/third-party/hljs-original.js +0 -5171
  87. package/docs/scripts/third-party/hljs.js +0 -1
  88. package/docs/scripts/third-party/popper.js +0 -5
  89. package/docs/scripts/third-party/tippy.js +0 -1
  90. package/docs/scripts/third-party/tocbot.js +0 -672
  91. package/docs/scripts/third-party/tocbot.min.js +0 -1
  92. package/docs/styles/clean-jsdoc-theme-base.css +0 -1159
  93. package/docs/styles/clean-jsdoc-theme-dark.css +0 -412
  94. package/docs/styles/clean-jsdoc-theme-light.css +0 -482
  95. package/docs/styles/clean-jsdoc-theme-scrollbar.css +0 -30
  96. package/docs/styles/clean-jsdoc-theme-without-scrollbar.min.css +0 -1
  97. package/docs/styles/clean-jsdoc-theme.min.css +0 -1
package/docs/module-linkify.html CHANGED
@@ -1,3 +1,806 @@
1
- <!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Module: linkify</title><!--[if lt IE 9]>
2
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
3
- <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="fallback-light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Bartificer Linkifier</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-LinkData.html">LinkData</a></div><div class="sidebar-section-children"><a href="module-LinkTemplate.html">LinkTemplate</a></div><div class="sidebar-section-children"><a href="module-Linkifier.html">Linkifier</a></div><div class="sidebar-section-children"><a href="module-PageData.html">PageData</a></div><div class="sidebar-section-children"><a href="module-defaults.html">defaults</a></div><div class="sidebar-section-children"><a href="module-linkify.html">linkify</a></div><div class="sidebar-section-children"><a href="module-utilities.html">utilities</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-LinkData.LinkData.html">LinkData</a></div><div class="sidebar-section-children"><a href="module-LinkTemplate.LinkTemplate.html">LinkTemplate</a></div><div class="sidebar-section-children"><a href="module-Linkifier.Linkifier.html">Linkifier</a></div><div class="sidebar-section-children"><a href="module-PageData.PageData.html">PageData</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-cheerio.html">cheerio</a></div><div class="sidebar-section-children"><a href="module-mustache.html">mustache</a></div><div class="sidebar-section-children"><a href="module-node-fetch.html">node-fetch</a></div><div class="sidebar-section-children"><a href="module-title-case.html">title-case</a></div><div class="sidebar-section-children"><a href="module-urijs.html">urijs</a></div><div class="sidebar-section-children"><a href="module-url-slug.html">url-slug</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header></header><article><div class="container-overview"><div class="description"><p>The package entry-point.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line6">line 6</a></li></ul></dd></div></dl></div><h2 id="requires" class="subsection-title has-anchor">Requires</h2><ul><li><a href="module-Linkifier.html">module:Linkifier</a></li><li><a href="module-LinkData.html">module:LinkData</a></li><li><a href="module-LinkTemplate.html">module:LinkTemplate</a></li><li><a href="module-PageData.html">module:PageData</a></li></ul><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id=".LinkData"><span class="type-signature">(static) </span>LinkData<span class="type-signature"></span></h3><div class="description"><p>The LinkData class use to store link properties like title and url.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line39">line 39</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".LinkTemplate"><span class="type-signature">(static) </span>LinkTemplate<span class="type-signature"></span></h3><div class="description"><p>The LinkTempalte class used for defining the templates for generating links.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line43">line 43</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".Linkifier"><span class="type-signature">(static) </span>Linkifier<span class="type-signature"></span></h3><div class="description"><p>The Linkifier class that encapsulates the link generations functionality.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line32">line 32</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".PageData"><span class="type-signature">(static) </span>PageData<span class="type-signature"></span></h3><div class="description"><p>The PageData class used to store webpage properties like title and headings.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line35">line 35</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".VERSION"><span class="type-signature">(static, constant) </span>VERSION<span class="type-signature"></span></h3><div class="description"><p>The module's current SEMVER version number.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line25">line 25</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".linkify"><span class="type-signature">(static, constant) </span>linkify<span class="type-signature"></span></h3><div class="description"><p>An instantiated Linkifier object ready for use.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line28">line 28</a></li></ul></dd></div></dl></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Bartificer Linkifier</a><div class="mobile-nav-links"></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-LinkData.html">LinkData</a></div><div class="sidebar-section-children"><a href="module-LinkTemplate.html">LinkTemplate</a></div><div class="sidebar-section-children"><a href="module-Linkifier.html">Linkifier</a></div><div class="sidebar-section-children"><a href="module-PageData.html">PageData</a></div><div class="sidebar-section-children"><a href="module-defaults.html">defaults</a></div><div class="sidebar-section-children"><a href="module-linkify.html">linkify</a></div><div class="sidebar-section-children"><a href="module-utilities.html">utilities</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-LinkData.LinkData.html">LinkData</a></div><div class="sidebar-section-children"><a href="module-LinkTemplate.LinkTemplate.html">LinkTemplate</a></div><div class="sidebar-section-children"><a href="module-Linkifier.Linkifier.html">Linkifier</a></div><div class="sidebar-section-children"><a href="module-PageData.PageData.html">PageData</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-cheerio.html">cheerio</a></div><div class="sidebar-section-children"><a href="module-mustache.html">mustache</a></div><div class="sidebar-section-children"><a href="module-node-fetch.html">node-fetch</a></div><div class="sidebar-section-children"><a href="module-title-case.html">title-case</a></div><div class="sidebar-section-children"><a href="module-urijs.html">urijs</a></div><div class="sidebar-section-children"><a href="module-url-slug.html">url-slug</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+
5
+ <meta charset="utf-8">
6
+ <title>linkify - @bartificer/linkify Documentation</title>
7
+
8
+ <meta name="description" content="Documentation for the @bartificer/linkify package" />
9
+
10
+ <meta name="keywords" content="documentation, linkify, link, template, javascript, generator, npm, module, package" />
11
+ <meta name="keyword" content="documentation, linkify, link, template, javascript, generator, npm, module, package" />
12
+
13
+
14
+
15
+ <meta property="og:title" content="@bartificer/linkify"/>
16
+ <meta property="og:type" content="website"/>
17
+ <meta property="og:image" content=""/>
18
+ <meta property="og:site_name" content="@bartificer/linkify Documentation"/>
19
+ <meta property="og:url" content="https://bartificer.github.io/linkify/"/>
20
+
21
+ <script src="scripts/prettify/prettify.js"></script>
22
+ <script src="scripts/prettify/lang-css.js"></script>
23
+ <!--[if lt IE 9]>
24
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
25
+ <![endif]-->
26
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
27
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
28
+ <script src="scripts/nav.js" defer></script>
29
+
30
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
31
+ </head>
32
+ <body>
33
+
34
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
35
+ <label for="nav-trigger" class="navicon-button x">
36
+ <div class="navicon"></div>
37
+ </label>
38
+
39
+ <label for="nav-trigger" class="overlay"></label>
40
+
41
+ <nav class="wrap">
42
+
43
+ <input type="text" id="nav-search" placeholder="Search" />
44
+
45
+
46
+ <h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/bartificer/linkify" target="_blank" >On GitHub</a></h2><h2><a href="https://bartificer.net/" target="_blank" >Bartificer Creations</a></h2><h3>Modules</h3><ul><li><a href="module-defaults.html">defaults</a><ul class='members'><li data-type='member'><a href="module-defaults.html#.linkTemplates">linkTemplates</a></li><li data-type='member'><a href="module-defaults.html#.smallWords">smallWords</a></li><li data-type='member'><a href="module-defaults.html#.speciallyCapitalisedWords">speciallyCapitalisedWords</a></li></ul></li><li><a href="module-link-data.html">link-data</a></li><li><a href="module-link-template.html">link-template</a></li><li><a href="module-linkifier.html">linkifier</a></li><li><a href="module-linkify.html">linkify</a><ul class='members'><li data-type='member'><a href="module-linkify.html#.LinkData">LinkData</a></li><li data-type='member'><a href="module-linkify.html#.LinkTemplate">LinkTemplate</a></li><li data-type='member'><a href="module-linkify.html#.Linkifier">Linkifier</a></li><li data-type='member'><a href="module-linkify.html#.PageData">PageData</a></li><li data-type='member'><a href="module-linkify.html#.VERSION">VERSION</a></li><li data-type='member'><a href="module-linkify.html#.default">default</a></li><li data-type='member'><a href="module-linkify.html#.linkify">linkify</a></li></ul></li><li><a href="module-page-data.html">page-data</a></li><li><a href="module-utilities.html">utilities</a><ul class='methods'><li data-type='method'><a href="module-utilities.html#.batchFixCustomWordCases">batchFixCustomWordCases</a></li><li data-type='method'><a href="module-utilities.html#.escapeRegex">escapeRegex</a></li><li data-type='method'><a href="module-utilities.html#.extractSlug">extractSlug</a></li><li data-type='method'><a href="module-utilities.html#.regulariseWhitespace">regulariseWhitespace</a></li><li data-type='method'><a href="module-utilities.html#.stripQueryString">stripQueryString</a></li><li data-type='method'><a href="module-utilities.html#.stripUTMParameters">stripUTMParameters</a></li><li data-type='method'><a href="module-utilities.html#.toTitleCase">toTitleCase</a></li></ul></li></ul><h3>Classes</h3><ul><li><a href="module-link-data.LinkData.html">LinkData</a><ul class='methods'><li data-type='method'><a href="module-link-data.LinkData.html#asPlainObject">asPlainObject</a></li></ul></li><li><a href="module-link-template.LinkTemplate.html">LinkTemplate</a><ul class='methods'><li data-type='method'><a href="module-link-template.LinkTemplate.html#addFilter">addFilter</a></li><li data-type='method'><a href="module-link-template.LinkTemplate.html#filtersFor">filtersFor</a></li></ul></li><li><a href="module-linkifier.Linkifier.html">Linkifier</a><ul class='methods'><li data-type='method'><a href="module-linkifier.Linkifier.html#fetchPageData">fetchPageData</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#generateLink">generateLink</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#getTemplate">getTemplate</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#getTemplateNameForDomain">getTemplateNameForDomain</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#getTransformerForDomain">getTransformerForDomain</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#registerDefaultTemplateMapping">registerDefaultTemplateMapping</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#registerTemplate">registerTemplate</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#registerTransformer">registerTransformer</a></li></ul></li><li><a href="module-page-data.PageData.html">PageData</a><ul class='methods'><li data-type='method'><a href="module-page-data.PageData.html#addSecondaryHeading">addSecondaryHeading</a></li><li data-type='method'><a href="module-page-data.PageData.html#addTopLevelHeading">addTopLevelHeading</a></li><li data-type='method'><a href="module-page-data.PageData.html#asPlainObject">asPlainObject</a></li><li data-type='method'><a href="module-page-data.PageData.html#h1">h1</a></li><li data-type='method'><a href="module-page-data.PageData.html#h2">h2</a></li></ul></li></ul><h3>Externals</h3><ul><li><a href="module-cheerio.html">cheerio</a></li><li><a href="module-mustache.html">mustache</a></li><li><a href="module-node-fetch.html">node-fetch</a></li><li><a href="module-title-case.html">title-case</a></li><li><a href="module-urijs.html">urijs</a></li><li><a href="module-url-slug.html">url-slug</a></li></ul>
47
+
48
+ </nav>
49
+
50
+ <div id="main">
51
+
52
+ <h1 class="page-title">linkify</h1>
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+ <section>
61
+
62
+ <header>
63
+
64
+
65
+
66
+
67
+
68
+ </header>
69
+
70
+ <article>
71
+
72
+ <div class="container-overview">
73
+
74
+
75
+ <div class="description usertext"><p>The main module exposed in the npm package <code>@bartificer/linkify</code>. This module exposes the public interface, but does not implement any functionality.</p>
76
+ <p>To understand the link generation functionality, the appropraite entry point into the code is the <a href="module-linkifier.Linkifier.html">module:linkifier.Linkifier</a> class.</p></div>
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+ <dl class="details">
86
+
87
+ <dt class="tag-description">Description:</dt>
88
+ <dd class="tag-description"><ul class="dummy"><li><p>The main module exposed in the npm package <code>@bartificer/linkify</code>. This module exposes the public interface, but does not implement any functionality.</p>
89
+ <p>To understand the link generation functionality, the appropraite entry point into the code is the <a href="module-linkifier.Linkifier.html">module:linkifier.Linkifier</a> class.</p></li></ul></dd>
90
+
91
+
92
+
93
+ <dt class="tag-source">Source:</dt>
94
+ <dd class="tag-source"><ul class="dummy"><li>
95
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line7">line 7</a>
96
+ </li></ul></dd>
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+ <dt class="tag-see">See:</dt>
127
+ <dd class="tag-see">
128
+ <ul>
129
+ <li><a href="module-linkifier.Linkifier.html">module:linkifier.Linkifier</a></li>
130
+ </ul>
131
+ </dd>
132
+
133
+
134
+
135
+ </dl>
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <h5 class="h5-examples">Example</h5>
148
+
149
+ <p class="code-caption">Basic Usage</p>
150
+
151
+ <pre class="prettyprint"><code>import { linkify } from '@bartificer/linkify';
152
+
153
+ (async () => {
154
+ console.log(await linkify.generateLink('https://github.com/bartificer'));
155
+ // Output: &lt;a href="https://github.com/bartificer" title="Bartificer Creations · GitHub">Bartificer Creations · GitHub&lt;/a>
156
+ })();</code></pre>
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+ </div>
181
+
182
+
183
+
184
+
185
+
186
+ <h3 class="subsection-title">Requires</h3>
187
+
188
+ <ul>
189
+ <li><a href="module-linkifier.html">module:linkifier</a></li>
190
+
191
+ <li><a href="module-link-data.html">module:link-data</a></li>
192
+
193
+ <li><a href="module-link-template.html">module:link-template</a></li>
194
+
195
+ <li><a href="module-page-data.html">module:page-data</a></li>
196
+ </ul>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+ <h3 class="subsection-title">Members</h3>
209
+
210
+
211
+
212
+ <h4 class="name" id=".LinkData"><span class="type-signature type-signature-static">(static) </span>LinkData<span class="type-signature"> :<a href="module-link-data.LinkData.html">module:link-data.LinkData</a></span></h4>
213
+
214
+
215
+
216
+
217
+
218
+ <dl class="details">
219
+
220
+ <dt class="tag-description">Description:</dt>
221
+ <dd class="tag-description"><ul class="dummy"><li><p>The data representation class capturing the information about a link, for example its title and URL.</p></li></ul></dd>
222
+
223
+
224
+
225
+ <dt class="tag-source">Source:</dt>
226
+ <dd class="tag-source"><ul class="dummy"><li>
227
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line65">line 65</a>
228
+ </li></ul></dd>
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+ </dl>
261
+
262
+
263
+
264
+
265
+
266
+ <div class="description usertext">
267
+ <p>The data representation class capturing the information about a link, for example its title and URL.</p>
268
+ </div>
269
+
270
+
271
+
272
+ <h5 class="h5-types">Type:</h5>
273
+ <ul>
274
+ <li>
275
+
276
+ <span class="param-type"><a href="module-link-data.LinkData.html">module:link-data.LinkData</a></span>
277
+
278
+
279
+
280
+ </li>
281
+ </ul>
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+ <h4 class="name" id=".LinkTemplate"><span class="type-signature type-signature-static">(static) </span>LinkTemplate<span class="type-signature"> :<a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a></span></h4>
291
+
292
+
293
+
294
+
295
+
296
+ <dl class="details">
297
+
298
+ <dt class="tag-description">Description:</dt>
299
+ <dd class="tag-description"><ul class="dummy"><li><p>The class capturing the details of a template used to render links.</p></li></ul></dd>
300
+
301
+
302
+
303
+ <dt class="tag-source">Source:</dt>
304
+ <dd class="tag-source"><ul class="dummy"><li>
305
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line71">line 71</a>
306
+ </li></ul></dd>
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+ </dl>
339
+
340
+
341
+
342
+
343
+
344
+ <div class="description usertext">
345
+ <p>The class capturing the details of a template used to render links.</p>
346
+ </div>
347
+
348
+
349
+
350
+ <h5 class="h5-types">Type:</h5>
351
+ <ul>
352
+ <li>
353
+
354
+ <span class="param-type"><a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a></span>
355
+
356
+
357
+
358
+ </li>
359
+ </ul>
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+ <h4 class="name" id=".Linkifier"><span class="type-signature type-signature-static">(static) </span>Linkifier<span class="type-signature"> :<a href="module-linkifier.Linkifier.html">module:linkifier.Linkifier</a></span></h4>
369
+
370
+
371
+
372
+
373
+
374
+ <dl class="details">
375
+
376
+ <dt class="tag-description">Description:</dt>
377
+ <dd class="tag-description"><ul class="dummy"><li><p>The Linkifier class that provides the core link generation functionality.</p></li></ul></dd>
378
+
379
+
380
+
381
+ <dt class="tag-source">Source:</dt>
382
+ <dd class="tag-source"><ul class="dummy"><li>
383
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line53">line 53</a>
384
+ </li></ul></dd>
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+ </dl>
417
+
418
+
419
+
420
+
421
+
422
+ <div class="description usertext">
423
+ <p>The Linkifier class that provides the core link generation functionality.</p>
424
+ </div>
425
+
426
+
427
+
428
+ <h5 class="h5-types">Type:</h5>
429
+ <ul>
430
+ <li>
431
+
432
+ <span class="param-type"><a href="module-linkifier.Linkifier.html">module:linkifier.Linkifier</a></span>
433
+
434
+
435
+
436
+ </li>
437
+ </ul>
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+ <h4 class="name" id=".PageData"><span class="type-signature type-signature-static">(static) </span>PageData<span class="type-signature"> :<a href="module-page-data.PageData.html">module:page-data.PageData</a></span></h4>
447
+
448
+
449
+
450
+
451
+
452
+ <dl class="details">
453
+
454
+ <dt class="tag-description">Description:</dt>
455
+ <dd class="tag-description"><ul class="dummy"><li><p>The data representation class capturing the information extracted from a web page, for example the page's title and headings.</p></li></ul></dd>
456
+
457
+
458
+
459
+ <dt class="tag-source">Source:</dt>
460
+ <dd class="tag-source"><ul class="dummy"><li>
461
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line59">line 59</a>
462
+ </li></ul></dd>
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+ </dl>
495
+
496
+
497
+
498
+
499
+
500
+ <div class="description usertext">
501
+ <p>The data representation class capturing the information extracted from a web page, for example the page's title and headings.</p>
502
+ </div>
503
+
504
+
505
+
506
+ <h5 class="h5-types">Type:</h5>
507
+ <ul>
508
+ <li>
509
+
510
+ <span class="param-type"><a href="module-page-data.PageData.html">module:page-data.PageData</a></span>
511
+
512
+
513
+
514
+ </li>
515
+ </ul>
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+ <h4 class="name" id=".VERSION"><span class="type-signature type-signature-static, constant">(static, constant) </span>VERSION<span class="type-signature"> :string</span></h4>
525
+
526
+
527
+
528
+
529
+
530
+ <dl class="details">
531
+
532
+ <dt class="tag-description">Description:</dt>
533
+ <dd class="tag-description"><ul class="dummy"><li><p>The module's current SEMVER version number.</p></li></ul></dd>
534
+
535
+
536
+
537
+ <dt class="tag-source">Source:</dt>
538
+ <dd class="tag-source"><ul class="dummy"><li>
539
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line40">line 40</a>
540
+ </li></ul></dd>
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+ <dt class="tag-see">See:</dt>
571
+ <dd class="tag-see">
572
+ <ul>
573
+ <li><a href="https://semver.org/">https://semver.org/</a></li>
574
+ </ul>
575
+ </dd>
576
+
577
+
578
+
579
+ </dl>
580
+
581
+
582
+
583
+
584
+
585
+ <div class="description usertext">
586
+ <p>The module's current SEMVER version number.</p>
587
+ </div>
588
+
589
+
590
+
591
+ <h5 class="h5-types">Type:</h5>
592
+ <ul>
593
+ <li>
594
+
595
+ <span class="param-type">string</span>
596
+
597
+
598
+
599
+ </li>
600
+ </ul>
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+ <h4 class="name" id=".default"><span class="type-signature type-signature-static, constant">(static, constant) </span>default<span class="type-signature"> :<a href="module-linkifier.Linkifier.html">module:linkifier.Linkifier</a></span></h4>
610
+
611
+
612
+
613
+
614
+
615
+ <dl class="details">
616
+
617
+ <dt class="tag-description">Description:</dt>
618
+ <dd class="tag-description"><ul class="dummy"><li><p>The default export, equivalent to the <code>linkify</code> named export.</p></li></ul></dd>
619
+
620
+
621
+
622
+ <dt class="tag-source">Source:</dt>
623
+ <dd class="tag-source"><ul class="dummy"><li>
624
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line74">line 74</a>
625
+ </li></ul></dd>
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+ <dt class="tag-see">See:</dt>
656
+ <dd class="tag-see">
657
+ <ul>
658
+ <li><a href="module-linkify.html#.linkify">module:linkify.linkify</a></li>
659
+ </ul>
660
+ </dd>
661
+
662
+
663
+
664
+ </dl>
665
+
666
+
667
+
668
+
669
+
670
+ <div class="description usertext">
671
+ <p>The default export, equivalent to the <code>linkify</code> named export.</p>
672
+ </div>
673
+
674
+
675
+
676
+ <h5 class="h5-types">Type:</h5>
677
+ <ul>
678
+ <li>
679
+
680
+ <span class="param-type"><a href="module-linkifier.Linkifier.html">module:linkifier.Linkifier</a></span>
681
+
682
+
683
+
684
+ </li>
685
+ </ul>
686
+
687
+
688
+
689
+
690
+
691
+
692
+
693
+
694
+ <h4 class="name" id=".linkify"><span class="type-signature type-signature-static, constant">(static, constant) </span>linkify<span class="type-signature"> :<a href="module-linkifier.Linkifier.html">module:linkifier.Linkifier</a></span></h4>
695
+
696
+
697
+
698
+
699
+
700
+ <dl class="details">
701
+
702
+ <dt class="tag-description">Description:</dt>
703
+ <dd class="tag-description"><ul class="dummy"><li><p>An instantiated Linkifier object ready for use with the default settings as generated with the defauly constructor.</p></li></ul></dd>
704
+
705
+
706
+
707
+ <dt class="tag-source">Source:</dt>
708
+ <dd class="tag-source"><ul class="dummy"><li>
709
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line46">line 46</a>
710
+ </li></ul></dd>
711
+
712
+
713
+
714
+
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+ </dl>
743
+
744
+
745
+
746
+
747
+
748
+ <div class="description usertext">
749
+ <p>An instantiated Linkifier object ready for use with the default settings as generated with the defauly constructor.</p>
750
+ </div>
751
+
752
+
753
+
754
+ <h5 class="h5-types">Type:</h5>
755
+ <ul>
756
+ <li>
757
+
758
+ <span class="param-type"><a href="module-linkifier.Linkifier.html">module:linkifier.Linkifier</a></span>
759
+
760
+
761
+
762
+ </li>
763
+ </ul>
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+
777
+
778
+ </article>
779
+
780
+ </section>
781
+
782
+
783
+
784
+
785
+
786
+
787
+ </div>
788
+
789
+ <br class="clear">
790
+
791
+ <footer>
792
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Mon Apr 13 2026 16:45:07 GMT+0100 (Irish Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
793
+ </footer>
794
+
795
+ <script>prettyPrint();</script>
796
+ <script src="scripts/polyfill.js"></script>
797
+ <script src="scripts/linenumber.js"></script>
798
+
799
+ <script src="scripts/search.js" defer></script>
800
+
801
+
802
+
803
+ <link type="text/css" rel="stylesheet" href="./docdash-overrides.css">
804
+
805
+ </body>
806
+ </html>