@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
  1. package/README.md +135 -35
  2. package/dist/index.js +1 -1
  3. package/docs/LinkData.class.mjs.html +119 -56
  4. package/docs/LinkTemplate.class.mjs.html +120 -36
  5. package/docs/Linkifier.class.mjs.html +141 -66
  6. package/docs/PageData.class.mjs.html +145 -72
  7. package/docs/defaults.mjs.html +136 -12
  8. package/docs/docdash-overrides.css +11 -0
  9. package/docs/externals.jsdoc.html +95 -4
  10. package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  11. package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  12. package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  13. package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  14. package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  15. package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  16. package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  17. package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  18. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  19. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +978 -0
  20. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  21. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  22. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  23. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  24. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +1049 -0
  25. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  26. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  27. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  28. package/docs/global.html +1276 -0
  29. package/docs/index.html +1018 -26
  30. package/docs/index.js.html +143 -17
  31. package/docs/mermaid-init.js +21 -0
  32. package/docs/module-cheerio.html +193 -3
  33. package/docs/module-defaults.html +680 -3
  34. package/docs/module-link-data.LinkData.html +813 -0
  35. package/docs/module-link-data.html +226 -0
  36. package/docs/module-link-template.LinkTemplate.html +792 -0
  37. package/docs/module-link-template.html +226 -0
  38. package/docs/module-linkifier.Linkifier.html +2050 -0
  39. package/docs/module-linkifier.html +236 -0
  40. package/docs/module-linkify.html +810 -3
  41. package/docs/module-mustache.html +193 -3
  42. package/docs/module-node-fetch.html +193 -3
  43. package/docs/module-page-data.PageData.html +1810 -0
  44. package/docs/module-page-data.html +226 -0
  45. package/docs/module-title-case.html +193 -3
  46. package/docs/module-urijs.html +193 -3
  47. package/docs/module-url-slug.html +193 -3
  48. package/docs/module-utilities.html +1518 -3
  49. package/docs/scripts/collapse.js +39 -0
  50. package/docs/scripts/commonNav.js +28 -0
  51. package/docs/scripts/linenumber.js +25 -0
  52. package/docs/scripts/nav.js +12 -0
  53. package/docs/scripts/polyfill.js +4 -0
  54. package/docs/scripts/{third-party → prettify}/Apache-License-2.0.txt +202 -202
  55. package/docs/scripts/prettify/lang-css.js +2 -0
  56. package/docs/scripts/prettify/prettify.js +28 -0
  57. package/docs/scripts/search.js +99 -265
  58. package/docs/styles/jsdoc.css +776 -0
  59. package/docs/styles/prettify.css +80 -0
  60. package/docs/typedefs.jsdoc.html +145 -0
  61. package/docs/utilities.mjs.html +154 -22
  62. package/examples/clipboardURLToMarkdown.mjs +80 -1
  63. package/package.json +5 -3
  64. package/src/LinkData.class.mjs +24 -52
  65. package/src/LinkTemplate.class.mjs +25 -32
  66. package/src/Linkifier.class.mjs +46 -62
  67. package/src/PageData.class.mjs +50 -68
  68. package/src/defaults.mjs +42 -8
  69. package/src/index.js +48 -13
  70. package/src/typedefs.jsdoc +52 -0
  71. package/src/utilities.mjs +59 -18
  72. package/docs/data/search.json +0 -1
  73. package/docs/fonts/Inconsolata-Regular.ttf +0 -0
  74. package/docs/fonts/OpenSans-Regular.ttf +0 -0
  75. package/docs/fonts/WorkSans-Bold.ttf +0 -0
  76. package/docs/module-LinkData.LinkData.html +0 -13
  77. package/docs/module-LinkData.html +0 -3
  78. package/docs/module-LinkTemplate.LinkTemplate.html +0 -3
  79. package/docs/module-LinkTemplate.html +0 -3
  80. package/docs/module-Linkifier.Linkifier.html +0 -3
  81. package/docs/module-Linkifier.html +0 -3
  82. package/docs/module-PageData.PageData.html +0 -15
  83. package/docs/module-PageData.html +0 -3
  84. package/docs/scripts/core.js +0 -726
  85. package/docs/scripts/core.min.js +0 -23
  86. package/docs/scripts/resize.js +0 -90
  87. package/docs/scripts/search.min.js +0 -6
  88. package/docs/scripts/third-party/fuse.js +0 -9
  89. package/docs/scripts/third-party/hljs-line-num-original.js +0 -369
  90. package/docs/scripts/third-party/hljs-line-num.js +0 -1
  91. package/docs/scripts/third-party/hljs-original.js +0 -5171
  92. package/docs/scripts/third-party/hljs.js +0 -1
  93. package/docs/scripts/third-party/popper.js +0 -5
  94. package/docs/scripts/third-party/tippy.js +0 -1
  95. package/docs/scripts/third-party/tocbot.js +0 -672
  96. package/docs/scripts/third-party/tocbot.min.js +0 -1
  97. package/docs/styles/clean-jsdoc-theme-base.css +0 -1159
  98. package/docs/styles/clean-jsdoc-theme-dark.css +0 -412
  99. package/docs/styles/clean-jsdoc-theme-light.css +0 -482
  100. package/docs/styles/clean-jsdoc-theme-scrollbar.css +0 -30
  101. package/docs/styles/clean-jsdoc-theme-without-scrollbar.min.css +0 -1
  102. package/docs/styles/clean-jsdoc-theme.min.css +0 -1
package/docs/module-link-template.LinkTemplate.html ADDED
@@ -0,0 +1,792 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+
5
+ <meta charset="utf-8">
6
+ <title>LinkTemplate - @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><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>
47
+
48
+ </nav>
49
+
50
+ <div id="main">
51
+
52
+ <h1 class="page-title">LinkTemplate</h1>
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+ <section>
61
+
62
+ <header>
63
+
64
+ <h2>
65
+ <span class="ancestors"><a href="module-link-template.html">link-template</a>.</span>
66
+
67
+
68
+ LinkTemplate
69
+
70
+ </h2>
71
+
72
+ <div class="class-description usertext"><p>A class representing the templates used to render link data objects as actual links.</p></div>
73
+
74
+
75
+ </header>
76
+
77
+ <article>
78
+
79
+ <div class="container-overview">
80
+
81
+
82
+
83
+
84
+ <h2>Constructor</h2>
85
+
86
+
87
+ <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>
88
+
89
+
90
+
91
+
92
+
93
+
94
+ <dl class="details">
95
+
96
+
97
+
98
+ <dt class="tag-source">Source:</dt>
99
+ <dd class="tag-source"><ul class="dummy"><li>
100
+ <a href="LinkTemplate.class.mjs.html">LinkTemplate.class.mjs</a>, <a href="LinkTemplate.class.mjs.html#line17">line 17</a>
101
+ </li></ul></dd>
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <dt class="tag-see">See:</dt>
132
+ <dd class="tag-see">
133
+ <ul>
134
+ <li><a href="module-link-data.LinkData.html">module:link-data.LinkData</a> for the data objects that are rendered with these templates.</li>
135
+ </ul>
136
+ </dd>
137
+
138
+
139
+
140
+ </dl>
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <h5 class="h5-examples">Example</h5>
153
+
154
+ <p class="code-caption">Example of defining a template with filters</p>
155
+
156
+ <pre class="prettyprint"><code>let template = new LinkTemplate(
157
+ '&lt;a href="{{{url}}}">{{{text}}}&lt;/a>',
158
+ [
159
+ ['url', linkify.util.stripUTMParameters],
160
+ ['text', linkify.util.regulariseWhitespace]
161
+ ]
162
+ );</code></pre>
163
+
164
+
165
+
166
+
167
+ <h5 class="h5-parameters">Parameters:</h5>
168
+
169
+
170
+ <table class="params">
171
+ <thead>
172
+ <tr>
173
+
174
+ <th>Name</th>
175
+
176
+
177
+ <th>Type</th>
178
+
179
+
180
+ <th>Attributes</th>
181
+
182
+
183
+
184
+ <th>Default</th>
185
+
186
+
187
+ <th class="last">Description</th>
188
+ </tr>
189
+ </thead>
190
+
191
+ <tbody>
192
+
193
+
194
+ <tr>
195
+
196
+ <td class="name"><code>templateString</code></td>
197
+
198
+
199
+ <td class="type">
200
+
201
+
202
+ <span class="param-type">string</span>
203
+
204
+
205
+
206
+
207
+ </td>
208
+
209
+
210
+ <td class="attributes">
211
+
212
+
213
+
214
+
215
+
216
+ </td>
217
+
218
+
219
+
220
+ <td class="default">
221
+
222
+ </td>
223
+
224
+
225
+ <td class="description last"><p>A Moustache template string.</p></td>
226
+ </tr>
227
+
228
+
229
+
230
+ <tr>
231
+
232
+ <td class="name"><code>filters</code></td>
233
+
234
+
235
+ <td class="type">
236
+
237
+
238
+ <span class="param-type">Array.&lt;<a href="global.html#templateFieldFilterTuple">templateFieldFilterTuple</a>></span>
239
+
240
+
241
+
242
+
243
+ </td>
244
+
245
+
246
+ <td class="attributes">
247
+
248
+ &lt;optional><br>
249
+
250
+
251
+
252
+
253
+
254
+ </td>
255
+
256
+
257
+
258
+ <td class="default">
259
+
260
+ <code>[]</code>
261
+
262
+ </td>
263
+
264
+
265
+ <td class="description last"><p>an optional set of filter functions to apply to some or all template fields.</p></td>
266
+ </tr>
267
+
268
+
269
+ </tbody>
270
+ </table>
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+ </div>
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+ <h3 class="subsection-title">Members</h3>
308
+
309
+
310
+
311
+ <h4 class="name" id="templateString"><span class="type-signature"></span>templateString<span class="type-signature"> :string</span></h4>
312
+
313
+
314
+
315
+
316
+
317
+ <dl class="details">
318
+
319
+ <dt class="tag-description">Description:</dt>
320
+ <dd class="tag-description"><ul class="dummy"><li><p>The Mustache template string. Will be coerced to a string with <code>String(templateString)</code>.</p></li></ul></dd>
321
+
322
+
323
+
324
+ <dt class="tag-source">Source:</dt>
325
+ <dd class="tag-source"><ul class="dummy"><li>
326
+ <a href="LinkTemplate.class.mjs.html">LinkTemplate.class.mjs</a>, <a href="LinkTemplate.class.mjs.html#line72">line 72</a>
327
+ </li></ul></dd>
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+ </dl>
360
+
361
+
362
+
363
+
364
+
365
+ <div class="description usertext">
366
+ <p>The Mustache template string. Will be coerced to a string with <code>String(templateString)</code>.</p>
367
+ </div>
368
+
369
+
370
+
371
+ <h5 class="h5-types">Type:</h5>
372
+ <ul>
373
+ <li>
374
+
375
+ <span class="param-type">string</span>
376
+
377
+
378
+
379
+ </li>
380
+ </ul>
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+ <h3 class="subsection-title">Methods</h3>
392
+
393
+
394
+
395
+
396
+
397
+
398
+ <h4 class="name" id="addFilter"><span class="type-signature"></span>addFilter<span class="signature">(fieldName, filterFn)</span><span class="type-signature"> &rarr; {<a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a>}</span></h4>
399
+
400
+
401
+
402
+
403
+
404
+
405
+ <dl class="details">
406
+
407
+ <dt class="tag-description">Description:</dt>
408
+ <dd class="tag-description"><ul class="dummy"><li><p>Add a filter to be applied to one or all fields.</p>
409
+ <p>If an invalid args are passed, the function does not save the filter or
410
+ throw an error, but it does log a warning.</p></li></ul></dd>
411
+
412
+
413
+
414
+ <dt class="tag-source">Source:</dt>
415
+ <dd class="tag-source"><ul class="dummy"><li>
416
+ <a href="LinkTemplate.class.mjs.html">LinkTemplate.class.mjs</a>, <a href="LinkTemplate.class.mjs.html#line89">line 89</a>
417
+ </li></ul></dd>
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+ </dl>
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+ <h5 class="h5-parameters">Parameters:</h5>
464
+
465
+
466
+ <table class="params">
467
+ <thead>
468
+ <tr>
469
+
470
+ <th>Name</th>
471
+
472
+
473
+ <th>Type</th>
474
+
475
+
476
+
477
+
478
+
479
+ <th class="last">Description</th>
480
+ </tr>
481
+ </thead>
482
+
483
+ <tbody>
484
+
485
+
486
+ <tr>
487
+
488
+ <td class="name"><code>fieldName</code></td>
489
+
490
+
491
+ <td class="type">
492
+
493
+
494
+ <span class="param-type">"all"</span>
495
+ |
496
+
497
+ <span class="param-type">"url"</span>
498
+ |
499
+
500
+ <span class="param-type">"text"</span>
501
+ |
502
+
503
+ <span class="param-type">"description"</span>
504
+
505
+
506
+
507
+
508
+ </td>
509
+
510
+
511
+
512
+
513
+
514
+ <td class="description last"></td>
515
+ </tr>
516
+
517
+
518
+
519
+ <tr>
520
+
521
+ <td class="name"><code>filterFn</code></td>
522
+
523
+
524
+ <td class="type">
525
+
526
+
527
+ <span class="param-type"><a href="global.html#templateFieldFilterFunction">templateFieldFilterFunction</a></span>
528
+
529
+
530
+
531
+
532
+ </td>
533
+
534
+
535
+
536
+
537
+
538
+ <td class="description last"><p>the filter function.</p></td>
539
+ </tr>
540
+
541
+
542
+ </tbody>
543
+ </table>
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+ <h5 class="h5-returns">Returns:</h5>
561
+
562
+
563
+ <div class="param-desc">
564
+ <p>Returns a reference to self to facilitate function chaining.</p>
565
+ </div>
566
+
567
+
568
+
569
+ <dl class="param-type">
570
+ <dt>
571
+ Type
572
+ </dt>
573
+ <dd>
574
+
575
+ <span class="param-type"><a href="module-link-template.LinkTemplate.html">module:link-template.LinkTemplate</a></span>
576
+
577
+
578
+
579
+ </dd>
580
+ </dl>
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+ <h4 class="name" id="filtersFor"><span class="type-signature"></span>filtersFor<span class="signature">(fieldName)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="global.html#templateFieldFilterFunction">templateFieldFilterFunction</a>>}</span></h4>
592
+
593
+
594
+
595
+
596
+
597
+
598
+ <dl class="details">
599
+
600
+ <dt class="tag-description">Description:</dt>
601
+ <dd class="tag-description"><ul class="dummy"><li><p>Get the filter functions that should be applied to any given field.</p></li></ul></dd>
602
+
603
+
604
+
605
+ <dt class="tag-source">Source:</dt>
606
+ <dd class="tag-source"><ul class="dummy"><li>
607
+ <a href="LinkTemplate.class.mjs.html">LinkTemplate.class.mjs</a>, <a href="LinkTemplate.class.mjs.html#line116">line 116</a>
608
+ </li></ul></dd>
609
+
610
+
611
+
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+ </dl>
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+ <h5 class="h5-parameters">Parameters:</h5>
655
+
656
+
657
+ <table class="params">
658
+ <thead>
659
+ <tr>
660
+
661
+ <th>Name</th>
662
+
663
+
664
+ <th>Type</th>
665
+
666
+
667
+
668
+
669
+
670
+ <th class="last">Description</th>
671
+ </tr>
672
+ </thead>
673
+
674
+ <tbody>
675
+
676
+
677
+ <tr>
678
+
679
+ <td class="name"><code>fieldName</code></td>
680
+
681
+
682
+ <td class="type">
683
+
684
+
685
+ <span class="param-type">"all"</span>
686
+ |
687
+
688
+ <span class="param-type">"url"</span>
689
+ |
690
+
691
+ <span class="param-type">"text"</span>
692
+ |
693
+
694
+ <span class="param-type">"description"</span>
695
+
696
+
697
+
698
+
699
+ </td>
700
+
701
+
702
+
703
+
704
+
705
+ <td class="description last"></td>
706
+ </tr>
707
+
708
+
709
+ </tbody>
710
+ </table>
711
+
712
+
713
+
714
+
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+
725
+
726
+
727
+ <h5 class="h5-returns">Returns:</h5>
728
+
729
+
730
+ <div class="param-desc">
731
+ <p>returns an array of callbacks, which may be
732
+ empty. An empty array is also returned if an invalid field name is passed.</p>
733
+ </div>
734
+
735
+
736
+
737
+ <dl class="param-type">
738
+ <dt>
739
+ Type
740
+ </dt>
741
+ <dd>
742
+
743
+ <span class="param-type">Array.&lt;<a href="global.html#templateFieldFilterFunction">templateFieldFilterFunction</a>></span>
744
+
745
+
746
+
747
+ </dd>
748
+ </dl>
749
+
750
+
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+
760
+ </article>
761
+
762
+ </section>
763
+
764
+
765
+
766
+
767
+
768
+
769
+ </div>
770
+
771
+ <br class="clear">
772
+
773
+ <footer>
774
+ 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.
775
+ </footer>
776
+
777
+ <script>prettyPrint();</script>
778
+ <script src="scripts/polyfill.js"></script>
779
+ <script src="scripts/linenumber.js"></script>
780
+
781
+ <script src="scripts/search.js" defer></script>
782
+
783
+
784
+
785
+ <link type="text/css" rel="stylesheet" href="./docdash-overrides.css">
786
+
787
+ <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
788
+
789
+ <script src="./mermaid-init.js"></script>
790
+
791
+ </body>
792
+ </html>