@bartificer/linkify 2.4.0 → 2.4.1

package/docs/module-page-data.PageData.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>
 
@@ -69,7 +69,8 @@
         
         </h2>
         
-            <div class="class-description usertext"><p>A class representing the data extracted from web pages that can be transformed into link data for use when rendering links.</p></div>
+            <div class="class-description usertext"><p>The information extracted from web pages that can be used to render a link.</p>
+<p>Instances of this class are created from the information extracted from web pages and converted to link information by data transformers before being rendered to links via templates.</p></div>
         
     
 </header>
@@ -93,14 +94,11 @@
 
 <dl class="details">
     
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>This constructor throws a ValidationError unless a valid URL is passed.</p></li></ul></dd>
-    
 
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line17">line 17</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line20">line 20</a>
     </li></ul></dd>
     
 
@@ -130,6 +128,13 @@
 
     
 
+    
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li><a href="global.html#dataTransformer">dataTransformer</a> for details of how instances of this class are used in the link generation process.</li>
+        </ul>
+    </dd>
     
 
     
@@ -178,7 +183,7 @@
             <td class="type">
             
                 
-<span class="param-type">URL</span>
+<span class="param-type">string</span>
 
 
 
@@ -209,37 +214,6 @@
 
 
 
-<h5 class="h5-throws">Throws:</h5>
-
-        
-
-<dl>
-    <dt>
-        <div class="param-desc usertext">
-        <p>A validation error is thrown if an invalid 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>
-
-
-    
 
 
 
@@ -266,7 +240,7 @@ is passed.</p>
 
         
             
-<h4 class="name" id="domain"><span class="type-signature"></span>domain<span class="type-signature"></span></h4>
+<h4 class="name" id="domain"><span class="type-signature type-signature-readonly">(readonly) </span>domain<span class="type-signature"> :string</span></h4>
 
 
 
@@ -275,13 +249,13 @@ is passed.</p>
 <dl class="details">
     
     <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>Get the domain-part of the URL as a string.</p></li></ul></dd>
+    <dd class="tag-description"><ul class="dummy"><li><p>The domain-part of the URL.</p></li></ul></dd>
     
 
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line88">line 88</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line85">line 85</a>
     </li></ul></dd>
     
 
@@ -321,11 +295,22 @@ is passed.</p>
 
 
 <div class="description usertext">
-    <p>Get the domain-part of the URL as a string.</p>
+    <p>The domain-part of the URL.</p>
 </div>
 
 
 
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">string</span>
+
+
+
+        </li>
+    </ul>
+
 
 
 
@@ -333,7 +318,7 @@ is passed.</p>
 
         
             
-<h4 class="name" id="h1s"><span class="type-signature"></span>h1s<span class="type-signature"></span></h4>
+<h4 class="name" id="h1s"><span class="type-signature type-signature-readonly">(readonly) </span>h1s<span class="type-signature"></span></h4>
 
 
 
@@ -348,7 +333,7 @@ is passed.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line149">line 149</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line148">line 148</a>
     </li></ul></dd>
     
 
@@ -382,7 +367,7 @@ is passed.</p>
     <dt class="tag-see">See:</dt>
     <dd class="tag-see">
         <ul>
-            <li>PageData#topLevelHeadings</li>
+            <li><a href="module-page-data.PageData.html#topLevelHeadings">module:page-data.PageData#topLevelHeadings</a></li>
         </ul>
     </dd>
     
@@ -407,7 +392,7 @@ is passed.</p>
 
         
             
-<h4 class="name" id="h2s"><span class="type-signature"></span>h2s<span class="type-signature"></span></h4>
+<h4 class="name" id="h2s"><span class="type-signature type-signature-readonly">(readonly) </span>h2s<span class="type-signature"></span></h4>
 
 
 
@@ -456,7 +441,7 @@ is passed.</p>
     <dt class="tag-see">See:</dt>
     <dd class="tag-see">
         <ul>
-            <li>PageData#secondaryHeadings</li>
+            <li><a href="module-page-data.PageData.html#secondaryHeadings">module:page-data.PageData#secondaryHeadings</a></li>
         </ul>
     </dd>
     
@@ -481,7 +466,7 @@ is passed.</p>
 
         
             
-<h4 class="name" id="headings"><span class="type-signature"></span>headings<span class="type-signature"></span></h4>
+<h4 class="name" id="headings"><span class="type-signature type-signature-readonly">(readonly) </span>headings<span class="type-signature"> :Object</span></h4>
 
 
 
@@ -490,13 +475,13 @@ is passed.</p>
 <dl class="details">
     
     <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>Get the page's section headings.</p></li></ul></dd>
+    <dd class="tag-description"><ul class="dummy"><li><p>The page's primary and secondary headings.</p></li></ul></dd>
     
 
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line118">line 118</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line116">line 116</a>
     </li></ul></dd>
     
 
@@ -533,86 +518,101 @@ is passed.</p>
 
 
 
+    <h5 class="subsection-title">Properties:</h5>
 
+    
 
-<div class="description usertext">
-    <p>Get the page's section headings.</p>
-</div>
-
+<table class="props">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
 
+        <th>Type</th>
 
+        
 
+        
 
+        <th class="last">Description</th>
+    </tr>
+    </thead>
 
+    <tbody>
+    
 
+        <tr>
+            
+                <td class="name"><code>h1</code></td>
+            
 
-        
+            <td class="type">
             
-<h4 class="name" id="mainHeading"><span class="type-signature"></span>mainHeading<span class="type-signature"></span></h4>
+                
+<span class="param-type">Array.&lt;string></span>
 
 
 
+            
+            </td>
 
+            
 
-<dl class="details">
-    
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>The text from the most important heading on the page. If the page
-has <code>h1</code> tags, the first one will be used, if not, the first <code>h2</code> tag
-will be used, and if there's none of those either, an empty string will
-be returned.</p></li></ul></dd>
-    
+            
 
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line182">line 182</a>
-    </li></ul></dd>
-    
+            <td class="description last"><p>The page's top-level headings (<code>h1</code> tags).</p></td>
+        </tr>
 
     
 
-    
+        <tr>
+            
+                <td class="name"><code>h2</code></td>
+            
 
-    
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;string></span>
 
-    
 
-    
 
-    
+            
+            </td>
 
-    
+            
 
-    
+            
 
-    
+            <td class="description last"><p>The page's secondary headings (<code>h2</code> tags).</p></td>
+        </tr>
 
     
+    </tbody>
+</table>
 
-    
 
-    
 
-    
 
-    
 
-    
-</dl>
 
+<div class="description usertext">
+    <p>The page's primary and secondary headings.</p>
+</div>
 
 
 
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Object</span>
 
-<div class="description usertext">
-    <p>The text from the most important heading on the page. If the page
-has <code>h1</code> tags, the first one will be used, if not, the first <code>h2</code> tag
-will be used, and if there's none of those either, an empty string will
-be returned.</p>
-</div>
 
 
+        </li>
+    </ul>
 
 
 
@@ -621,7 +621,7 @@ be returned.</p>
 
         
             
-<h4 class="name" id="path"><span class="type-signature"></span>path<span class="type-signature"></span></h4>
+<h4 class="name" id="mainHeading"><span class="type-signature type-signature-readonly">(readonly) </span>mainHeading<span class="type-signature"> :string</span></h4>
 
 
 
@@ -629,11 +629,17 @@ be returned.</p>
 
 <dl class="details">
     
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The text from the most important heading on the page. If the page
+has <code>h1</code> tags, the first one will be used, if not, the first <code>h2</code> tag
+will be used, and if there's none of those either, an empty string will
+be returned.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line95">line 95</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line182">line 182</a>
     </li></ul></dd>
     
 
@@ -672,16 +678,34 @@ be returned.</p>
 
 
 
+<div class="description usertext">
+    <p>The text from the most important heading on the page. If the page
+has <code>h1</code> tags, the first one will be used, if not, the first <code>h2</code> tag
+will be used, and if there's none of those either, an empty string will
+be returned.</p>
+</div>
+
+
+
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">string</span>
 
 
 
+        </li>
+    </ul>
+
+
 
 
 
 
         
             
-<h4 class="name" id="secondaryHeadings"><span class="type-signature"></span>secondaryHeadings<span class="type-signature"></span></h4>
+<h4 class="name" id="path"><span class="type-signature type-signature-readonly">(readonly) </span>path<span class="type-signature"> :string</span></h4>
 
 
 
@@ -690,13 +714,13 @@ be returned.</p>
 <dl class="details">
     
     <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>The page's secondary headings (<code>h2</code> tags).</p></li></ul></dd>
+    <dd class="tag-description"><ul class="dummy"><li><p>The path-part of the URL.</p></li></ul></dd>
     
 
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line158">line 158</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line94">line 94</a>
     </li></ul></dd>
     
 
@@ -736,11 +760,22 @@ be returned.</p>
 
 
 <div class="description usertext">
-    <p>The page's secondary headings (<code>h2</code> tags).</p>
+    <p>The path-part of the URL.</p>
 </div>
 
 
 
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">string</span>
+
+
+
+        </li>
+    </ul>
+
 
 
 
@@ -748,7 +783,7 @@ be returned.</p>
 
         
             
-<h4 class="name" id="title"><span class="type-signature"></span>title<span class="type-signature"></span></h4>
+<h4 class="name" id="secondaryHeadings"><span class="type-signature type-signature-readonly">(readonly) </span>secondaryHeadings<span class="type-signature"> :Array.&lt;string></span></h4>
 
 
 
@@ -756,11 +791,14 @@ be returned.</p>
 
 <dl class="details">
     
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The page's secondary headings (<code>h2</code> tags).</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line102">line 102</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line157">line 157</a>
     </li></ul></dd>
     
 
@@ -799,7 +837,22 @@ be returned.</p>
 
 
 
+<div class="description usertext">
+    <p>The page's secondary headings (<code>h2</code> tags).</p>
+</div>
+
+
+
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Array.&lt;string></span>
+
+
 
+        </li>
+    </ul>
 
 
 
@@ -808,7 +861,7 @@ be returned.</p>
 
         
             
-<h4 class="name" id="title"><span class="type-signature"></span>title<span class="type-signature"></span></h4>
+<h4 class="name" id="title"><span class="type-signature"></span>title<span class="type-signature"> :string</span></h4>
 
 
 
@@ -816,11 +869,14 @@ be returned.</p>
 
 <dl class="details">
     
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The page's title. Values are coerced to strings with <code>String(title)</code>.</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line109">line 109</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line102">line 102</a>
     </li></ul></dd>
     
 
@@ -859,16 +915,31 @@ be returned.</p>
 
 
 
+<div class="description usertext">
+    <p>The page's title. Values are coerced to strings with <code>String(title)</code>.</p>
+</div>
 
 
 
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">string</span>
+
+
+
+        </li>
+    </ul>
+
+
 
 
 
 
         
             
-<h4 class="name" id="topLevelHeadings"><span class="type-signature"></span>topLevelHeadings<span class="type-signature"></span></h4>
+<h4 class="name" id="topLevelHeadings"><span class="type-signature type-signature-readonly">(readonly) </span>topLevelHeadings<span class="type-signature"> :Array.&lt;string></span></h4>
 
 
 
@@ -883,7 +954,7 @@ be returned.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line137">line 137</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line135">line 135</a>
     </li></ul></dd>
     
 
@@ -928,65 +999,16 @@ be returned.</p>
 
 
 
-
-
-
-
-
-        
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
             
-<h4 class="name" id="uri"><span class="type-signature"></span>uri<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="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line79">line 79</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
+<span class="param-type">Array.&lt;string></span>
 
 
 
+        </li>
+    </ul>
 
 
 
@@ -995,7 +1017,7 @@ be returned.</p>
 
         
             
-<h4 class="name" id="url"><span class="type-signature"></span>url<span class="type-signature"></span></h4>
+<h4 class="name" id="uri"><span class="type-signature type-signature-readonly">(readonly) </span>uri<span class="type-signature"> :<a href="module-urijs.html">module:urijs</a></span></h4>
 
 
 
@@ -1007,7 +1029,7 @@ be returned.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line63">line 63</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line76">line 76</a>
     </li></ul></dd>
     
 
@@ -1048,6 +1070,17 @@ be returned.</p>
 
 
 
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type"><a href="module-urijs.html">module:urijs</a></span>
+
+
+
+        </li>
+    </ul>
+
 
 
 
@@ -1055,7 +1088,7 @@ be returned.</p>
 
         
             
-<h4 class="name" id="url"><span class="type-signature"></span>url<span class="type-signature"></span></h4>
+<h4 class="name" id="url"><span class="type-signature"></span>url<span class="type-signature"> :string</span></h4>
 
 
 
@@ -1067,7 +1100,7 @@ be returned.</p>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line72">line 72</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line65">line 65</a>
     </li></ul></dd>
     
 
@@ -1108,6 +1141,17 @@ be returned.</p>
 
 
 
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">string</span>
+
+
+
+        </li>
+    </ul>
+
 
 
 
@@ -1124,7 +1168,7 @@ be returned.</p>
 
     
 
-    <h4 class="name" id="addSecondaryHeading"><span class="type-signature"></span>addSecondaryHeading<span class="signature">(h2Text)</span><span class="type-signature"> &rarr; {PageData}</span></h4>
+    <h4 class="name" id="addSecondaryHeading"><span class="type-signature"></span>addSecondaryHeading<span class="signature">(h2Text)</span><span class="type-signature"> &rarr; {<a href="module-page-data.PageData.html">module:page-data.PageData</a>}</span></h4>
 
     
 
@@ -1255,7 +1299,7 @@ be returned.</p>
 
         
 <div class="param-desc">
-    <p>A reference to self to
+    <p>A reference to self to 
 facilitate function chaning.</p>
 </div>
 
@@ -1267,7 +1311,7 @@ facilitate function chaning.</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>
 
 
 
@@ -1283,7 +1327,7 @@ facilitate function chaning.</p>
 
     
 
-    <h4 class="name" id="addTopLevelHeading"><span class="type-signature"></span>addTopLevelHeading<span class="signature">(h1Text)</span><span class="type-signature"> &rarr; {PageData}</span></h4>
+    <h4 class="name" id="addTopLevelHeading"><span class="type-signature"></span>addTopLevelHeading<span class="signature">(h1Text)</span><span class="type-signature"> &rarr; {<a href="module-page-data.PageData.html">module:page-data.PageData</a>}</span></h4>
 
     
 
@@ -1414,7 +1458,7 @@ facilitate function chaning.</p>
 
         
 <div class="param-desc">
-    <p>A reference to self to
+    <p>A reference to self to 
 facilitate function chaning.</p>
 </div>
 
@@ -1426,7 +1470,7 @@ facilitate function chaning.</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>
 
 
 
@@ -1442,7 +1486,7 @@ facilitate function chaning.</p>
 
     
 
-    <h4 class="name" id="asPlainObject"><span class="type-signature"></span>asPlainObject<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
+    <h4 class="name" id="asPlainObject"><span class="type-signature"></span>asPlainObject<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#plainPageInformationObject">plainPageInformationObject</a>}</span></h4>
 
     
 
@@ -1452,28 +1496,13 @@ facilitate function chaning.</p>
 <dl class="details">
     
     <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li><p>Get the page data as a plain object of the form:</p>
-<pre class="prettyprint source"><code>{
-    url: 'http://www.bartificer.net/',
-    title: 'the page title',
-    topLevelHeadings: [ 'first h1', 'second h1' ],
-    secondaryHeadings: [ 'first h2', 'second h2' ],
-    mainHeading: 'first h1',
-    uri: {
-        hostname: 'www.bartificer.net',
-        path: '/',
-        hasPath: false
-    }
-}
-</code></pre>
-<p>Note that the <code>uri</code> could contain more fields - it's initialised with
-output from the <code>URI.parse()</code> function from the <code>URI</code> module.</p></li></ul></dd>
+    <dd class="tag-description"><ul class="dummy"><li><p>Get the page data as a plain object.</p></li></ul></dd>
     
 
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line241">line 241</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line222">line 222</a>
     </li></ul></dd>
     
 
@@ -1503,13 +1532,6 @@ output from the <code>URI.parse()</code> function from the <code>URI</code> modu
 
     
 
-    
-    <dt class="tag-see">See:</dt>
-    <dd class="tag-see">
-        <ul>
-            <li><a href="https://medialize.github.io/URI.js/docs.html#static-parse">https://medialize.github.io/URI.js/docs.html#static-parse</a></li>
-        </ul>
-    </dd>
     
 
     
@@ -1544,10 +1566,6 @@ output from the <code>URI.parse()</code> function from the <code>URI</code> modu
 <h5 class="h5-returns">Returns:</h5>
 
         
-<div class="param-desc">
-    <p>A plain object containing the page data.</p>
-</div>
-
 
 
 <dl class="param-type">
@@ -1556,7 +1574,7 @@ output from the <code>URI.parse()</code> function from the <code>URI</code> modu
     </dt>
     <dd>
         
-<span class="param-type">Object</span>
+<span class="param-type"><a href="global.html#plainPageInformationObject">plainPageInformationObject</a></span>
 
 
 
@@ -1588,7 +1606,7 @@ output from the <code>URI.parse()</code> function from the <code>URI</code> modu
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line262">line 262</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line236">line 236</a>
     </li></ul></dd>
     
 
@@ -1622,7 +1640,7 @@ output from the <code>URI.parse()</code> function from the <code>URI</code> modu
     <dt class="tag-see">See:</dt>
     <dd class="tag-see">
         <ul>
-            <li>PageData#addTopLevelHeading</li>
+            <li><a href="module-page-data.PageData.html#addTopLevelHeading">module:page-data.PageData#addTopLevelHeading</a></li>
         </ul>
     </dd>
     
@@ -1680,7 +1698,7 @@ output from the <code>URI.parse()</code> function from the <code>URI</code> modu
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line271">line 271</a>
+        <a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line245">line 245</a>
     </li></ul></dd>
     
 
@@ -1714,7 +1732,7 @@ output from the <code>URI.parse()</code> function from the <code>URI</code> modu
     <dt class="tag-see">See:</dt>
     <dd class="tag-see">
         <ul>
-            <li>PageData#addSecondaryHeading</li>
+            <li><a href="module-page-data.PageData.html#addSecondaryHeading">module:page-data.PageData#addSecondaryHeading</a></li>
         </ul>
     </dd>
     
@@ -1771,7 +1789,7 @@ output from the <code>URI.parse()</code> function from the <code>URI</code> modu
 <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>
@@ -1784,5 +1802,9 @@ output from the <code>URI.parse()</code> function from the <code>URI</code> modu
 
     <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>