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

@bartificer/linkify 2.3.5 → 2.4.1

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

Files changed (102) hide show

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

package/docs/module-link-data.LinkData.html ADDED Viewed

@@ -0,0 +1,813 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>LinkData - @bartificer/linkify Documentation</title>
+    <meta name="description" content="Documentation for the @bartificer/linkify package" />
+        <meta name="keywords" content="documentation, linkify, link, template, javascript, generator, npm, module, package" />
+        <meta name="keyword" content="documentation, linkify, link, template, javascript, generator, npm, module, package" />
+    <meta property="og:title" content="@bartificer/linkify"/>
+    <meta property="og:type" content="website"/>
+    <meta property="og:image" content=""/>
+    <meta property="og:site_name" content="@bartificer/linkify Documentation"/>
+    <meta property="og:url" content="https://bartificer.github.io/linkify/"/>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
+    <script src="scripts/nav.js" defer></script>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+</head>
+<body>
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+<label for="nav-trigger" class="overlay"></label>
+<nav class="wrap">
+    <input type="text" id="nav-search" placeholder="Search" />
+    <h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/bartificer/linkify" target="_blank" >On GitHub</a></h2><h2><a href="https://bartificer.net/" target="_blank" >Bartificer Creations</a></h2><h3>Modules</h3><ul><li><a href="module-defaults.html">defaults</a><ul class='members'><li data-type='member'><a href="module-defaults.html#.linkTemplates">linkTemplates</a></li><li data-type='member'><a href="module-defaults.html#.smallWords">smallWords</a></li><li data-type='member'><a href="module-defaults.html#.speciallyCapitalisedWords">speciallyCapitalisedWords</a></li></ul><ul class='methods'><li data-type='method'><a href="module-defaults.html#.dataTransformer">dataTransformer</a></li></ul></li><li><a href="module-link-data.html">link-data</a></li><li><a href="module-link-template.html">link-template</a></li><li><a href="module-linkifier.html">linkifier</a></li><li><a href="module-linkify.html">linkify</a><ul class='members'><li data-type='member'><a href="module-linkify.html#.LinkData">LinkData</a></li><li data-type='member'><a href="module-linkify.html#.LinkTemplate">LinkTemplate</a></li><li data-type='member'><a href="module-linkify.html#.Linkifier">Linkifier</a></li><li data-type='member'><a href="module-linkify.html#.PageData">PageData</a></li><li data-type='member'><a href="module-linkify.html#.VERSION">VERSION</a></li><li data-type='member'><a href="module-linkify.html#.default">default</a></li><li data-type='member'><a href="module-linkify.html#.linkify">linkify</a></li></ul></li><li><a href="module-page-data.html">page-data</a></li><li><a href="module-utilities.html">utilities</a><ul class='methods'><li data-type='method'><a href="module-utilities.html#.batchFixCustomWordCases">batchFixCustomWordCases</a></li><li data-type='method'><a href="module-utilities.html#.escapeRegex">escapeRegex</a></li><li data-type='method'><a href="module-utilities.html#.extractSlug">extractSlug</a></li><li data-type='method'><a href="module-utilities.html#.regulariseWhitespace">regulariseWhitespace</a></li><li data-type='method'><a href="module-utilities.html#.stripQueryString">stripQueryString</a></li><li data-type='method'><a href="module-utilities.html#.stripUTMParameters">stripUTMParameters</a></li><li data-type='method'><a href="module-utilities.html#.toTitleCase">toTitleCase</a></li></ul></li></ul><h3>Classes</h3><ul><li><a href="module-link-data.LinkData.html">LinkData</a><ul class='methods'><li data-type='method'><a href="module-link-data.LinkData.html#asPlainObject">asPlainObject</a></li></ul></li><li><a href="module-link-template.LinkTemplate.html">LinkTemplate</a><ul class='methods'><li data-type='method'><a href="module-link-template.LinkTemplate.html#addFilter">addFilter</a></li><li data-type='method'><a href="module-link-template.LinkTemplate.html#filtersFor">filtersFor</a></li></ul></li><li><a href="module-linkifier.Linkifier.html">Linkifier</a><ul class='methods'><li data-type='method'><a href="module-linkifier.Linkifier.html#fetchPageData">fetchPageData</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#generateLink">generateLink</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#getTemplate">getTemplate</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#getTemplateNameForDomain">getTemplateNameForDomain</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#getTransformerForDomain">getTransformerForDomain</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#registerDefaultTemplateMapping">registerDefaultTemplateMapping</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#registerTemplate">registerTemplate</a></li><li data-type='method'><a href="module-linkifier.Linkifier.html#registerTransformer">registerTransformer</a></li></ul></li><li><a href="module-page-data.PageData.html">PageData</a><ul class='methods'><li data-type='method'><a href="module-page-data.PageData.html#addSecondaryHeading">addSecondaryHeading</a></li><li data-type='method'><a href="module-page-data.PageData.html#addTopLevelHeading">addTopLevelHeading</a></li><li data-type='method'><a href="module-page-data.PageData.html#asPlainObject">asPlainObject</a></li><li data-type='method'><a href="module-page-data.PageData.html#h1">h1</a></li><li data-type='method'><a href="module-page-data.PageData.html#h2">h2</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#dataTransformer">dataTransformer</a></li><li><a href="global.html#plainLinkInformationObject">plainLinkInformationObject</a></li><li><a href="global.html#plainPageInformationObject">plainPageInformationObject</a></li><li><a href="global.html#templateFieldFilterFunction">templateFieldFilterFunction</a></li><li><a href="global.html#templateFieldFilterTuple">templateFieldFilterTuple</a></li></ul><h3>Externals</h3><ul><li><a href="module-cheerio.html">cheerio</a></li><li><a href="module-mustache.html">mustache</a></li><li><a href="module-node-fetch.html">node-fetch</a></li><li><a href="module-title-case.html">title-case</a></li><li><a href="module-urijs.html">urijs</a></li><li><a href="module-url-slug.html">url-slug</a></li></ul>
+</nav>
+<div id="main">
+    <h1 class="page-title">LinkData</h1>
+<section>
+<header>
+        <h2>
+            <span class="ancestors"><a href="module-link-data.html">link-data</a>.</span>
+            LinkData
+        </h2>
+            <div class="class-description usertext"><p>The information that can be used to render a link.</p>
+<p>Instances of this class are created from the information extracted from web pages by data transformers.</p></div>
+</header>
+<article>
+        <div class="container-overview">
+    <h2>Constructor</h2>
+    <h4 class="name" id="LinkData"><span class="type-signature"></span>new LinkData<span class="signature">(url, text<span class="signature-attributes">opt</span>, description<span class="signature-attributes">opt</span>)</span><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="LinkData.class.mjs.html">LinkData.class.mjs</a>, <a href="LinkData.class.mjs.html#line20">line 20</a>
+    </li></ul></dd>
+    <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 created.</li>
+        </ul>
+    </dd>
+</dl>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>url</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                </td>
+            <td class="description last"><p>The link's URL.</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>text</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last"><p>The link's text, defaults to the URL.</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>description</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last"><p>A description for the link, defaults to the link text.</p></td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        <p>A TypeError 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">TypeError</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+        </div>
+        <h3 class="subsection-title">Members</h3>
+<h4 class="name" id="description"><span class="type-signature"></span>description<span class="type-signature"> :string</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The link description.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="LinkData.class.mjs.html">LinkData.class.mjs</a>, <a href="LinkData.class.mjs.html#line99">line 99</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>The link description.</p>
+</div>
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+<span class="param-type">string</span>
+        </li>
+    </ul>
+<h4 class="name" id="text"><span class="type-signature"></span>text<span class="type-signature"> :string</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The link text.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="LinkData.class.mjs.html">LinkData.class.mjs</a>, <a href="LinkData.class.mjs.html#line88">line 88</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>The link text.</p>
+</div>
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+<span class="param-type">string</span>
+        </li>
+    </ul>
+<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>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The URL the link points to as a URI.js object representing the URL.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="LinkData.class.mjs.html">LinkData.class.mjs</a>, <a href="LinkData.class.mjs.html#line80">line 80</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>The URL the link points to as a URI.js object representing the URL.</p>
+</div>
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+<span class="param-type"><a href="module-urijs.html">module:urijs</a></span>
+        </li>
+    </ul>
+<h4 class="name" id="url"><span class="type-signature"></span>url<span class="type-signature"> :string</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The URL the link points to as a string.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="LinkData.class.mjs.html">LinkData.class.mjs</a>, <a href="LinkData.class.mjs.html#line68">line 68</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>The URL the link points to as a string.</p>
+</div>
+    <h5 class="h5-types">Type:</h5>
+    <ul>
+        <li>
+<span class="param-type">string</span>
+        </li>
+    </ul>
+        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id="asPlainObject"><span class="type-signature"></span>asPlainObject<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#plainLinkInformationObject">plainLinkInformationObject</a>}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>The link data as a plain object for use in Mustache templates and the like.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="LinkData.class.mjs.html">LinkData.class.mjs</a>, <a href="LinkData.class.mjs.html#line110">line 110</a>
+    </li></ul></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    <p>A plain object containing the link data.</p>
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type"><a href="global.html#plainLinkInformationObject">plainLinkInformationObject</a></span>
+    </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 Wed Apr 15 2026 17:49:51 GMT+0100 (Irish Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/polyfill.js"></script>
+<script src="scripts/linenumber.js"></script>
+<script src="scripts/search.js" defer></script>
+    <link type="text/css" rel="stylesheet" href="./docdash-overrides.css">
+    <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+    <script src="./mermaid-init.js"></script>
+</body>
+</html>