@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.
- 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/index.html
CHANGED
|
@@ -1,7 +1,92 @@
|
|
|
1
|
-
<!DOCTYPE html
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
|
|
5
|
+
<meta charset="utf-8">
|
|
6
|
+
<title>Home - @bartificer/linkify Documentation</title>
|
|
7
|
+
|
|
8
|
+
<meta name="description" content="Documentation for the @bartificer/linkify package" />
|
|
9
|
+
|
|
10
|
+
<meta name="keywords" content="documentation, linkify, link, template, javascript, generator, npm, module, package" />
|
|
11
|
+
<meta name="keyword" content="documentation, linkify, link, template, javascript, generator, npm, module, package" />
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
<meta property="og:title" content="@bartificer/linkify"/>
|
|
16
|
+
<meta property="og:type" content="website"/>
|
|
17
|
+
<meta property="og:image" content=""/>
|
|
18
|
+
<meta property="og:site_name" content="@bartificer/linkify Documentation"/>
|
|
19
|
+
<meta property="og:url" content="https://bartificer.github.io/linkify/"/>
|
|
20
|
+
|
|
21
|
+
<script src="scripts/prettify/prettify.js"></script>
|
|
22
|
+
<script src="scripts/prettify/lang-css.js"></script>
|
|
23
|
+
<!--[if lt IE 9]>
|
|
24
|
+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
25
|
+
<![endif]-->
|
|
26
|
+
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
|
27
|
+
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
|
28
|
+
<script src="scripts/nav.js" defer></script>
|
|
29
|
+
|
|
30
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
31
|
+
</head>
|
|
32
|
+
<body>
|
|
33
|
+
|
|
34
|
+
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
|
35
|
+
<label for="nav-trigger" class="navicon-button x">
|
|
36
|
+
<div class="navicon"></div>
|
|
37
|
+
</label>
|
|
38
|
+
|
|
39
|
+
<label for="nav-trigger" class="overlay"></label>
|
|
40
|
+
|
|
41
|
+
<nav class="wrap">
|
|
42
|
+
|
|
43
|
+
<input type="text" id="nav-search" placeholder="Search" />
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<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>
|
|
47
|
+
|
|
48
|
+
</nav>
|
|
49
|
+
|
|
50
|
+
<div id="main">
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<section class="package">
|
|
61
|
+
<h3> </h3>
|
|
62
|
+
</section>
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<section class="readme usertext">
|
|
77
|
+
<article><h1 id="linkify-from-bartificer-creations"><code>linkify</code> from Bartificer Creations</h1>
|
|
78
|
+
<p>An MIT-licensed ES6 Javascript module for generating links in any format from a URL.</p>
|
|
79
|
+
<p>This code was written by <a href="https://www.lets-talk.ie/contributor/bart">Bart Busschots</a> to speed up the creation of shownotes for the <a href="https://www.lets-talk.ie/lta">Let's Talk Apple</a> and the <a href="https://www.podfeet.com/blog/category/security-bits/">Security Bits</a> segments on the <a href="https://www.podfeet.com/blog/category/nosillacast/">NosillaCast</a>. It is released open-source as a courtesy to other podcasters and bloggers who regularly need to covert URLs into nicely formatted links.</p>
|
|
80
|
+
<p>Pull requests and issues are welcomed, but on the understanding that this is a volunteer-maintained package, and all responses will be at the maintainer's discression as and when they have time. Realistically, you won't hear back from days or weeks, and if life is very hectic, perhaps even months.</p>
|
|
81
|
+
<p>Given this reality, <strong>do not use this repository for anything mission-critical!</strong>.</p>
|
|
82
|
+
<h2 id="instalation">Instalation</h2>
|
|
83
|
+
<pre class="prettyprint source lang-sh"><code>npm install '@bartificer/linkifier';
|
|
84
|
+
</code></pre>
|
|
85
|
+
<h2 id="examples">Examples</h2>
|
|
86
|
+
<p>This is an ES6 module, so when used with NPM, your scripts must have the <code>.mjs</code> file extension (to force ES module mode).</p>
|
|
87
|
+
<h3 id="generate-a-link-from-a-url-using-all-the-defaults">Generate a Link from a URL Using all the Defaults</h3>
|
|
88
|
+
<p>Create a file named <code>demo.mjs</code> with the following content:</p>
|
|
89
|
+
<pre class="prettyprint source lang-javascript"><code>// import the linkify module
|
|
5
90
|
import linkify from '@bartificer/linkify';
|
|
6
91
|
|
|
7
92
|
// generate a link from a URL using the default template
|
|
@@ -9,8 +94,13 @@ import linkify from '@bartificer/linkify';
|
|
|
9
94
|
let link = await linkify.generateLink('https://pbs.bartificer.net/pbs128');
|
|
10
95
|
console.log(link);
|
|
11
96
|
})();
|
|
12
|
-
</code></pre
|
|
13
|
-
|
|
97
|
+
</code></pre>
|
|
98
|
+
<p>Execute the script with <code>node</code>:</p>
|
|
99
|
+
<pre class="prettyprint source lang-sh"><code>node demo.mjs
|
|
100
|
+
</code></pre>
|
|
101
|
+
<h3 id="using-the-bundled-templates">Using the Bundled Templates</h3>
|
|
102
|
+
<p>The following demo code will generate a link using each of the bundled link templates:</p>
|
|
103
|
+
<pre class="prettyprint source lang-javascript"><code>// import the linkify module
|
|
14
104
|
import linkify from '@bartificer/linkify';
|
|
15
105
|
|
|
16
106
|
// get a list of all registered template names
|
|
@@ -25,4 +115,837 @@ console.log('registered templates:', templateNames);
|
|
|
25
115
|
console.log(`- ${templateName}: ${link}`);
|
|
26
116
|
}
|
|
27
117
|
})();
|
|
28
|
-
</code></pre
|
|
118
|
+
</code></pre>
|
|
119
|
+
<h3 id="real-world-examples">Real-World Examples</h3>
|
|
120
|
+
<p>Two real-world scripts Bart users to build shownotes are included in <a href="https://github.com/bartificer/linkify/tree/master/example">the <code>/example</code> folder in the GitHub repostitory</a>:</p>
|
|
121
|
+
<ol>
|
|
122
|
+
<li><code>clipboardURLToMarkdown.mjs</code> — the script Bart uses to convert links to Markdown for use in show notes. This script contains a real-world example of a custom template, and, of a large collection of custom transformers registered against specific domain names for dealing with their various quirks.</li>
|
|
123
|
+
<li><code>debugClipboardURL.mjs</code> — the script Bart uses to help develop custom transformers for any sites that need them.</li>
|
|
124
|
+
</ol></article>
|
|
125
|
+
</section>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
<section>
|
|
136
|
+
|
|
137
|
+
<header>
|
|
138
|
+
|
|
139
|
+
<h2>
|
|
140
|
+
|
|
141
|
+
LinkData.class.mjs
|
|
142
|
+
|
|
143
|
+
</h2>
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</header>
|
|
147
|
+
|
|
148
|
+
<article>
|
|
149
|
+
|
|
150
|
+
<div class="container-overview">
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<dl class="details">
|
|
155
|
+
|
|
156
|
+
<dt class="tag-description">Description:</dt>
|
|
157
|
+
<dd class="tag-description"><ul class="dummy"><li><p>The definition of the class representing a link.</p></li></ul></dd>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<dt class="tag-source">Source:</dt>
|
|
162
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
163
|
+
<a href="LinkData.class.mjs.html">LinkData.class.mjs</a>, <a href="LinkData.class.mjs.html#line1">line 1</a>
|
|
164
|
+
</li></ul></dd>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
<dt class="tag-author">Author:</dt>
|
|
185
|
+
<dd class="tag-author">
|
|
186
|
+
<ul>
|
|
187
|
+
<li><a href="mailto:opensource@bartificer.ie">Bart Busschots</a></li>
|
|
188
|
+
</ul>
|
|
189
|
+
</dd>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
<dt class="tag-license">License:</dt>
|
|
196
|
+
<dd class="tag-license"><ul class="dummy"><li>MIT</li></ul></dd>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
</dl>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<div class="description usertext"><p>The definition of the class representing a link.</p></div>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
</div>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
</article>
|
|
240
|
+
|
|
241
|
+
</section>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<section>
|
|
250
|
+
|
|
251
|
+
<header>
|
|
252
|
+
|
|
253
|
+
<h2>
|
|
254
|
+
|
|
255
|
+
LinkTemplate.class.mjs
|
|
256
|
+
|
|
257
|
+
</h2>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
</header>
|
|
261
|
+
|
|
262
|
+
<article>
|
|
263
|
+
|
|
264
|
+
<div class="container-overview">
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
<dl class="details">
|
|
269
|
+
|
|
270
|
+
<dt class="tag-description">Description:</dt>
|
|
271
|
+
<dd class="tag-description"><ul class="dummy"><li><p>The definition of the class representing a link generation template.</p></li></ul></dd>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<dt class="tag-source">Source:</dt>
|
|
276
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
277
|
+
<a href="LinkTemplate.class.mjs.html">LinkTemplate.class.mjs</a>, <a href="LinkTemplate.class.mjs.html#line1">line 1</a>
|
|
278
|
+
</li></ul></dd>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<dt class="tag-author">Author:</dt>
|
|
299
|
+
<dd class="tag-author">
|
|
300
|
+
<ul>
|
|
301
|
+
<li><a href="mailto:opensource@bartificer.ie">Bart Busschots</a></li>
|
|
302
|
+
</ul>
|
|
303
|
+
</dd>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<dt class="tag-license">License:</dt>
|
|
310
|
+
<dd class="tag-license"><ul class="dummy"><li>MIT</li></ul></dd>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
</dl>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<div class="description usertext"><p>The definition of the class representing a link generation template.</p></div>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
</div>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
</article>
|
|
354
|
+
|
|
355
|
+
</section>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
<section>
|
|
364
|
+
|
|
365
|
+
<header>
|
|
366
|
+
|
|
367
|
+
<h2>
|
|
368
|
+
|
|
369
|
+
Linkifier.class.mjs
|
|
370
|
+
|
|
371
|
+
</h2>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
</header>
|
|
375
|
+
|
|
376
|
+
<article>
|
|
377
|
+
|
|
378
|
+
<div class="container-overview">
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<dl class="details">
|
|
383
|
+
|
|
384
|
+
<dt class="tag-description">Description:</dt>
|
|
385
|
+
<dd class="tag-description"><ul class="dummy"><li><p>The definition of the main Linkifier class which provides the link rendering functionality with the help of the other classes and modules.</p></li></ul></dd>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
<dt class="tag-source">Source:</dt>
|
|
390
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
391
|
+
<a href="Linkifier.class.mjs.html">Linkifier.class.mjs</a>, <a href="Linkifier.class.mjs.html#line1">line 1</a>
|
|
392
|
+
</li></ul></dd>
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
<dt class="tag-author">Author:</dt>
|
|
413
|
+
<dd class="tag-author">
|
|
414
|
+
<ul>
|
|
415
|
+
<li><a href="mailto:opensource@bartificer.ie">Bart Busschots</a></li>
|
|
416
|
+
</ul>
|
|
417
|
+
</dd>
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<dt class="tag-license">License:</dt>
|
|
424
|
+
<dd class="tag-license"><ul class="dummy"><li>MIT</li></ul></dd>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
</dl>
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<div class="description usertext"><p>The definition of the main Linkifier class which provides the link rendering functionality with the help of the other classes and modules.</p></div>
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
</div>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
</article>
|
|
468
|
+
|
|
469
|
+
</section>
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
<section>
|
|
478
|
+
|
|
479
|
+
<header>
|
|
480
|
+
|
|
481
|
+
<h2>
|
|
482
|
+
|
|
483
|
+
PageData.class.mjs
|
|
484
|
+
|
|
485
|
+
</h2>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
</header>
|
|
489
|
+
|
|
490
|
+
<article>
|
|
491
|
+
|
|
492
|
+
<div class="container-overview">
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
<dl class="details">
|
|
497
|
+
|
|
498
|
+
<dt class="tag-description">Description:</dt>
|
|
499
|
+
<dd class="tag-description"><ul class="dummy"><li><p>The definition of the class representing a web page.</p></li></ul></dd>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
<dt class="tag-source">Source:</dt>
|
|
504
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
505
|
+
<a href="PageData.class.mjs.html">PageData.class.mjs</a>, <a href="PageData.class.mjs.html#line1">line 1</a>
|
|
506
|
+
</li></ul></dd>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
<dt class="tag-author">Author:</dt>
|
|
527
|
+
<dd class="tag-author">
|
|
528
|
+
<ul>
|
|
529
|
+
<li><a href="mailto:opensource@bartificer.ie">Bart Busschots</a></li>
|
|
530
|
+
</ul>
|
|
531
|
+
</dd>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
<dt class="tag-license">License:</dt>
|
|
538
|
+
<dd class="tag-license"><ul class="dummy"><li>MIT</li></ul></dd>
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
</dl>
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
<div class="description usertext"><p>The definition of the class representing a web page.</p></div>
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
</div>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
</article>
|
|
582
|
+
|
|
583
|
+
</section>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
<section>
|
|
592
|
+
|
|
593
|
+
<header>
|
|
594
|
+
|
|
595
|
+
<h2>
|
|
596
|
+
|
|
597
|
+
defaults.mjs
|
|
598
|
+
|
|
599
|
+
</h2>
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
</header>
|
|
603
|
+
|
|
604
|
+
<article>
|
|
605
|
+
|
|
606
|
+
<div class="container-overview">
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
<dl class="details">
|
|
611
|
+
|
|
612
|
+
<dt class="tag-description">Description:</dt>
|
|
613
|
+
<dd class="tag-description"><ul class="dummy"><li><p>Central location for the default values used throughout the codebase.</p></li></ul></dd>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
<dt class="tag-source">Source:</dt>
|
|
618
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
619
|
+
<a href="defaults.mjs.html">defaults.mjs</a>, <a href="defaults.mjs.html#line1">line 1</a>
|
|
620
|
+
</li></ul></dd>
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
<dt class="tag-author">Author:</dt>
|
|
641
|
+
<dd class="tag-author">
|
|
642
|
+
<ul>
|
|
643
|
+
<li><a href="mailto:opensource@bartificer.ie">Bart Busschots</a></li>
|
|
644
|
+
</ul>
|
|
645
|
+
</dd>
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
<dt class="tag-license">License:</dt>
|
|
652
|
+
<dd class="tag-license"><ul class="dummy"><li>MIT</li></ul></dd>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
</dl>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
<div class="description usertext"><p>Central location for the default values used throughout the codebase.</p></div>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
</div>
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
</article>
|
|
696
|
+
|
|
697
|
+
</section>
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
<section>
|
|
706
|
+
|
|
707
|
+
<header>
|
|
708
|
+
|
|
709
|
+
<h2>
|
|
710
|
+
|
|
711
|
+
index.js
|
|
712
|
+
|
|
713
|
+
</h2>
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
</header>
|
|
717
|
+
|
|
718
|
+
<article>
|
|
719
|
+
|
|
720
|
+
<div class="container-overview">
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
<dl class="details">
|
|
725
|
+
|
|
726
|
+
<dt class="tag-description">Description:</dt>
|
|
727
|
+
<dd class="tag-description"><ul class="dummy"><li><p>Defines the public interface for the published module.</p></li></ul></dd>
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
<dt class="tag-source">Source:</dt>
|
|
732
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
733
|
+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1">line 1</a>
|
|
734
|
+
</li></ul></dd>
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
<dt class="tag-author">Author:</dt>
|
|
755
|
+
<dd class="tag-author">
|
|
756
|
+
<ul>
|
|
757
|
+
<li><a href="mailto:opensource@bartificer.ie">Bart Busschots</a></li>
|
|
758
|
+
</ul>
|
|
759
|
+
</dd>
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
<dt class="tag-license">License:</dt>
|
|
766
|
+
<dd class="tag-license"><ul class="dummy"><li>MIT</li></ul></dd>
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
</dl>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
<div class="description usertext"><p>Defines the public interface for the published module.</p></div>
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
</div>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
</article>
|
|
810
|
+
|
|
811
|
+
</section>
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
<section>
|
|
820
|
+
|
|
821
|
+
<header>
|
|
822
|
+
|
|
823
|
+
<h2>
|
|
824
|
+
|
|
825
|
+
utilities.mjs
|
|
826
|
+
|
|
827
|
+
</h2>
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
</header>
|
|
831
|
+
|
|
832
|
+
<article>
|
|
833
|
+
|
|
834
|
+
<div class="container-overview">
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
<dl class="details">
|
|
839
|
+
|
|
840
|
+
<dt class="tag-description">Description:</dt>
|
|
841
|
+
<dd class="tag-description"><ul class="dummy"><li><p>A collection of useful utility functions.</p></li></ul></dd>
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
<dt class="tag-source">Source:</dt>
|
|
846
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
847
|
+
<a href="utilities.mjs.html">utilities.mjs</a>, <a href="utilities.mjs.html#line1">line 1</a>
|
|
848
|
+
</li></ul></dd>
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
<dt class="tag-author">Author:</dt>
|
|
869
|
+
<dd class="tag-author">
|
|
870
|
+
<ul>
|
|
871
|
+
<li><a href="mailto:opensource@bartificer.ie">Bart Busschots</a></li>
|
|
872
|
+
</ul>
|
|
873
|
+
</dd>
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
<dt class="tag-license">License:</dt>
|
|
880
|
+
<dd class="tag-license"><ul class="dummy"><li>MIT</li></ul></dd>
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
</dl>
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
<div class="description usertext"><p>A collection of useful utility functions.</p></div>
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
</div>
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
</article>
|
|
924
|
+
|
|
925
|
+
</section>
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
</div>
|
|
933
|
+
|
|
934
|
+
<br class="clear">
|
|
935
|
+
|
|
936
|
+
<footer>
|
|
937
|
+
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.
|
|
938
|
+
</footer>
|
|
939
|
+
|
|
940
|
+
<script>prettyPrint();</script>
|
|
941
|
+
<script src="scripts/polyfill.js"></script>
|
|
942
|
+
<script src="scripts/linenumber.js"></script>
|
|
943
|
+
|
|
944
|
+
<script src="scripts/search.js" defer></script>
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
<link type="text/css" rel="stylesheet" href="./docdash-overrides.css">
|
|
949
|
+
|
|
950
|
+
</body>
|
|
951
|
+
</html>
|