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

@bartificer/linkify 2.3.5 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (97) hide show

package/dist/index.js +1 -1
package/docs/LinkData.class.mjs.html +93 -5
package/docs/LinkTemplate.class.mjs.html +93 -5
package/docs/Linkifier.class.mjs.html +99 -11
package/docs/PageData.class.mjs.html +93 -5
package/docs/defaults.mjs.html +116 -12
package/docs/docdash-overrides.css +5 -0
package/docs/externals.jsdoc.html +91 -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/index.html +930 -7
package/docs/index.js.html +139 -17
package/docs/module-cheerio.html +189 -3
package/docs/module-defaults.html +585 -3
package/docs/module-link-data.LinkData.html +944 -0
package/docs/module-link-data.html +222 -0
package/docs/module-link-template.LinkTemplate.html +817 -0
package/docs/module-link-template.html +222 -0
package/docs/module-linkifier.Linkifier.html +2323 -0
package/docs/module-linkifier.html +232 -0
package/docs/module-linkify.html +806 -3
package/docs/module-mustache.html +189 -3
package/docs/module-node-fetch.html +189 -3
package/docs/module-page-data.PageData.html +1788 -0
package/docs/module-page-data.html +222 -0
package/docs/module-title-case.html +189 -3
package/docs/module-urijs.html +189 -3
package/docs/module-url-slug.html +189 -3
package/docs/module-utilities.html +1468 -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/utilities.mjs.html +124 -5
package/examples/clipboardURLToMarkdown.mjs +80 -1
package/package.json +3 -2
package/src/LinkData.class.mjs +2 -1
package/src/LinkTemplate.class.mjs +2 -1
package/src/Linkifier.class.mjs +8 -7
package/src/PageData.class.mjs +2 -1
package/src/defaults.mjs +26 -8
package/src/index.js +48 -13
package/src/utilities.mjs +33 -1
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-page-data.PageData.html ADDED Viewed

@@ -0,0 +1,1788 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>PageData - @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></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>
+</nav>
+<div id="main">
+    <h1 class="page-title">PageData</h1>
+<section>
+<header>
+        <h2>
+            <span class="ancestors"><a href="module-page-data.html">page-data</a>.</span>
+            PageData
+        </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>
+</header>
+<article>
+        <div class="container-overview">
+    <h2>Constructor</h2>
+    <h4 class="name" id="PageData"><span class="type-signature"></span>new PageData<span class="signature">(url)</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>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>
+    </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">URL</span>
+            </td>
+            <td class="description last"><p>The page's full URL.</p></td>
+        </tr>
+    </tbody>
+</table>
+<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>
+        </div>
+        <h3 class="subsection-title">Members</h3>
+<h4 class="name" id="domain"><span class="type-signature"></span>domain<span class="type-signature"></span></h4>
+<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>
+    <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>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>Get the domain-part of the URL as a string.</p>
+</div>
+<h4 class="name" id="h1s"><span class="type-signature"></span>h1s<span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>An alias for <code>.topLevelHeadings</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#line149">line 149</a>
+    </li></ul></dd>
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li>PageData#topLevelHeadings</li>
+        </ul>
+    </dd>
+</dl>
+<div class="description usertext">
+    <p>An alias for <code>.topLevelHeadings</code>.</p>
+</div>
+<h4 class="name" id="h2s"><span class="type-signature"></span>h2s<span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>An alias for <code>.secondaryHeadings</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#line170">line 170</a>
+    </li></ul></dd>
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li>PageData#secondaryHeadings</li>
+        </ul>
+    </dd>
+</dl>
+<div class="description usertext">
+    <p>An alias for <code>.secondaryHeadings</code>.</p>
+</div>
+<h4 class="name" id="headings"><span class="type-signature"></span>headings<span class="type-signature"></span></h4>
+<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>
+    <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>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>Get the page's section headings.</p>
+</div>
+<h4 class="name" id="mainHeading"><span class="type-signature"></span>mainHeading<span class="type-signature"></span></h4>
+<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>
+</dl>
+<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>
+<h4 class="name" id="path"><span class="type-signature"></span>path<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#line95">line 95</a>
+    </li></ul></dd>
+</dl>
+<h4 class="name" id="secondaryHeadings"><span class="type-signature"></span>secondaryHeadings<span class="type-signature"></span></h4>
+<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#line158">line 158</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>The page's secondary headings (<code>h2</code> tags).</p>
+</div>
+<h4 class="name" id="title"><span class="type-signature"></span>title<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#line102">line 102</a>
+    </li></ul></dd>
+</dl>
+<h4 class="name" id="title"><span class="type-signature"></span>title<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#line109">line 109</a>
+    </li></ul></dd>
+</dl>
+<h4 class="name" id="topLevelHeadings"><span class="type-signature"></span>topLevelHeadings<span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The page's top-level headings (<code>h1</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#line137">line 137</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>The page's top-level headings (<code>h1</code> tags).</p>
+</div>
+<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>
+<h4 class="name" id="url"><span class="type-signature"></span>url<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#line63">line 63</a>
+    </li></ul></dd>
+</dl>
+<h4 class="name" id="url"><span class="type-signature"></span>url<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#line72">line 72</a>
+    </li></ul></dd>
+</dl>
+        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id="addSecondaryHeading"><span class="type-signature"></span>addSecondaryHeading<span class="signature">(h2Text)</span><span class="type-signature"> &rarr; {PageData}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Add a seconary heading.</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#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>h2Text</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>
+<div class="param-desc">
+    <p>A reference to self to
+facilitate function chaning.</p>
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">PageData</span>
+    </dd>
+</dl>
+    <h4 class="name" id="addTopLevelHeading"><span class="type-signature"></span>addTopLevelHeading<span class="signature">(h1Text)</span><span class="type-signature"> &rarr; {PageData}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Add a top-level heading.</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#line199">line 199</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>h1Text</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>
+<div class="param-desc">
+    <p>A reference to self to
+facilitate function chaning.</p>
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">PageData</span>
+    </dd>
+</dl>
+    <h4 class="name" id="asPlainObject"><span class="type-signature"></span>asPlainObject<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
+<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>
+    <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>
+    </li></ul></dd>
+    <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>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    <p>A plain object containing the page data.</p>
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="h1"><span class="type-signature"></span>h1<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>A shortcut for <code>.addTopLevelHeading()</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#line262">line 262</a>
+    </li></ul></dd>
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li>PageData#addTopLevelHeading</li>
+        </ul>
+    </dd>
+</dl>
+    <h4 class="name" id="h2"><span class="type-signature"></span>h2<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>A shortcut for <code>.addSecondaryHeading()</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#line271">line 271</a>
+    </li></ul></dd>
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li>PageData#addSecondaryHeading</li>
+        </ul>
+    </dd>
+</dl>
+</article>
+</section>
+</div>
+<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.
+</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">
+</body>
+</html>