npm - @bartificer/linkify - Versions diffs - 2.3.5 → 2.4.1 - Mend

@bartificer/linkify 2.3.5 → 2.4.1

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 (102) hide show

package/README.md +135 -35
package/dist/index.js +1 -1
package/docs/LinkData.class.mjs.html +119 -56
package/docs/LinkTemplate.class.mjs.html +120 -36
package/docs/Linkifier.class.mjs.html +141 -66
package/docs/PageData.class.mjs.html +145 -72
package/docs/defaults.mjs.html +136 -12
package/docs/docdash-overrides.css +11 -0
package/docs/externals.jsdoc.html +95 -4
package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +978 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +1049 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
package/docs/global.html +1276 -0
package/docs/index.html +1018 -26
package/docs/index.js.html +143 -17
package/docs/mermaid-init.js +21 -0
package/docs/module-cheerio.html +193 -3
package/docs/module-defaults.html +680 -3
package/docs/module-link-data.LinkData.html +813 -0
package/docs/module-link-data.html +226 -0
package/docs/module-link-template.LinkTemplate.html +792 -0
package/docs/module-link-template.html +226 -0
package/docs/module-linkifier.Linkifier.html +2050 -0
package/docs/module-linkifier.html +236 -0
package/docs/module-linkify.html +810 -3
package/docs/module-mustache.html +193 -3
package/docs/module-node-fetch.html +193 -3
package/docs/module-page-data.PageData.html +1810 -0
package/docs/module-page-data.html +226 -0
package/docs/module-title-case.html +193 -3
package/docs/module-urijs.html +193 -3
package/docs/module-url-slug.html +193 -3
package/docs/module-utilities.html +1518 -3
package/docs/scripts/collapse.js +39 -0
package/docs/scripts/commonNav.js +28 -0
package/docs/scripts/linenumber.js +25 -0
package/docs/scripts/nav.js +12 -0
package/docs/scripts/polyfill.js +4 -0
package/docs/scripts/{third-party → prettify}/Apache-License-2.0.txt +202 -202
package/docs/scripts/prettify/lang-css.js +2 -0
package/docs/scripts/prettify/prettify.js +28 -0
package/docs/scripts/search.js +99 -265
package/docs/styles/jsdoc.css +776 -0
package/docs/styles/prettify.css +80 -0
package/docs/typedefs.jsdoc.html +145 -0
package/docs/utilities.mjs.html +154 -22
package/examples/clipboardURLToMarkdown.mjs +80 -1
package/package.json +5 -3
package/src/LinkData.class.mjs +24 -52
package/src/LinkTemplate.class.mjs +25 -32
package/src/Linkifier.class.mjs +46 -62
package/src/PageData.class.mjs +50 -68
package/src/defaults.mjs +42 -8
package/src/index.js +48 -13
package/src/typedefs.jsdoc +52 -0
package/src/utilities.mjs +59 -18
package/docs/data/search.json +0 -1
package/docs/fonts/Inconsolata-Regular.ttf +0 -0
package/docs/fonts/OpenSans-Regular.ttf +0 -0
package/docs/fonts/WorkSans-Bold.ttf +0 -0
package/docs/module-LinkData.LinkData.html +0 -13
package/docs/module-LinkData.html +0 -3
package/docs/module-LinkTemplate.LinkTemplate.html +0 -3
package/docs/module-LinkTemplate.html +0 -3
package/docs/module-Linkifier.Linkifier.html +0 -3
package/docs/module-Linkifier.html +0 -3
package/docs/module-PageData.PageData.html +0 -15
package/docs/module-PageData.html +0 -3
package/docs/scripts/core.js +0 -726
package/docs/scripts/core.min.js +0 -23
package/docs/scripts/resize.js +0 -90
package/docs/scripts/search.min.js +0 -6
package/docs/scripts/third-party/fuse.js +0 -9
package/docs/scripts/third-party/hljs-line-num-original.js +0 -369
package/docs/scripts/third-party/hljs-line-num.js +0 -1
package/docs/scripts/third-party/hljs-original.js +0 -5171
package/docs/scripts/third-party/hljs.js +0 -1
package/docs/scripts/third-party/popper.js +0 -5
package/docs/scripts/third-party/tippy.js +0 -1
package/docs/scripts/third-party/tocbot.js +0 -672
package/docs/scripts/third-party/tocbot.min.js +0 -1
package/docs/styles/clean-jsdoc-theme-base.css +0 -1159
package/docs/styles/clean-jsdoc-theme-dark.css +0 -412
package/docs/styles/clean-jsdoc-theme-light.css +0 -482
package/docs/styles/clean-jsdoc-theme-scrollbar.css +0 -30
package/docs/styles/clean-jsdoc-theme-without-scrollbar.min.css +0 -1
package/docs/styles/clean-jsdoc-theme.min.css +0 -1

package/docs/module-linkifier.Linkifier.html ADDED Viewed

@@ -0,0 +1,2050 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>Linkifier - @bartificer/linkify Documentation</title>
+    <meta name="description" content="Documentation for the @bartificer/linkify package" />
+        <meta name="keywords" content="documentation, linkify, link, template, javascript, generator, npm, module, package" />
+        <meta name="keyword" content="documentation, linkify, link, template, javascript, generator, npm, module, package" />
+    <meta property="og:title" content="@bartificer/linkify"/>
+    <meta property="og:type" content="website"/>
+    <meta property="og:image" content=""/>
+    <meta property="og:site_name" content="@bartificer/linkify Documentation"/>
+    <meta property="og:url" content="https://bartificer.github.io/linkify/"/>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
+    <script src="scripts/nav.js" defer></script>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+</head>
+<body>
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+<label for="nav-trigger" class="overlay"></label>
+<nav class="wrap">
+    <input type="text" id="nav-search" placeholder="Search" />
+    <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><ul class='methods'><li data-type='method'><a href="module-defaults.html#.dataTransformer">dataTransformer</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>Global</h3><ul><li><a href="global.html#dataTransformer">dataTransformer</a></li><li><a href="global.html#plainLinkInformationObject">plainLinkInformationObject</a></li><li><a href="global.html#plainPageInformationObject">plainPageInformationObject</a></li><li><a href="global.html#templateFieldFilterFunction">templateFieldFilterFunction</a></li><li><a href="global.html#templateFieldFilterTuple">templateFieldFilterTuple</a></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>
+</nav>
+<div id="main">
+    <h1 class="page-title">Linkifier</h1>
+<section>
+<header>
+        <h2>
+            <span class="ancestors"><a href="module-linkifier.html">linkifier</a>.</span>
+            Linkifier
+        </h2>
+            <div class="class-description usertext"><p>The class providing the link rendering functionality. Instances of this class capture the settings for generating links, and, generate links using these settings.</p></div>
+</header>
+<article>
+        <div class="container-overview">
+    <h2>Constructor</h2>
+    <h4 class="name" id="Linkifier"><span class="type-signature"></span>new Linkifier<span class="signature">()</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Builds a Linkifier instance ready for use rendering links using the default configration.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line30">line 30</a>
+    </li></ul></dd>
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li><a href="module-defaults.html">module:defaults</a> for the default configuration settings.</li>
+        </ul>
+    </dd>
+</dl>
+        </div>
+        <h3 class="subsection-title">Members</h3>
+<h4 class="name" id="defaultTemplate"><span class="type-signature type-signature-readonly">(readonly) </span>defaultTemplate<span class="type-signature"> :<a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The default link template.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line202">line 202</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>The default link template.</p>
+</div>
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+<span class="param-type"><a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a></span>
+        </li>
+    </ul>
+<h4 class="name" id="defaultTemplateName"><span class="type-signature"></span>defaultTemplateName<span class="type-signature"> :string</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The name of the default template used when rendering links.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line186">line 186</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>The name of the default template used when rendering links.</p>
+</div>
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+<span class="param-type">string</span>
+        </li>
+    </ul>
+<h4 class="name" id="speciallyCapitalisedWords"><span class="type-signature"></span>speciallyCapitalisedWords<span class="type-signature"> :Array.&lt;string></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The list of known words with special capitalisations. The words should be capitalised in the descired manner.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line110">line 110</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>The list of known words with special capitalisations. The words should be capitalised in the descired manner.</p>
+</div>
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+<span class="param-type">Array.&lt;string></span>
+        </li>
+    </ul>
+<h4 class="name" id="templateNames"><span class="type-signature type-signature-readonly">(readonly) </span>templateNames<span class="type-signature"> :Array.&lt;string></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>A list of the names of the registered link templates.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line177">line 177</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>A list of the names of the registered link templates.</p>
+</div>
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+<span class="param-type">Array.&lt;string></span>
+        </li>
+    </ul>
+<h4 class="name" id="util"><span class="type-signature"></span>util<span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Shorthand property for <code>.utilities</code>.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line102">line 102</a>
+    </li></ul></dd>
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li><a href="module-linkifier.Linkifier.html#utilities">module:linkifier.Linkifier#utilities</a></li>
+        </ul>
+    </dd>
+</dl>
+<div class="description usertext">
+    <p>Shorthand property for <code>.utilities</code>.</p>
+</div>
+<h4 class="name" id="utilities"><span class="type-signature type-signature-readonly">(readonly) </span>utilities<span class="type-signature"> :Object.&lt;string, function()></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line94">line 94</a>
+    </li></ul></dd>
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li><a href="module-utilities.html">module:utilities</a> for the utility functions available in this collection.</li>
+        </ul>
+    </dd>
+</dl>
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+<span class="param-type">Object.&lt;string, function()></span>
+        </li>
+    </ul>
+        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id="fetchPageData"><span class="type-signature type-signature-async">(async) </span>fetchPageData<span class="signature">(url)</span><span class="type-signature"> &rarr; {<a href="module-page-data.PageData.html">module:page-data.PageData</a>}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Fetch the page data for a given URL.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line301">line 301</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>url</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"></td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-returns">Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type"><a href="module-page-data.PageData.html">module:page-data.PageData</a></span>
+    </dd>
+</dl>
+    <h4 class="name" id="generateLink"><span class="type-signature type-signature-async">(async) </span>generateLink<span class="signature">(url, templateName<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Generate a link given a URL. By default the registered template for the
+URL's domain will be used, or, if none is registered, the overall
+default will be used (<code>html</code>).</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line343">line 343</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>url</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"></td>
+        </tr>
+        <tr>
+                <td class="name"><code>templateName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                    <code>'html'</code>
+                </td>
+            <td class="description last"></td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-returns">Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">string</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getTemplate"><span class="type-signature"></span>getTemplate<span class="signature">(templateName)</span><span class="type-signature"> &rarr; {<a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a>}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Get a registered link template by name.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line226">line 226</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>templateName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"></td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        <p>A validation error is thrown unless a valid name is passed and corresponds to a registered template.</p>
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">ValidationError</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type"><a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a></span>
+    </dd>
+</dl>
+    <h4 class="name" id="getTemplateNameForDomain"><span class="type-signature"></span>getTemplateNameForDomain<span class="signature">(domain)</span><span class="type-signature"> &rarr; {<a href="global.html#dataTransformer">dataTransformer</a>}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Get the data transformer function for a given domain.</p>
+<p>Note that domains are searched from the subdomain up. For example, if passed
+the domain <code>www.bartificer.ie</code> the function will first look for a
+transformer for the domain <code>www.bartificer.ie</code>, if there's no transformer
+registered for that domain it will look for a transformer for the domain
+<code>bartificer.ie</code>, if there's no transformer for that domain either it will
+return the default transformer.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line265">line 265</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>domain</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>The fully qualified domain name to get the data transformer for.</p></td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-returns">Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type"><a href="global.html#dataTransformer">dataTransformer</a></span>
+    </dd>
+</dl>
+    <h4 class="name" id="getTransformerForDomain"><span class="type-signature"></span>getTransformerForDomain<span class="signature">(domain)</span><span class="type-signature"> &rarr; {<a href="global.html#dataTransformer">dataTransformer</a>}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Get the data transformer function for a given domain.</p>
+<p>Note that domains are searched from the subdomain up. For example, if passed
+the domain <code>www.bartificer.ie</code> the function will first look for a
+transformer for the domain <code>www.bartificer.ie</code>, if there's no transformer
+registered for that domain it will look for a transformer for the domain
+<code>bartificer.ie</code>, if there's no transformer for that domain either it will
+return the default transformer.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line151">line 151</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>domain</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>The fully qualified domain for which to get the data transformer.</p></td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-returns">Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type"><a href="global.html#dataTransformer">dataTransformer</a></span>
+    </dd>
+</dl>
+    <h4 class="name" id="registerDefaultTemplateMapping"><span class="type-signature"></span>registerDefaultTemplateMapping<span class="signature">(domain, templateName)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Register a default template for use with a given domain. This template will
+override the overall default for this domain and all its subdomains.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line242">line 242</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>domain</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>The fully qualified domain name for which this template should be used by default.</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>templateName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>The name of the template to use.</p></td>
+        </tr>
+    </tbody>
+</table>
+    <h4 class="name" id="registerTemplate"><span class="type-signature"></span>registerTemplate<span class="signature">(name, template)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Register a link template.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line212">line 212</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>name</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"></td>
+        </tr>
+        <tr>
+                <td class="name"><code>template</code></td>
+            <td class="type">
+<span class="param-type"><a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a></span>
+            </td>
+            <td class="description last"></td>
+        </tr>
+    </tbody>
+</table>
+    <h4 class="name" id="registerTransformer"><span class="type-signature"></span>registerTransformer<span class="signature">(domain, transformerFn)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Register a data transformer function to a domain name.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line128">line 128</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>domain</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>The fully qualified domain for which this transformer should be
+used.</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>transformerFn</code></td>
+            <td class="type">
+<span class="param-type"><a href="global.html#dataTransformer">dataTransformer</a></span>
+            </td>
+            <td class="description last"><p>The data transformer callback.</p></td>
+        </tr>
+    </tbody>
+</table>
+</article>
+</section>
+</div>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Wed Apr 15 2026 17:49:51 GMT+0100 (Irish Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/polyfill.js"></script>
+<script src="scripts/linenumber.js"></script>
+<script src="scripts/search.js" defer></script>
+    <link type="text/css" rel="stylesheet" href="./docdash-overrides.css">
+    <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+    <script src="./mermaid-init.js"></script>
+</body>
+</html>