@bartificer/linkify 2.4.0 → 2.4.1

package/docs/module-linkifier.Linkifier.html

@@ -43,7 +43,7 @@
     <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></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>
+    <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>
 
@@ -93,6 +93,9 @@
 
 <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>
@@ -127,6 +130,13 @@
 
     
 
+    
+    <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>
     
 
     
@@ -182,7 +192,7 @@
 
         
             
-<h4 class="name" id="defaultTemplate"><span class="type-signature"></span>defaultTemplate<span class="type-signature"> :module:LinkTemplate.class.LinkTemplate</span></h4>
+<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>
 
 
 
@@ -197,7 +207,7 @@
     
     <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#line209">line 209</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line202">line 202</a>
     </li></ul></dd>
     
 
@@ -246,7 +256,7 @@
     <ul>
         <li>
             
-<span class="param-type">module:LinkTemplate.class.LinkTemplate</span>
+<span class="param-type"><a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a></span>
 
 
 
@@ -260,7 +270,7 @@
 
         
             
-<h4 class="name" id="defaultTemplateName"><span class="type-signature"></span>defaultTemplateName<span class="type-signature"></span></h4>
+<h4 class="name" id="defaultTemplateName"><span class="type-signature"></span>defaultTemplateName<span class="type-signature"> :string</span></h4>
 
 
 
@@ -268,11 +278,14 @@
 
 <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#line189">line 189</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line186">line 186</a>
     </li></ul></dd>
     
 
@@ -311,67 +324,22 @@
 
 
 
+<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>
             
-<h4 class="name" id="defaultTemplateName"><span class="type-signature"></span>defaultTemplateName<span class="type-signature"></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#line197">line 197</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
+<span class="param-type">string</span>
 
 
 
+        </li>
+    </ul>
 
 
 
@@ -380,7 +348,7 @@
 
         
             
-<h4 class="name" id="speciallyCapitalisedWords"><span class="type-signature"></span>speciallyCapitalisedWords<span class="type-signature"></span></h4>
+<h4 class="name" id="speciallyCapitalisedWords"><span class="type-signature"></span>speciallyCapitalisedWords<span class="type-signature"> :Array.&lt;string></span></h4>
 
 
 
@@ -388,11 +356,14 @@
 
 <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#line108">line 108</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line110">line 110</a>
     </li></ul></dd>
     
 
@@ -431,67 +402,22 @@
 
 
 
+<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>
             
-<h4 class="name" id="speciallyCapitalisedWords"><span class="type-signature"></span>speciallyCapitalisedWords<span class="type-signature"></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#line117">line 117</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
+<span class="param-type">Array.&lt;string></span>
 
 
 
+        </li>
+    </ul>
 
 
 
@@ -500,7 +426,7 @@
 
         
             
-<h4 class="name" id="templateNames"><span class="type-signature"></span>templateNames<span class="type-signature"> :Array.&lt;string></span></h4>
+<h4 class="name" id="templateNames"><span class="type-signature type-signature-readonly">(readonly) </span>templateNames<span class="type-signature"> :Array.&lt;string></span></h4>
 
 
 
@@ -515,7 +441,7 @@
     
     <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#line182">line 182</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line177">line 177</a>
     </li></ul></dd>
     
 
@@ -586,11 +512,14 @@
 
 <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#line101">line 101</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line102">line 102</a>
     </li></ul></dd>
     
 
@@ -624,7 +553,7 @@
     <dt class="tag-see">See:</dt>
     <dd class="tag-see">
         <ul>
-            <li>Linfifier.utilities</li>
+            <li><a href="module-linkifier.Linkifier.html#utilities">module:linkifier.Linkifier#utilities</a></li>
         </ul>
     </dd>
     
@@ -636,6 +565,10 @@
 
 
 
+<div class="description usertext">
+    <p>Shorthand property for <code>.utilities</code>.</p>
+</div>
+
 
 
 
@@ -645,7 +578,7 @@
 
         
             
-<h4 class="name" id="utilities"><span class="type-signature"></span>utilities<span class="type-signature"> :Object.&lt;string, function()></span></h4>
+<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>
 
 
 
@@ -687,6 +620,13 @@
 
     
 
+    
+    <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>
     
 
     
@@ -725,7 +665,7 @@
 
     
 
-    <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; {PageData}</span></h4>
+    <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>
 
     
 
@@ -741,7 +681,7 @@
     
     <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#line316">line 316</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line301">line 301</a>
     </li></ul></dd>
     
 
@@ -819,7 +759,7 @@
             <td class="type">
             
                 
-<span class="param-type">URL</span>
+<span class="param-type">string</span>
 
 
 
@@ -850,37 +790,6 @@
 
 
 
-<h5 class="h5-throws">Throws:</h5>
-
-        
-
-<dl>
-    <dt>
-        <div class="param-desc usertext">
-        <p>A validation error is thrown unless a valid URL is
-passed.</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>
@@ -894,7 +803,7 @@ passed.</p>
     </dt>
     <dd>
         
-<span class="param-type">PageData</span>
+<span class="param-type"><a href="module-page-data.PageData.html">module:page-data.PageData</a></span>
 
 
 
@@ -928,7 +837,7 @@ 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#line360">line 360</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line343">line 343</a>
     </li></ul></dd>
     
 
@@ -1010,7 +919,7 @@ default will be used (<code>html</code>).</p></li></ul></dd>
             <td class="type">
             
                 
-<span class="param-type">URL</span>
+<span class="param-type">string</span>
 
 
 
@@ -1046,7 +955,7 @@ default will be used (<code>html</code>).</p></li></ul></dd>
             <td class="type">
             
                 
-<span class="param-type">templateName</span>
+<span class="param-type">string</span>
 
 
 
@@ -1093,37 +1002,6 @@ default will be used (<code>html</code>).</p></li></ul></dd>
 
 
 
-<h5 class="h5-throws">Throws:</h5>
-
-        
-
-<dl>
-    <dt>
-        <div class="param-desc usertext">
-        <p>A validation error is thrown unless a valid URL is
-passed.</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>
@@ -1153,7 +1031,7 @@ passed.</p>
 
     
 
-    <h4 class="name" id="getTemplate"><span class="type-signature"></span>getTemplate<span class="signature">(templateName)</span><span class="type-signature"> &rarr; {LinkTemplate}</span></h4>
+    <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>
 
     
 
@@ -1169,7 +1047,7 @@ passed.</p>
     
     <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#line235">line 235</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line226">line 226</a>
     </li></ul></dd>
     
 
@@ -1321,7 +1199,7 @@ passed.</p>
     </dt>
     <dd>
         
-<span class="param-type">LinkTemplate</span>
+<span class="param-type"><a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a></span>
 
 
 
@@ -1337,7 +1215,7 @@ passed.</p>
 
     
 
-    <h4 class="name" id="getTemplateNameForDomain"><span class="type-signature"></span>getTemplateNameForDomain<span class="signature">(domain)</span><span class="type-signature"> &rarr; {dataTransformer}</span></h4>
+    <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>
 
     
 
@@ -1349,17 +1227,17 @@ passed.</p>
     <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.net</code> the function will first look for a
-transformer for the domain <code>www.bartificer.net</code>, if there's no transformer
+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.net</code>, if there's no transformer for that domain either it will
+<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#line278">line 278</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line265">line 265</a>
     </li></ul></dd>
     
 
@@ -1437,7 +1315,7 @@ return the default transformer.</p></li></ul></dd>
             <td class="type">
             
                 
-<span class="param-type">domainName</span>
+<span class="param-type">string</span>
 
 
 
@@ -1448,7 +1326,7 @@ return the default transformer.</p></li></ul></dd>
 
             
 
-            <td class="description last"><p>The domain to get the data transformer for.</p></td>
+            <td class="description last"><p>The fully qualified domain name to get the data transformer for.</p></td>
         </tr>
 
     
@@ -1468,37 +1346,6 @@ return the default transformer.</p></li></ul></dd>
 
 
 
-<h5 class="h5-throws">Throws:</h5>
-
-        
-
-<dl>
-    <dt>
-        <div class="param-desc usertext">
-        <p>A validation error is thrown unless a valid domain
-name is passed.</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>
@@ -1512,7 +1359,7 @@ name is passed.</p>
     </dt>
     <dd>
         
-<span class="param-type">dataTransformer</span>
+<span class="param-type"><a href="global.html#dataTransformer">dataTransformer</a></span>
 
 
 
@@ -1528,7 +1375,7 @@ name is passed.</p>
 
     
 
-    <h4 class="name" id="getTransformerForDomain"><span class="type-signature"></span>getTransformerForDomain<span class="signature">(domain)</span><span class="type-signature"> &rarr; {dataTransformer}</span></h4>
+    <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>
 
     
 
@@ -1540,17 +1387,17 @@ name is passed.</p>
     <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.net</code> the function will first look for a
-transformer for the domain <code>www.bartificer.net</code>, if there's no transformer
+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.net</code>, if there's no transformer for that domain either it will
+<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#line157">line 157</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line151">line 151</a>
     </li></ul></dd>
     
 
@@ -1628,7 +1475,7 @@ return the default transformer.</p></li></ul></dd>
             <td class="type">
             
                 
-<span class="param-type">domainName</span>
+<span class="param-type">string</span>
 
 
 
@@ -1639,7 +1486,7 @@ return the default transformer.</p></li></ul></dd>
 
             
 
-            <td class="description last"><p>The domain to get the data transformer for.</p></td>
+            <td class="description last"><p>The fully qualified domain for which to get the data transformer.</p></td>
         </tr>
 
     
@@ -1659,37 +1506,6 @@ return the default transformer.</p></li></ul></dd>
 
 
 
-<h5 class="h5-throws">Throws:</h5>
-
-        
-
-<dl>
-    <dt>
-        <div class="param-desc usertext">
-        <p>A validation error is thrown unless a valid domain
-name is passed.</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>
@@ -1703,7 +1519,7 @@ name is passed.</p>
     </dt>
     <dd>
         
-<span class="param-type">dataTransformer</span>
+<span class="param-type"><a href="global.html#dataTransformer">dataTransformer</a></span>
 
 
 
@@ -1736,7 +1552,7 @@ override the overall default for this domain and all its subdomains.</p></li></u
     
     <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#line253">line 253</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line242">line 242</a>
     </li></ul></dd>
     
 
@@ -1814,7 +1630,7 @@ override the overall default for this domain and all its subdomains.</p></li></u
             <td class="type">
             
                 
-<span class="param-type">domainName</span>
+<span class="param-type">string</span>
 
 
 
@@ -1825,7 +1641,7 @@ override the overall default for this domain and all its subdomains.</p></li></u
 
             
 
-            <td class="description last"><p>The domain for which this template should be used by default.</p></td>
+            <td class="description last"><p>The fully qualified domain name for which this template should be used by default.</p></td>
         </tr>
 
     
@@ -1838,7 +1654,7 @@ override the overall default for this domain and all its subdomains.</p></li></u
             <td class="type">
             
                 
-<span class="param-type">templateName</span>
+<span class="param-type">string</span>
 
 
 
@@ -1869,37 +1685,6 @@ override the overall default for this domain and all its subdomains.</p></li></u
 
 
 
-<h5 class="h5-throws">Throws:</h5>
-
-        
-
-<dl>
-    <dt>
-        <div class="param-desc usertext">
-        <p>A validation error is thrown if either parameter
-is missing or invalid.</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>
-
-
-    
 
 
 
@@ -1926,7 +1711,7 @@ is missing or invalid.</p>
     
     <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#line221">line 221</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line212">line 212</a>
     </li></ul></dd>
     
 
@@ -2028,7 +1813,7 @@ is missing or invalid.</p>
             <td class="type">
             
                 
-<span class="param-type">LinkTemplate</span>
+<span class="param-type"><a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a></span>
 
 
 
@@ -2059,37 +1844,6 @@ is missing or invalid.</p>
 
 
 
-<h5 class="h5-throws">Throws:</h5>
-
-        
-
-<dl>
-    <dt>
-        <div class="param-desc usertext">
-        <p>A validation error is thrown unless both a valid
-name and template object are passed.</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>
-
-
-    
 
 
 
@@ -2110,13 +1864,13 @@ name and template object are passed.</p>
 <dl class="details">
     
     <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>Register a data transformer function for a given domain.</p></li></ul></dd>
+    <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#line132">line 132</a>
+        <a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line128">line 128</a>
     </li></ul></dd>
     
 
@@ -2194,7 +1948,7 @@ name and template object are passed.</p>
             <td class="type">
             
                 
-<span class="param-type">domainName</span>
+<span class="param-type">string</span>
 
 
 
@@ -2205,7 +1959,7 @@ name and template object are passed.</p>
 
             
 
-            <td class="description last"><p>The domain for which this transformer should be
+            <td class="description last"><p>The fully qualified domain for which this transformer should be
 used.</p></td>
         </tr>
 
@@ -2219,7 +1973,7 @@ used.</p></td>
             <td class="type">
             
                 
-<span class="param-type">dataTransformer</span>
+<span class="param-type"><a href="global.html#dataTransformer">dataTransformer</a></span>
 
 
 
@@ -2250,37 +2004,6 @@ used.</p></td>
 
 
 
-<h5 class="h5-throws">Throws:</h5>
-
-        
-
-<dl>
-    <dt>
-        <div class="param-desc usertext">
-        <p>A validation error is thrown if either parameter
-is missing or invalid.</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>
-
-
-    
 
 
 
@@ -2306,7 +2029,7 @@ is missing or invalid.</p>
 <br class="clear">
 
 <footer>
-    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.
+    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>
@@ -2319,5 +2042,9 @@ is missing or invalid.</p>
 
     <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>