@gkucmierz/utils 1.28.0 → 1.28.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 (8) hide show
  1. package/.github/workflows/deploy-docs.yml +22 -0
  2. package/README.md +5 -0
  3. package/jsdoc.json +10 -0
  4. package/package-lock.json +590 -2
  5. package/package.json +9 -4
  6. package/src/factors.mjs +12 -1
  7. package/src/gcd.mjs +11 -0
  8. package/src/square-root.mjs +12 -1
package/.github/workflows/deploy-docs.yml ADDED
@@ -0,0 +1,22 @@
1
+ name: Deploy docs
2
+ on:
3
+ push:
4
+ branches:
5
+ - main # Change this to your default branch
6
+ jobs:
7
+ build-and-deploy:
8
+ concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - name: Checkout 🛎️
12
+ uses: actions/checkout@v4
13
+
14
+ - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
15
+ run: |
16
+ npm i
17
+ npm run docs:build
18
+
19
+ - name: Deploy 🚀
20
+ uses: JamesIves/github-pages-deploy-action@v4
21
+ with:
22
+ folder: docs # The folder the action should deploy.
package/README.md CHANGED
@@ -4,3 +4,8 @@
4
4
  ```bash
5
5
  npm i @gkucmierz/utils
6
6
  ```
7
+
8
+ ### Docs
9
+
10
+ [https://gkucmierz.github.io/utils](https://gkucmierz.github.io/utils)
11
+
package/jsdoc.json ADDED
@@ -0,0 +1,10 @@
1
+ {
2
+ "source": {
3
+ "include": ["src"],
4
+ "includePattern": ".+\\.(js(doc|x)?|mjs)$"
5
+ },
6
+ "opts": {
7
+ "destination": "./docs/",
8
+ "template": "node_modules/docdash"
9
+ }
10
+ }
package/package-lock.json CHANGED
@@ -1,19 +1,110 @@
1
1
  {
2
2
  "name": "@gkucmierz/utils",
3
- "version": "1.28.0",
3
+ "version": "1.28.1",
4
4
  "lockfileVersion": 2,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@gkucmierz/utils",
9
- "version": "1.28.0",
9
+ "version": "1.28.1",
10
10
  "license": "MIT",
11
11
  "devDependencies": {
12
+ "docdash": "^2.0.2",
12
13
  "husky": "^8.0.1",
13
14
  "jasmine": "^4.4.0",
15
+ "jsdoc": "^4.0.4",
14
16
  "nodemon": "^2.0.20"
15
17
  }
16
18
  },
19
+ "node_modules/@babel/helper-string-parser": {
20
+ "version": "7.25.9",
21
+ "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.25.9.tgz",
22
+ "integrity": "sha512-4A/SCr/2KLd5jrtOMFzaKjVtAei3+2r/NChoBNoZ3EyP/+GlhoaEGoWOZUmFmoITP7zOJyHIMm+DYRd8o3PvHA==",
23
+ "dev": true,
24
+ "license": "MIT",
25
+ "engines": {
26
+ "node": ">=6.9.0"
27
+ }
28
+ },
29
+ "node_modules/@babel/helper-validator-identifier": {
30
+ "version": "7.25.9",
31
+ "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.25.9.tgz",
32
+ "integrity": "sha512-Ed61U6XJc3CVRfkERJWDz4dJwKe7iLmmJsbOGu9wSloNSFttHV0I8g6UAgb7qnK5ly5bGLPd4oXZlxCdANBOWQ==",
33
+ "dev": true,
34
+ "license": "MIT",
35
+ "engines": {
36
+ "node": ">=6.9.0"
37
+ }
38
+ },
39
+ "node_modules/@babel/parser": {
40
+ "version": "7.26.2",
41
+ "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.26.2.tgz",
42
+ "integrity": "sha512-DWMCZH9WA4Maitz2q21SRKHo9QXZxkDsbNZoVD62gusNtNBBqDg9i7uOhASfTfIGNzW+O+r7+jAlM8dwphcJKQ==",
43
+ "dev": true,
44
+ "license": "MIT",
45
+ "dependencies": {
46
+ "@babel/types": "^7.26.0"
47
+ },
48
+ "bin": {
49
+ "parser": "bin/babel-parser.js"
50
+ },
51
+ "engines": {
52
+ "node": ">=6.0.0"
53
+ }
54
+ },
55
+ "node_modules/@babel/types": {
56
+ "version": "7.26.0",
57
+ "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.0.tgz",
58
+ "integrity": "sha512-Z/yiTPj+lDVnF7lWeKCIJzaIkI0vYO87dMpZ4bg4TDrFe4XXLFWL1TbXU27gBP3QccxV9mZICCrnjnYlJjXHOA==",
59
+ "dev": true,
60
+ "license": "MIT",
61
+ "dependencies": {
62
+ "@babel/helper-string-parser": "^7.25.9",
63
+ "@babel/helper-validator-identifier": "^7.25.9"
64
+ },
65
+ "engines": {
66
+ "node": ">=6.9.0"
67
+ }
68
+ },
69
+ "node_modules/@jsdoc/salty": {
70
+ "version": "0.2.8",
71
+ "resolved": "https://registry.npmjs.org/@jsdoc/salty/-/salty-0.2.8.tgz",
72
+ "integrity": "sha512-5e+SFVavj1ORKlKaKr2BmTOekmXbelU7dC0cDkQLqag7xfuTPuGMUFx7KWJuv4bYZrTsoL2Z18VVCOKYxzoHcg==",
73
+ "dev": true,
74
+ "license": "Apache-2.0",
75
+ "dependencies": {
76
+ "lodash": "^4.17.21"
77
+ },
78
+ "engines": {
79
+ "node": ">=v12.0.0"
80
+ }
81
+ },
82
+ "node_modules/@types/linkify-it": {
83
+ "version": "5.0.0",
84
+ "resolved": "https://registry.npmjs.org/@types/linkify-it/-/linkify-it-5.0.0.tgz",
85
+ "integrity": "sha512-sVDA58zAw4eWAffKOaQH5/5j3XeayukzDk+ewSsnv3p4yJEZHCCzMDiZM8e0OUrRvmpGZ85jf4yDHkHsgBNr9Q==",
86
+ "dev": true,
87
+ "license": "MIT"
88
+ },
89
+ "node_modules/@types/markdown-it": {
90
+ "version": "14.1.2",
91
+ "resolved": "https://registry.npmjs.org/@types/markdown-it/-/markdown-it-14.1.2.tgz",
92
+ "integrity": "sha512-promo4eFwuiW+TfGxhi+0x3czqTYJkG8qB17ZUJiVF10Xm7NLVRSLUsfRTU/6h1e24VvRnXCx+hG7li58lkzog==",
93
+ "dev": true,
94
+ "license": "MIT",
95
+ "peer": true,
96
+ "dependencies": {
97
+ "@types/linkify-it": "^5",
98
+ "@types/mdurl": "^2"
99
+ }
100
+ },
101
+ "node_modules/@types/mdurl": {
102
+ "version": "2.0.0",
103
+ "resolved": "https://registry.npmjs.org/@types/mdurl/-/mdurl-2.0.0.tgz",
104
+ "integrity": "sha512-RGdgjQUZba5p6QEFAVx2OGb8rQDL/cPRG7GiedRzMcJ1tYnUANBncjbSB1NRGwbvjcPeikRABz2nshyPk1bhWg==",
105
+ "dev": true,
106
+ "license": "MIT"
107
+ },
17
108
  "node_modules/abbrev": {
18
109
  "version": "1.1.1",
19
110
  "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz",
@@ -33,6 +124,13 @@
33
124
  "node": ">= 8"
34
125
  }
35
126
  },
127
+ "node_modules/argparse": {
128
+ "version": "2.0.1",
129
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
130
+ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==",
131
+ "dev": true,
132
+ "license": "Python-2.0"
133
+ },
36
134
  "node_modules/balanced-match": {
37
135
  "version": "1.0.2",
38
136
  "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
@@ -48,6 +146,13 @@
48
146
  "node": ">=8"
49
147
  }
50
148
  },
149
+ "node_modules/bluebird": {
150
+ "version": "3.7.2",
151
+ "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz",
152
+ "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==",
153
+ "dev": true,
154
+ "license": "MIT"
155
+ },
51
156
  "node_modules/brace-expansion": {
52
157
  "version": "1.1.11",
53
158
  "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
@@ -70,6 +175,19 @@
70
175
  "node": ">=8"
71
176
  }
72
177
  },
178
+ "node_modules/catharsis": {
179
+ "version": "0.9.0",
180
+ "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.9.0.tgz",
181
+ "integrity": "sha512-prMTQVpcns/tzFgFVkVp6ak6RykZyWb3gu8ckUpd6YkTlacOd3DXGJjIpD4Q6zJirizvaiAjSSHlOsA+6sNh2A==",
182
+ "dev": true,
183
+ "license": "MIT",
184
+ "dependencies": {
185
+ "lodash": "^4.17.15"
186
+ },
187
+ "engines": {
188
+ "node": ">= 10"
189
+ }
190
+ },
73
191
  "node_modules/chokidar": {
74
192
  "version": "3.5.3",
75
193
  "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.5.3.tgz",
@@ -112,6 +230,39 @@
112
230
  "ms": "^2.1.1"
113
231
  }
114
232
  },
233
+ "node_modules/docdash": {
234
+ "version": "2.0.2",
235
+ "resolved": "https://registry.npmjs.org/docdash/-/docdash-2.0.2.tgz",
236
+ "integrity": "sha512-3SDDheh9ddrwjzf6dPFe1a16M6ftstqTNjik2+1fx46l24H9dD2osT2q9y+nBEC1wWz4GIqA48JmicOLQ0R8xA==",
237
+ "dev": true,
238
+ "license": "Apache-2.0",
239
+ "dependencies": {
240
+ "@jsdoc/salty": "^0.2.1"
241
+ }
242
+ },
243
+ "node_modules/entities": {
244
+ "version": "4.5.0",
245
+ "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz",
246
+ "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==",
247
+ "dev": true,
248
+ "license": "BSD-2-Clause",
249
+ "engines": {
250
+ "node": ">=0.12"
251
+ },
252
+ "funding": {
253
+ "url": "https://github.com/fb55/entities?sponsor=1"
254
+ }
255
+ },
256
+ "node_modules/escape-string-regexp": {
257
+ "version": "2.0.0",
258
+ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz",
259
+ "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==",
260
+ "dev": true,
261
+ "license": "MIT",
262
+ "engines": {
263
+ "node": ">=8"
264
+ }
265
+ },
115
266
  "node_modules/fill-range": {
116
267
  "version": "7.0.1",
117
268
  "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
@@ -176,6 +327,13 @@
176
327
  "node": ">= 6"
177
328
  }
178
329
  },
330
+ "node_modules/graceful-fs": {
331
+ "version": "4.2.11",
332
+ "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz",
333
+ "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==",
334
+ "dev": true,
335
+ "license": "ISC"
336
+ },
179
337
  "node_modules/has-flag": {
180
338
  "version": "3.0.0",
181
339
  "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
@@ -283,6 +441,123 @@
283
441
  "integrity": "sha512-+l482uImx5BVd6brJYlaHe2UwfKoZBqQfNp20ZmdNfsjGFTemGfqHLsXjKEW23w9R/m8WYeFc9JmIgjj6dUtAA==",
284
442
  "dev": true
285
443
  },
444
+ "node_modules/js2xmlparser": {
445
+ "version": "4.0.2",
446
+ "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.2.tgz",
447
+ "integrity": "sha512-6n4D8gLlLf1n5mNLQPRfViYzu9RATblzPEtm1SthMX1Pjao0r9YI9nw7ZIfRxQMERS87mcswrg+r/OYrPRX6jA==",
448
+ "dev": true,
449
+ "license": "Apache-2.0",
450
+ "dependencies": {
451
+ "xmlcreate": "^2.0.4"
452
+ }
453
+ },
454
+ "node_modules/jsdoc": {
455
+ "version": "4.0.4",
456
+ "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-4.0.4.tgz",
457
+ "integrity": "sha512-zeFezwyXeG4syyYHbvh1A967IAqq/67yXtXvuL5wnqCkFZe8I0vKfm+EO+YEvLguo6w9CDUbrAXVtJSHh2E8rw==",
458
+ "dev": true,
459
+ "license": "Apache-2.0",
460
+ "dependencies": {
461
+ "@babel/parser": "^7.20.15",
462
+ "@jsdoc/salty": "^0.2.1",
463
+ "@types/markdown-it": "^14.1.1",
464
+ "bluebird": "^3.7.2",
465
+ "catharsis": "^0.9.0",
466
+ "escape-string-regexp": "^2.0.0",
467
+ "js2xmlparser": "^4.0.2",
468
+ "klaw": "^3.0.0",
469
+ "markdown-it": "^14.1.0",
470
+ "markdown-it-anchor": "^8.6.7",
471
+ "marked": "^4.0.10",
472
+ "mkdirp": "^1.0.4",
473
+ "requizzle": "^0.2.3",
474
+ "strip-json-comments": "^3.1.0",
475
+ "underscore": "~1.13.2"
476
+ },
477
+ "bin": {
478
+ "jsdoc": "jsdoc.js"
479
+ },
480
+ "engines": {
481
+ "node": ">=12.0.0"
482
+ }
483
+ },
484
+ "node_modules/klaw": {
485
+ "version": "3.0.0",
486
+ "resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz",
487
+ "integrity": "sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==",
488
+ "dev": true,
489
+ "license": "MIT",
490
+ "dependencies": {
491
+ "graceful-fs": "^4.1.9"
492
+ }
493
+ },
494
+ "node_modules/linkify-it": {
495
+ "version": "5.0.0",
496
+ "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz",
497
+ "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==",
498
+ "dev": true,
499
+ "license": "MIT",
500
+ "dependencies": {
501
+ "uc.micro": "^2.0.0"
502
+ }
503
+ },
504
+ "node_modules/lodash": {
505
+ "version": "4.17.21",
506
+ "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
507
+ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==",
508
+ "dev": true,
509
+ "license": "MIT"
510
+ },
511
+ "node_modules/markdown-it": {
512
+ "version": "14.1.0",
513
+ "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz",
514
+ "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==",
515
+ "dev": true,
516
+ "license": "MIT",
517
+ "peer": true,
518
+ "dependencies": {
519
+ "argparse": "^2.0.1",
520
+ "entities": "^4.4.0",
521
+ "linkify-it": "^5.0.0",
522
+ "mdurl": "^2.0.0",
523
+ "punycode.js": "^2.3.1",
524
+ "uc.micro": "^2.1.0"
525
+ },
526
+ "bin": {
527
+ "markdown-it": "bin/markdown-it.mjs"
528
+ }
529
+ },
530
+ "node_modules/markdown-it-anchor": {
531
+ "version": "8.6.7",
532
+ "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-8.6.7.tgz",
533
+ "integrity": "sha512-FlCHFwNnutLgVTflOYHPW2pPcl2AACqVzExlkGQNsi4CJgqOHN7YTgDd4LuhgN1BFO3TS0vLAruV1Td6dwWPJA==",
534
+ "dev": true,
535
+ "license": "Unlicense",
536
+ "peerDependencies": {
537
+ "@types/markdown-it": "*",
538
+ "markdown-it": "*"
539
+ }
540
+ },
541
+ "node_modules/marked": {
542
+ "version": "4.3.0",
543
+ "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz",
544
+ "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==",
545
+ "dev": true,
546
+ "license": "MIT",
547
+ "bin": {
548
+ "marked": "bin/marked.js"
549
+ },
550
+ "engines": {
551
+ "node": ">= 12"
552
+ }
553
+ },
554
+ "node_modules/mdurl": {
555
+ "version": "2.0.0",
556
+ "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz",
557
+ "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==",
558
+ "dev": true,
559
+ "license": "MIT"
560
+ },
286
561
  "node_modules/minimatch": {
287
562
  "version": "3.1.2",
288
563
  "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
@@ -295,6 +570,19 @@
295
570
  "node": "*"
296
571
  }
297
572
  },
573
+ "node_modules/mkdirp": {
574
+ "version": "1.0.4",
575
+ "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
576
+ "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
577
+ "dev": true,
578
+ "license": "MIT",
579
+ "bin": {
580
+ "mkdirp": "bin/cmd.js"
581
+ },
582
+ "engines": {
583
+ "node": ">=10"
584
+ }
585
+ },
298
586
  "node_modules/ms": {
299
587
  "version": "2.1.3",
300
588
  "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
@@ -389,6 +677,16 @@
389
677
  "integrity": "sha512-77DZwxQmxKnu3aR542U+X8FypNzbfJ+C5XQDk3uWjWxn6151aIMGthWYRXTqT1E5oJvg+ljaa2OJi+VfvCOQ8w==",
390
678
  "dev": true
391
679
  },
680
+ "node_modules/punycode.js": {
681
+ "version": "2.3.1",
682
+ "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz",
683
+ "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==",
684
+ "dev": true,
685
+ "license": "MIT",
686
+ "engines": {
687
+ "node": ">=6"
688
+ }
689
+ },
392
690
  "node_modules/readdirp": {
393
691
  "version": "3.6.0",
394
692
  "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz",
@@ -401,6 +699,16 @@
401
699
  "node": ">=8.10.0"
402
700
  }
403
701
  },
702
+ "node_modules/requizzle": {
703
+ "version": "0.2.4",
704
+ "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.4.tgz",
705
+ "integrity": "sha512-JRrFk1D4OQ4SqovXOgdav+K8EAhSB/LJZqCz8tbX0KObcdeM15Ss59ozWMBWmmINMagCwmqn4ZNryUGpBsl6Jw==",
706
+ "dev": true,
707
+ "license": "MIT",
708
+ "dependencies": {
709
+ "lodash": "^4.17.21"
710
+ }
711
+ },
404
712
  "node_modules/semver": {
405
713
  "version": "5.7.1",
406
714
  "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz",
@@ -431,6 +739,19 @@
431
739
  "semver": "bin/semver.js"
432
740
  }
433
741
  },
742
+ "node_modules/strip-json-comments": {
743
+ "version": "3.1.1",
744
+ "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz",
745
+ "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==",
746
+ "dev": true,
747
+ "license": "MIT",
748
+ "engines": {
749
+ "node": ">=8"
750
+ },
751
+ "funding": {
752
+ "url": "https://github.com/sponsors/sindresorhus"
753
+ }
754
+ },
434
755
  "node_modules/supports-color": {
435
756
  "version": "5.5.0",
436
757
  "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
@@ -467,20 +788,104 @@
467
788
  "nodetouch": "bin/nodetouch.js"
468
789
  }
469
790
  },
791
+ "node_modules/uc.micro": {
792
+ "version": "2.1.0",
793
+ "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz",
794
+ "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==",
795
+ "dev": true,
796
+ "license": "MIT"
797
+ },
470
798
  "node_modules/undefsafe": {
471
799
  "version": "2.0.5",
472
800
  "resolved": "https://registry.npmjs.org/undefsafe/-/undefsafe-2.0.5.tgz",
473
801
  "integrity": "sha512-WxONCrssBM8TSPRqN5EmsjVrsv4A8X12J4ArBiiayv3DyyG3ZlIg6yysuuSYdZsVz3TKcTg2fd//Ujd4CHV1iA==",
474
802
  "dev": true
475
803
  },
804
+ "node_modules/underscore": {
805
+ "version": "1.13.7",
806
+ "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.7.tgz",
807
+ "integrity": "sha512-GMXzWtsc57XAtguZgaQViUOzs0KTkk8ojr3/xAxXLITqf/3EMwxC0inyETfDFjH/Krbhuep0HNbbjI9i/q3F3g==",
808
+ "dev": true,
809
+ "license": "MIT"
810
+ },
476
811
  "node_modules/wrappy": {
477
812
  "version": "1.0.2",
478
813
  "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
479
814
  "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
480
815
  "dev": true
816
+ },
817
+ "node_modules/xmlcreate": {
818
+ "version": "2.0.4",
819
+ "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.4.tgz",
820
+ "integrity": "sha512-nquOebG4sngPmGPICTS5EnxqhKbCmz5Ox5hsszI2T6U5qdrJizBc+0ilYSEjTSzU0yZcmvppztXe/5Al5fUwdg==",
821
+ "dev": true,
822
+ "license": "Apache-2.0"
481
823
  }
482
824
  },
483
825
  "dependencies": {
826
+ "@babel/helper-string-parser": {
827
+ "version": "7.25.9",
828
+ "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.25.9.tgz",
829
+ "integrity": "sha512-4A/SCr/2KLd5jrtOMFzaKjVtAei3+2r/NChoBNoZ3EyP/+GlhoaEGoWOZUmFmoITP7zOJyHIMm+DYRd8o3PvHA==",
830
+ "dev": true
831
+ },
832
+ "@babel/helper-validator-identifier": {
833
+ "version": "7.25.9",
834
+ "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.25.9.tgz",
835
+ "integrity": "sha512-Ed61U6XJc3CVRfkERJWDz4dJwKe7iLmmJsbOGu9wSloNSFttHV0I8g6UAgb7qnK5ly5bGLPd4oXZlxCdANBOWQ==",
836
+ "dev": true
837
+ },
838
+ "@babel/parser": {
839
+ "version": "7.26.2",
840
+ "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.26.2.tgz",
841
+ "integrity": "sha512-DWMCZH9WA4Maitz2q21SRKHo9QXZxkDsbNZoVD62gusNtNBBqDg9i7uOhASfTfIGNzW+O+r7+jAlM8dwphcJKQ==",
842
+ "dev": true,
843
+ "requires": {
844
+ "@babel/types": "^7.26.0"
845
+ }
846
+ },
847
+ "@babel/types": {
848
+ "version": "7.26.0",
849
+ "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.0.tgz",
850
+ "integrity": "sha512-Z/yiTPj+lDVnF7lWeKCIJzaIkI0vYO87dMpZ4bg4TDrFe4XXLFWL1TbXU27gBP3QccxV9mZICCrnjnYlJjXHOA==",
851
+ "dev": true,
852
+ "requires": {
853
+ "@babel/helper-string-parser": "^7.25.9",
854
+ "@babel/helper-validator-identifier": "^7.25.9"
855
+ }
856
+ },
857
+ "@jsdoc/salty": {
858
+ "version": "0.2.8",
859
+ "resolved": "https://registry.npmjs.org/@jsdoc/salty/-/salty-0.2.8.tgz",
860
+ "integrity": "sha512-5e+SFVavj1ORKlKaKr2BmTOekmXbelU7dC0cDkQLqag7xfuTPuGMUFx7KWJuv4bYZrTsoL2Z18VVCOKYxzoHcg==",
861
+ "dev": true,
862
+ "requires": {
863
+ "lodash": "^4.17.21"
864
+ }
865
+ },
866
+ "@types/linkify-it": {
867
+ "version": "5.0.0",
868
+ "resolved": "https://registry.npmjs.org/@types/linkify-it/-/linkify-it-5.0.0.tgz",
869
+ "integrity": "sha512-sVDA58zAw4eWAffKOaQH5/5j3XeayukzDk+ewSsnv3p4yJEZHCCzMDiZM8e0OUrRvmpGZ85jf4yDHkHsgBNr9Q==",
870
+ "dev": true
871
+ },
872
+ "@types/markdown-it": {
873
+ "version": "14.1.2",
874
+ "resolved": "https://registry.npmjs.org/@types/markdown-it/-/markdown-it-14.1.2.tgz",
875
+ "integrity": "sha512-promo4eFwuiW+TfGxhi+0x3czqTYJkG8qB17ZUJiVF10Xm7NLVRSLUsfRTU/6h1e24VvRnXCx+hG7li58lkzog==",
876
+ "dev": true,
877
+ "peer": true,
878
+ "requires": {
879
+ "@types/linkify-it": "^5",
880
+ "@types/mdurl": "^2"
881
+ }
882
+ },
883
+ "@types/mdurl": {
884
+ "version": "2.0.0",
885
+ "resolved": "https://registry.npmjs.org/@types/mdurl/-/mdurl-2.0.0.tgz",
886
+ "integrity": "sha512-RGdgjQUZba5p6QEFAVx2OGb8rQDL/cPRG7GiedRzMcJ1tYnUANBncjbSB1NRGwbvjcPeikRABz2nshyPk1bhWg==",
887
+ "dev": true
888
+ },
484
889
  "abbrev": {
485
890
  "version": "1.1.1",
486
891
  "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz",
@@ -497,6 +902,12 @@
497
902
  "picomatch": "^2.0.4"
498
903
  }
499
904
  },
905
+ "argparse": {
906
+ "version": "2.0.1",
907
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
908
+ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==",
909
+ "dev": true
910
+ },
500
911
  "balanced-match": {
501
912
  "version": "1.0.2",
502
913
  "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
@@ -509,6 +920,12 @@
509
920
  "integrity": "sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA==",
510
921
  "dev": true
511
922
  },
923
+ "bluebird": {
924
+ "version": "3.7.2",
925
+ "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz",
926
+ "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==",
927
+ "dev": true
928
+ },
512
929
  "brace-expansion": {
513
930
  "version": "1.1.11",
514
931
  "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
@@ -528,6 +945,15 @@
528
945
  "fill-range": "^7.0.1"
529
946
  }
530
947
  },
948
+ "catharsis": {
949
+ "version": "0.9.0",
950
+ "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.9.0.tgz",
951
+ "integrity": "sha512-prMTQVpcns/tzFgFVkVp6ak6RykZyWb3gu8ckUpd6YkTlacOd3DXGJjIpD4Q6zJirizvaiAjSSHlOsA+6sNh2A==",
952
+ "dev": true,
953
+ "requires": {
954
+ "lodash": "^4.17.15"
955
+ }
956
+ },
531
957
  "chokidar": {
532
958
  "version": "3.5.3",
533
959
  "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.5.3.tgz",
@@ -559,6 +985,27 @@
559
985
  "ms": "^2.1.1"
560
986
  }
561
987
  },
988
+ "docdash": {
989
+ "version": "2.0.2",
990
+ "resolved": "https://registry.npmjs.org/docdash/-/docdash-2.0.2.tgz",
991
+ "integrity": "sha512-3SDDheh9ddrwjzf6dPFe1a16M6ftstqTNjik2+1fx46l24H9dD2osT2q9y+nBEC1wWz4GIqA48JmicOLQ0R8xA==",
992
+ "dev": true,
993
+ "requires": {
994
+ "@jsdoc/salty": "^0.2.1"
995
+ }
996
+ },
997
+ "entities": {
998
+ "version": "4.5.0",
999
+ "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz",
1000
+ "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==",
1001
+ "dev": true
1002
+ },
1003
+ "escape-string-regexp": {
1004
+ "version": "2.0.0",
1005
+ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz",
1006
+ "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==",
1007
+ "dev": true
1008
+ },
562
1009
  "fill-range": {
563
1010
  "version": "7.0.1",
564
1011
  "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
@@ -604,6 +1051,12 @@
604
1051
  "is-glob": "^4.0.1"
605
1052
  }
606
1053
  },
1054
+ "graceful-fs": {
1055
+ "version": "4.2.11",
1056
+ "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz",
1057
+ "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==",
1058
+ "dev": true
1059
+ },
607
1060
  "has-flag": {
608
1061
  "version": "3.0.0",
609
1062
  "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
@@ -684,6 +1137,96 @@
684
1137
  "integrity": "sha512-+l482uImx5BVd6brJYlaHe2UwfKoZBqQfNp20ZmdNfsjGFTemGfqHLsXjKEW23w9R/m8WYeFc9JmIgjj6dUtAA==",
685
1138
  "dev": true
686
1139
  },
1140
+ "js2xmlparser": {
1141
+ "version": "4.0.2",
1142
+ "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.2.tgz",
1143
+ "integrity": "sha512-6n4D8gLlLf1n5mNLQPRfViYzu9RATblzPEtm1SthMX1Pjao0r9YI9nw7ZIfRxQMERS87mcswrg+r/OYrPRX6jA==",
1144
+ "dev": true,
1145
+ "requires": {
1146
+ "xmlcreate": "^2.0.4"
1147
+ }
1148
+ },
1149
+ "jsdoc": {
1150
+ "version": "4.0.4",
1151
+ "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-4.0.4.tgz",
1152
+ "integrity": "sha512-zeFezwyXeG4syyYHbvh1A967IAqq/67yXtXvuL5wnqCkFZe8I0vKfm+EO+YEvLguo6w9CDUbrAXVtJSHh2E8rw==",
1153
+ "dev": true,
1154
+ "requires": {
1155
+ "@babel/parser": "^7.20.15",
1156
+ "@jsdoc/salty": "^0.2.1",
1157
+ "@types/markdown-it": "^14.1.1",
1158
+ "bluebird": "^3.7.2",
1159
+ "catharsis": "^0.9.0",
1160
+ "escape-string-regexp": "^2.0.0",
1161
+ "js2xmlparser": "^4.0.2",
1162
+ "klaw": "^3.0.0",
1163
+ "markdown-it": "^14.1.0",
1164
+ "markdown-it-anchor": "^8.6.7",
1165
+ "marked": "^4.0.10",
1166
+ "mkdirp": "^1.0.4",
1167
+ "requizzle": "^0.2.3",
1168
+ "strip-json-comments": "^3.1.0",
1169
+ "underscore": "~1.13.2"
1170
+ }
1171
+ },
1172
+ "klaw": {
1173
+ "version": "3.0.0",
1174
+ "resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz",
1175
+ "integrity": "sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==",
1176
+ "dev": true,
1177
+ "requires": {
1178
+ "graceful-fs": "^4.1.9"
1179
+ }
1180
+ },
1181
+ "linkify-it": {
1182
+ "version": "5.0.0",
1183
+ "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz",
1184
+ "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==",
1185
+ "dev": true,
1186
+ "requires": {
1187
+ "uc.micro": "^2.0.0"
1188
+ }
1189
+ },
1190
+ "lodash": {
1191
+ "version": "4.17.21",
1192
+ "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
1193
+ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==",
1194
+ "dev": true
1195
+ },
1196
+ "markdown-it": {
1197
+ "version": "14.1.0",
1198
+ "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz",
1199
+ "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==",
1200
+ "dev": true,
1201
+ "peer": true,
1202
+ "requires": {
1203
+ "argparse": "^2.0.1",
1204
+ "entities": "^4.4.0",
1205
+ "linkify-it": "^5.0.0",
1206
+ "mdurl": "^2.0.0",
1207
+ "punycode.js": "^2.3.1",
1208
+ "uc.micro": "^2.1.0"
1209
+ }
1210
+ },
1211
+ "markdown-it-anchor": {
1212
+ "version": "8.6.7",
1213
+ "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-8.6.7.tgz",
1214
+ "integrity": "sha512-FlCHFwNnutLgVTflOYHPW2pPcl2AACqVzExlkGQNsi4CJgqOHN7YTgDd4LuhgN1BFO3TS0vLAruV1Td6dwWPJA==",
1215
+ "dev": true,
1216
+ "requires": {}
1217
+ },
1218
+ "marked": {
1219
+ "version": "4.3.0",
1220
+ "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz",
1221
+ "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==",
1222
+ "dev": true
1223
+ },
1224
+ "mdurl": {
1225
+ "version": "2.0.0",
1226
+ "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz",
1227
+ "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==",
1228
+ "dev": true
1229
+ },
687
1230
  "minimatch": {
688
1231
  "version": "3.1.2",
689
1232
  "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
@@ -693,6 +1236,12 @@
693
1236
  "brace-expansion": "^1.1.7"
694
1237
  }
695
1238
  },
1239
+ "mkdirp": {
1240
+ "version": "1.0.4",
1241
+ "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
1242
+ "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
1243
+ "dev": true
1244
+ },
696
1245
  "ms": {
697
1246
  "version": "2.1.3",
698
1247
  "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
@@ -759,6 +1308,12 @@
759
1308
  "integrity": "sha512-77DZwxQmxKnu3aR542U+X8FypNzbfJ+C5XQDk3uWjWxn6151aIMGthWYRXTqT1E5oJvg+ljaa2OJi+VfvCOQ8w==",
760
1309
  "dev": true
761
1310
  },
1311
+ "punycode.js": {
1312
+ "version": "2.3.1",
1313
+ "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz",
1314
+ "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==",
1315
+ "dev": true
1316
+ },
762
1317
  "readdirp": {
763
1318
  "version": "3.6.0",
764
1319
  "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz",
@@ -768,6 +1323,15 @@
768
1323
  "picomatch": "^2.2.1"
769
1324
  }
770
1325
  },
1326
+ "requizzle": {
1327
+ "version": "0.2.4",
1328
+ "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.4.tgz",
1329
+ "integrity": "sha512-JRrFk1D4OQ4SqovXOgdav+K8EAhSB/LJZqCz8tbX0KObcdeM15Ss59ozWMBWmmINMagCwmqn4ZNryUGpBsl6Jw==",
1330
+ "dev": true,
1331
+ "requires": {
1332
+ "lodash": "^4.17.21"
1333
+ }
1334
+ },
771
1335
  "semver": {
772
1336
  "version": "5.7.1",
773
1337
  "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz",
@@ -791,6 +1355,12 @@
791
1355
  }
792
1356
  }
793
1357
  },
1358
+ "strip-json-comments": {
1359
+ "version": "3.1.1",
1360
+ "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz",
1361
+ "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==",
1362
+ "dev": true
1363
+ },
794
1364
  "supports-color": {
795
1365
  "version": "5.5.0",
796
1366
  "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
@@ -818,17 +1388,35 @@
818
1388
  "nopt": "~1.0.10"
819
1389
  }
820
1390
  },
1391
+ "uc.micro": {
1392
+ "version": "2.1.0",
1393
+ "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz",
1394
+ "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==",
1395
+ "dev": true
1396
+ },
821
1397
  "undefsafe": {
822
1398
  "version": "2.0.5",
823
1399
  "resolved": "https://registry.npmjs.org/undefsafe/-/undefsafe-2.0.5.tgz",
824
1400
  "integrity": "sha512-WxONCrssBM8TSPRqN5EmsjVrsv4A8X12J4ArBiiayv3DyyG3ZlIg6yysuuSYdZsVz3TKcTg2fd//Ujd4CHV1iA==",
825
1401
  "dev": true
826
1402
  },
1403
+ "underscore": {
1404
+ "version": "1.13.7",
1405
+ "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.7.tgz",
1406
+ "integrity": "sha512-GMXzWtsc57XAtguZgaQViUOzs0KTkk8ojr3/xAxXLITqf/3EMwxC0inyETfDFjH/Krbhuep0HNbbjI9i/q3F3g==",
1407
+ "dev": true
1408
+ },
827
1409
  "wrappy": {
828
1410
  "version": "1.0.2",
829
1411
  "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
830
1412
  "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
831
1413
  "dev": true
1414
+ },
1415
+ "xmlcreate": {
1416
+ "version": "2.0.4",
1417
+ "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.4.tgz",
1418
+ "integrity": "sha512-nquOebG4sngPmGPICTS5EnxqhKbCmz5Ox5hsszI2T6U5qdrJizBc+0ilYSEjTSzU0yZcmvppztXe/5Al5fUwdg==",
1419
+ "dev": true
832
1420
  }
833
1421
  }
834
1422
  }
package/package.json CHANGED
@@ -1,12 +1,15 @@
1
1
  {
2
2
  "name": "@gkucmierz/utils",
3
- "version": "1.28.0",
3
+ "version": "1.28.1",
4
4
  "description": "Usefull functions for solving programming tasks",
5
5
  "main": "main.mjs",
6
6
  "scripts": {
7
7
  "test": "jasmine",
8
8
  "watch": "nodemon --exec 'npm test'",
9
- "main": "node scripts/generate_main.mjs"
9
+ "main": "node scripts/generate_main.mjs",
10
+ "docs": "npm run docs:build; npm run docs:open",
11
+ "docs:build": "jsdoc -c jsdoc.json --readme README.md",
12
+ "docs:open": "open docs/index.html"
10
13
  },
11
14
  "repository": {
12
15
  "type": "git",
@@ -15,8 +18,10 @@
15
18
  "author": "Grzegorz Kućmierz",
16
19
  "license": "MIT",
17
20
  "devDependencies": {
21
+ "docdash": "^2.0.2",
22
+ "husky": "^8.0.1",
18
23
  "jasmine": "^4.4.0",
19
- "nodemon": "^2.0.20",
20
- "husky": "^8.0.1"
24
+ "jsdoc": "^4.0.4",
25
+ "nodemon": "^2.0.20"
21
26
  }
22
27
  }
package/src/factors.mjs CHANGED
@@ -1,5 +1,10 @@
1
1
 
2
-
2
+ /**
3
+ * Prime factorization
4
+ * @function
5
+ * @param {Number} number
6
+ * @return {Number} result
7
+ */
3
8
  export const factors = n => {
4
9
  if (n < 2) return [];
5
10
  const res = [];
@@ -16,6 +21,12 @@ export const factors = n => {
16
21
  return res;
17
22
  };
18
23
 
24
+ /**
25
+ * Prime factorization (BigInt version)
26
+ * @function
27
+ * @param {BigInt} number
28
+ * @return {BigInt} result
29
+ */
19
30
  export const factorsBI = n => {
20
31
  if (n < 2n) return [];
21
32
  const res = [];
package/src/gcd.mjs CHANGED
@@ -15,5 +15,16 @@ const getGCD = ZERO => {
15
15
  };
16
16
  };
17
17
 
18
+ /**
19
+ * Calculate GCD - Greatest Common Divisor
20
+ * @param {Number} Natural number
21
+ * @return {Number} GCD
22
+ */
18
23
  export const gcd = getGCD(0);
24
+
25
+ /**
26
+ * Calculate GCD - Greatest Common Divisor (BigInt version)
27
+ * @param {BigInt} Natural BigInt number
28
+ * @return {BigInt} GCD
29
+ */
19
30
  export const gcdBI = getGCD(0n);
package/src/square-root.mjs CHANGED
@@ -1,8 +1,19 @@
1
1
 
2
2
 
3
+ /**
4
+ * Native square root
5
+ * @function
6
+ * @param {Number} number - js double number
7
+ * @return {Number} result
8
+ */
3
9
  export const squareRoot = n => n ** 0.5;
4
10
 
5
- // Newrton's formula
11
+ /**
12
+ * Calculate square root using Newton's formula
13
+ * @function
14
+ * @param {BigInt} number - big integer number
15
+ * @return {BigInt} result
16
+ */
6
17
  export const squareRootBI = n => {
7
18
  if (n === 0n) return 0n;
8
19
  if (n < 4n) return 1n;