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

@bartificer/linkify 2.3.4 → 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 +121 -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 +130 -29
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 +31 -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-link-template.LinkTemplate.html ADDED Viewed

@@ -0,0 +1,817 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>LinkTemplate - @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">LinkTemplate</h1>
+<section>
+<header>
+        <h2>
+            <span class="ancestors"><a href="module-link-template.html">link-template</a>.</span>
+            LinkTemplate
+        </h2>
+            <div class="class-description usertext"><p>A class representing the a template that can be used to render links.</p></div>
+</header>
+<article>
+        <div class="container-overview">
+    <h2>Constructor</h2>
+    <h4 class="name" id="LinkTemplate"><span class="type-signature"></span>new LinkTemplate<span class="signature">(templateString, filters<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="LinkTemplate.class.mjs.html">LinkTemplate.class.mjs</a>, <a href="LinkTemplate.class.mjs.html#line16">line 16</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>templateString</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>A Moustache template string.</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>filters</code></td>
+            <td class="type">
+<span class="param-type">Array</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                    <code>[]</code>
+                </td>
+            <td class="description last"><p>An optional array of filter functions.
+Each element in the array should itself be an array where the first
+element is a string specifying which fields the filter should be applied
+to (one of <code>'all'</code>, <code>'url'</code>, <code>'text'</code>, or <code>'description'</code>), and the
+second the filter function itself which should be a function that takes
+a single string as an argument and returns a filtered version of that
+string.</p></td>
+        </tr>
+    </tbody>
+</table>
+        </div>
+        <h3 class="subsection-title">Members</h3>
+<h4 class="name" id="templateString"><span class="type-signature"></span>templateString<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 template string.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="LinkTemplate.class.mjs.html">LinkTemplate.class.mjs</a>, <a href="LinkTemplate.class.mjs.html#line70">line 70</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>Get the template string.</p>
+</div>
+<h4 class="name" id="templateString"><span class="type-signature"></span>templateString<span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Set the template string. Should be in Mustache format. All values passed
+will be coerced to strings.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="LinkTemplate.class.mjs.html">LinkTemplate.class.mjs</a>, <a href="LinkTemplate.class.mjs.html#line80">line 80</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    <p>Set the template string. Should be in Mustache format. All values passed
+will be coerced to strings.</p>
+</div>
+        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id="addFilter"><span class="type-signature"></span>addFilter<span class="signature">(fieldName, filterFn)</span><span class="type-signature"> &rarr; {LinkTemplate}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Add a filter to be applied to one or all fields.</p>
+<p>If an invalid args are passed, the function does not save the filter or
+throw an error, but it does log a warning.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="LinkTemplate.class.mjs.html">LinkTemplate.class.mjs</a>, <a href="LinkTemplate.class.mjs.html#line95">line 95</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>fieldName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>One of <code>'all'</code>, <code>'url'</code>, <code>'text'</code>, or
+<code>'description'</code>.</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>filterFn</code></td>
+            <td class="type">
+<span class="param-type">function</span>
+            </td>
+            <td class="description last"><p>the filter function.</p></td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    <p>Returns a reference to self to facilitate function chaining.</p>
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">LinkTemplate</span>
+    </dd>
+</dl>
+    <h4 class="name" id="filtersFor"><span class="type-signature"></span>filtersFor<span class="signature">(fieldName)</span><span class="type-signature"> &rarr; {Array.&lt;function()>}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>A function get the filter functions that should be applied to any given
+field.</p></li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="LinkTemplate.class.mjs.html">LinkTemplate.class.mjs</a>, <a href="LinkTemplate.class.mjs.html#line124">line 124</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>fieldName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last"><p>one of <code>'url'</code>, <code>'text'</code>, or
+<code>'description'</code>.</p></td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    <p>returns an array of callbacks, which may be
+empty. An empty array is returned if an invalid field name is passed.</p>
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Array.&lt;function()></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 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>