├── .gitignore ├── .vscode └── settings.json ├── README.md ├── jsdoc.json ├── package-lock.json ├── package.json ├── src ├── arrays.js ├── browser.js ├── class.js ├── custom-types.js ├── functions.js ├── index.js ├── lib │ └── myMath.js ├── objets.js ├── server.js └── strings.js └── tutorials ├── first-tutorial.html ├── second-tutorial.md └── tutorials.json /.gitignore: -------------------------------------------------------------------------------- 1 | docs 2 | node_modules -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "javascript.implicitProjectConfig.checkJs": true 3 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Welcome to JSDoc Tutorial 2 | this is a very simple introduction to JSDoc 3 | 4 | ## Plugins 5 | * https://www.npmjs.com/package/jsdoc-http-plugin -------------------------------------------------------------------------------- /jsdoc.json: -------------------------------------------------------------------------------- 1 | { 2 | "source": { 3 | "include": [ 4 | "src" 5 | ], 6 | "includePattern": ".js$", 7 | "excludePattern": "(node_modules|docs)" 8 | }, 9 | "plugins": [ 10 | "plugins/markdown", 11 | "jsdoc-http-plugin" 12 | ], 13 | "templates": { 14 | "cleverLinks": true, 15 | "monospaceLinks": true 16 | }, 17 | "opts": { 18 | "recurse": true, 19 | "destination": "./docs", 20 | "template": "node_modules/docdash", 21 | "tutorials": "./tutorials", 22 | "readme": "./README.md" 23 | } 24 | } -------------------------------------------------------------------------------- /package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "jsdoc-tutorial", 3 | "version": "1.0.0", 4 | "lockfileVersion": 1, 5 | "requires": true, 6 | "dependencies": { 7 | "@babel/parser": { 8 | "version": "7.12.7", 9 | "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.12.7.tgz", 10 | "integrity": "sha512-oWR02Ubp4xTLCAqPRiNIuMVgNO5Aif/xpXtabhzW2HWUD47XJsAB4Zd/Rg30+XeQA3juXigV7hlquOTmwqLiwg==", 11 | "dev": true 12 | }, 13 | "accepts": { 14 | "version": "1.3.7", 15 | "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.7.tgz", 16 | "integrity": "sha512-Il80Qs2WjYlJIBNzNkK6KYqlVMTbZLXgHx2oT0pU/fjRHyEp+PEfEPY0R3WCwAGVOtauxh1hOxNgIf5bv7dQpA==", 17 | "requires": { 18 | "mime-types": "~2.1.24", 19 | "negotiator": "0.6.2" 20 | } 21 | }, 22 | "argparse": { 23 | "version": "1.0.10", 24 | "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", 25 | "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", 26 | "dev": true, 27 | "requires": { 28 | "sprintf-js": "~1.0.2" 29 | } 30 | }, 31 | "array-flatten": { 32 | "version": "1.1.1", 33 | "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", 34 | "integrity": "sha1-ml9pkFGx5wczKPKgCJaLZOopVdI=" 35 | }, 36 | "array-union": { 37 | "version": "1.0.2", 38 | "resolved": "https://registry.npmjs.org/array-union/-/array-union-1.0.2.tgz", 39 | "integrity": "sha1-mjRBDk9OPaI96jdb5b5w8kd47Dk=", 40 | "requires": { 41 | "array-uniq": "^1.0.1" 42 | } 43 | }, 44 | "array-uniq": { 45 | "version": "1.0.3", 46 | "resolved": "https://registry.npmjs.org/array-uniq/-/array-uniq-1.0.3.tgz", 47 | "integrity": "sha1-r2rId6Jcx/dOBYiUdThY39sk/bY=" 48 | }, 49 | "async": { 50 | "version": "2.6.3", 51 | "resolved": "https://registry.npmjs.org/async/-/async-2.6.3.tgz", 52 | "integrity": "sha512-zflvls11DCy+dQWzTW2dzuilv8Z5X/pjfmZOWba6TNIVDm+2UDaJmXSOXlasHKfNBs8oo3M0aT50fDEWfKZjXg==", 53 | "requires": { 54 | "lodash": "^4.17.14" 55 | } 56 | }, 57 | "balanced-match": { 58 | "version": "1.0.0", 59 | "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", 60 | "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=" 61 | }, 62 | "bluebird": { 63 | "version": "3.7.2", 64 | "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", 65 | "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", 66 | "dev": true 67 | }, 68 | "body-parser": { 69 | "version": "1.19.0", 70 | "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.19.0.tgz", 71 | "integrity": "sha512-dhEPs72UPbDnAQJ9ZKMNTP6ptJaionhP5cBb541nXPlW60Jepo9RV/a4fX4XWW9CuFNK22krhrj1+rgzifNCsw==", 72 | "requires": { 73 | "bytes": "3.1.0", 74 | "content-type": "~1.0.4", 75 | "debug": "2.6.9", 76 | "depd": "~1.1.2", 77 | "http-errors": "1.7.2", 78 | "iconv-lite": "0.4.24", 79 | "on-finished": "~2.3.0", 80 | "qs": "6.7.0", 81 | "raw-body": "2.4.0", 82 | "type-is": "~1.6.17" 83 | } 84 | }, 85 | "brace-expansion": { 86 | "version": "1.1.11", 87 | "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", 88 | "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", 89 | "requires": { 90 | "balanced-match": "^1.0.0", 91 | "concat-map": "0.0.1" 92 | } 93 | }, 94 | "bytes": { 95 | "version": "3.1.0", 96 | "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.0.tgz", 97 | "integrity": "sha512-zauLjrfCG+xvoyaqLoV8bLVXXNGC4JqlxFCutSDWA6fJrTo2ZuvLYTqZ7aHBLZSMOopbzwv8f+wZcVzfVTI2Dg==" 98 | }, 99 | "catharsis": { 100 | "version": "0.8.11", 101 | "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.8.11.tgz", 102 | "integrity": "sha512-a+xUyMV7hD1BrDQA/3iPV7oc+6W26BgVJO05PGEoatMyIuPScQKsde6i3YorWX1qs+AZjnJ18NqdKoCtKiNh1g==", 103 | "dev": true, 104 | "requires": { 105 | "lodash": "^4.17.14" 106 | } 107 | }, 108 | "commander": { 109 | "version": "2.20.3", 110 | "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", 111 | "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==" 112 | }, 113 | "commondir": { 114 | "version": "1.0.1", 115 | "resolved": "https://registry.npmjs.org/commondir/-/commondir-1.0.1.tgz", 116 | "integrity": "sha1-3dgA2gxmEnOTzKWVDqloo6rxJTs=" 117 | }, 118 | "concat-map": { 119 | "version": "0.0.1", 120 | "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", 121 | "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=" 122 | }, 123 | "content-disposition": { 124 | "version": "0.5.3", 125 | "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.3.tgz", 126 | "integrity": "sha512-ExO0774ikEObIAEV9kDo50o+79VCUdEB6n6lzKgGwupcVeRlhrj3qGAfwq8G6uBJjkqLrhT0qEYFcWng8z1z0g==", 127 | "requires": { 128 | "safe-buffer": "5.1.2" 129 | } 130 | }, 131 | "content-type": { 132 | "version": "1.0.4", 133 | "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.4.tgz", 134 | "integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==" 135 | }, 136 | "cookie": { 137 | "version": "0.4.0", 138 | "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.4.0.tgz", 139 | "integrity": "sha512-+Hp8fLp57wnUSt0tY0tHEXh4voZRDnoIrZPqlo3DPiI4y9lwg/jqx+1Om94/W6ZaPDOUbnjOt/99w66zk+l1Xg==" 140 | }, 141 | "cookie-signature": { 142 | "version": "1.0.6", 143 | "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.6.tgz", 144 | "integrity": "sha1-4wOogrNCzD7oylE6eZmXNNqzriw=" 145 | }, 146 | "debug": { 147 | "version": "2.6.9", 148 | "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", 149 | "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", 150 | "requires": { 151 | "ms": "2.0.0" 152 | } 153 | }, 154 | "depd": { 155 | "version": "1.1.2", 156 | "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", 157 | "integrity": "sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak=" 158 | }, 159 | "destroy": { 160 | "version": "1.0.4", 161 | "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.0.4.tgz", 162 | "integrity": "sha1-l4hXRCxEdJ5CBmE+N5RiBYJqvYA=" 163 | }, 164 | "docdash": { 165 | "version": "1.2.0", 166 | "resolved": "https://registry.npmjs.org/docdash/-/docdash-1.2.0.tgz", 167 | "integrity": "sha512-IYZbgYthPTspgqYeciRJNPhSwL51yer7HAwDXhF5p+H7mTDbPvY3PCk/QDjNxdPCpWkaJVFC4t7iCNB/t9E5Kw==" 168 | }, 169 | "ee-first": { 170 | "version": "1.1.1", 171 | "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", 172 | "integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=" 173 | }, 174 | "email-addresses": { 175 | "version": "3.1.0", 176 | "resolved": "https://registry.npmjs.org/email-addresses/-/email-addresses-3.1.0.tgz", 177 | "integrity": "sha512-k0/r7GrWVL32kZlGwfPNgB2Y/mMXVTq/decgLczm/j34whdaspNrZO8CnXPf1laaHxI6ptUlsnAxN+UAPw+fzg==" 178 | }, 179 | "encodeurl": { 180 | "version": "1.0.2", 181 | "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", 182 | "integrity": "sha1-rT/0yG7C0CkyL1oCw6mmBslbP1k=" 183 | }, 184 | "entities": { 185 | "version": "2.0.3", 186 | "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", 187 | "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==", 188 | "dev": true 189 | }, 190 | "escape-html": { 191 | "version": "1.0.3", 192 | "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", 193 | "integrity": "sha1-Aljq5NPQwJdN4cFpGI7wBR0dGYg=" 194 | }, 195 | "escape-string-regexp": { 196 | "version": "2.0.0", 197 | "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", 198 | "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", 199 | "dev": true 200 | }, 201 | "etag": { 202 | "version": "1.8.1", 203 | "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", 204 | "integrity": "sha1-Qa4u62XvpiJorr/qg6x9eSmbCIc=" 205 | }, 206 | "express": { 207 | "version": "4.17.1", 208 | "resolved": "https://registry.npmjs.org/express/-/express-4.17.1.tgz", 209 | "integrity": "sha512-mHJ9O79RqluphRrcw2X/GTh3k9tVv8YcoyY4Kkh4WDMUYKRZUq0h1o0w2rrrxBqM7VoeUVqgb27xlEMXTnYt4g==", 210 | "requires": { 211 | "accepts": "~1.3.7", 212 | "array-flatten": "1.1.1", 213 | "body-parser": "1.19.0", 214 | "content-disposition": "0.5.3", 215 | "content-type": "~1.0.4", 216 | "cookie": "0.4.0", 217 | "cookie-signature": "1.0.6", 218 | "debug": "2.6.9", 219 | "depd": "~1.1.2", 220 | "encodeurl": "~1.0.2", 221 | "escape-html": "~1.0.3", 222 | "etag": "~1.8.1", 223 | "finalhandler": "~1.1.2", 224 | "fresh": "0.5.2", 225 | "merge-descriptors": "1.0.1", 226 | "methods": "~1.1.2", 227 | "on-finished": "~2.3.0", 228 | "parseurl": "~1.3.3", 229 | "path-to-regexp": "0.1.7", 230 | "proxy-addr": "~2.0.5", 231 | "qs": "6.7.0", 232 | "range-parser": "~1.2.1", 233 | "safe-buffer": "5.1.2", 234 | "send": "0.17.1", 235 | "serve-static": "1.14.1", 236 | "setprototypeof": "1.1.1", 237 | "statuses": "~1.5.0", 238 | "type-is": "~1.6.18", 239 | "utils-merge": "1.0.1", 240 | "vary": "~1.1.2" 241 | } 242 | }, 243 | "filename-reserved-regex": { 244 | "version": "1.0.0", 245 | "resolved": "https://registry.npmjs.org/filename-reserved-regex/-/filename-reserved-regex-1.0.0.tgz", 246 | "integrity": "sha1-5hz4BfDeHJhFZ9A4bcXfUO5a9+Q=" 247 | }, 248 | "filenamify": { 249 | "version": "1.2.1", 250 | "resolved": "https://registry.npmjs.org/filenamify/-/filenamify-1.2.1.tgz", 251 | "integrity": "sha1-qfL/0RxQO+0wABUCknI3jx8TZaU=", 252 | "requires": { 253 | "filename-reserved-regex": "^1.0.0", 254 | "strip-outer": "^1.0.0", 255 | "trim-repeated": "^1.0.0" 256 | } 257 | }, 258 | "filenamify-url": { 259 | "version": "1.0.0", 260 | "resolved": "https://registry.npmjs.org/filenamify-url/-/filenamify-url-1.0.0.tgz", 261 | "integrity": "sha1-syvYExnvWGO3MHi+1Q9GpPeXX1A=", 262 | "requires": { 263 | "filenamify": "^1.0.0", 264 | "humanize-url": "^1.0.0" 265 | } 266 | }, 267 | "finalhandler": { 268 | "version": "1.1.2", 269 | "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.1.2.tgz", 270 | "integrity": "sha512-aAWcW57uxVNrQZqFXjITpW3sIUQmHGG3qSb9mUah9MgMC4NeWhNOlNjXEYq3HjRAvL6arUviZGGJsBg6z0zsWA==", 271 | "requires": { 272 | "debug": "2.6.9", 273 | "encodeurl": "~1.0.2", 274 | "escape-html": "~1.0.3", 275 | "on-finished": "~2.3.0", 276 | "parseurl": "~1.3.3", 277 | "statuses": "~1.5.0", 278 | "unpipe": "~1.0.0" 279 | } 280 | }, 281 | "find-cache-dir": { 282 | "version": "3.3.1", 283 | "resolved": "https://registry.npmjs.org/find-cache-dir/-/find-cache-dir-3.3.1.tgz", 284 | "integrity": "sha512-t2GDMt3oGC/v+BMwzmllWDuJF/xcDtE5j/fCGbqDD7OLuJkj0cfh1YSA5VKPvwMeLFLNDBkwOKZ2X85jGLVftQ==", 285 | "requires": { 286 | "commondir": "^1.0.1", 287 | "make-dir": "^3.0.2", 288 | "pkg-dir": "^4.1.0" 289 | } 290 | }, 291 | "find-up": { 292 | "version": "4.1.0", 293 | "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", 294 | "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", 295 | "requires": { 296 | "locate-path": "^5.0.0", 297 | "path-exists": "^4.0.0" 298 | } 299 | }, 300 | "forwarded": { 301 | "version": "0.1.2", 302 | "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.1.2.tgz", 303 | "integrity": "sha1-mMI9qxF1ZXuMBXPozszZGw/xjIQ=" 304 | }, 305 | "fresh": { 306 | "version": "0.5.2", 307 | "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", 308 | "integrity": "sha1-PYyt2Q2XZWn6g1qx+OSyOhBWBac=" 309 | }, 310 | "fs-extra": { 311 | "version": "8.1.0", 312 | "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", 313 | "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", 314 | "requires": { 315 | "graceful-fs": "^4.2.0", 316 | "jsonfile": "^4.0.0", 317 | "universalify": "^0.1.0" 318 | } 319 | }, 320 | "fs.realpath": { 321 | "version": "1.0.0", 322 | "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", 323 | "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=" 324 | }, 325 | "fucazu-minami": { 326 | "version": "1.1.7", 327 | "resolved": "https://registry.npmjs.org/fucazu-minami/-/fucazu-minami-1.1.7.tgz", 328 | "integrity": "sha1-0/urEjxiwrYNhJIBId4bjoLgKwA=", 329 | "dev": true 330 | }, 331 | "gh-pages": { 332 | "version": "3.1.0", 333 | "resolved": "https://registry.npmjs.org/gh-pages/-/gh-pages-3.1.0.tgz", 334 | "integrity": "sha512-3b1rly9kuf3/dXsT8+ZxP0UhNLOo1CItj+3e31yUVcaph/yDsJ9RzD7JOw5o5zpBTJVQLlJAASNkUfepi9fe2w==", 335 | "requires": { 336 | "async": "^2.6.1", 337 | "commander": "^2.18.0", 338 | "email-addresses": "^3.0.1", 339 | "filenamify-url": "^1.0.0", 340 | "find-cache-dir": "^3.3.1", 341 | "fs-extra": "^8.1.0", 342 | "globby": "^6.1.0" 343 | } 344 | }, 345 | "glob": { 346 | "version": "7.1.6", 347 | "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", 348 | "integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==", 349 | "requires": { 350 | "fs.realpath": "^1.0.0", 351 | "inflight": "^1.0.4", 352 | "inherits": "2", 353 | "minimatch": "^3.0.4", 354 | "once": "^1.3.0", 355 | "path-is-absolute": "^1.0.0" 356 | } 357 | }, 358 | "globby": { 359 | "version": "6.1.0", 360 | "resolved": "https://registry.npmjs.org/globby/-/globby-6.1.0.tgz", 361 | "integrity": "sha1-9abXDoOV4hyFj7BInWTfAkJNUGw=", 362 | "requires": { 363 | "array-union": "^1.0.1", 364 | "glob": "^7.0.3", 365 | "object-assign": "^4.0.1", 366 | "pify": "^2.0.0", 367 | "pinkie-promise": "^2.0.0" 368 | } 369 | }, 370 | "graceful-fs": { 371 | "version": "4.2.4", 372 | "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.4.tgz", 373 | "integrity": "sha512-WjKPNJF79dtJAVniUlGGWHYGz2jWxT6VhN/4m1NdkbZ2nOsEF+cI1Edgql5zCRhs/VsQYRvrXctxktVXZUkixw==" 374 | }, 375 | "http-errors": { 376 | "version": "1.7.2", 377 | "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.7.2.tgz", 378 | "integrity": "sha512-uUQBt3H/cSIVfch6i1EuPNy/YsRSOUBXTVfZ+yR7Zjez3qjBz6i9+i4zjNaoqcoFVI4lQJ5plg63TvGfRSDCRg==", 379 | "requires": { 380 | "depd": "~1.1.2", 381 | "inherits": "2.0.3", 382 | "setprototypeof": "1.1.1", 383 | "statuses": ">= 1.5.0 < 2", 384 | "toidentifier": "1.0.0" 385 | } 386 | }, 387 | "humanize-url": { 388 | "version": "1.0.1", 389 | "resolved": "https://registry.npmjs.org/humanize-url/-/humanize-url-1.0.1.tgz", 390 | "integrity": "sha1-9KuZ4NKIF0yk4eUEB8VfuuRk7/8=", 391 | "requires": { 392 | "normalize-url": "^1.0.0", 393 | "strip-url-auth": "^1.0.0" 394 | } 395 | }, 396 | "iconv-lite": { 397 | "version": "0.4.24", 398 | "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", 399 | "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", 400 | "requires": { 401 | "safer-buffer": ">= 2.1.2 < 3" 402 | } 403 | }, 404 | "inflight": { 405 | "version": "1.0.6", 406 | "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", 407 | "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", 408 | "requires": { 409 | "once": "^1.3.0", 410 | "wrappy": "1" 411 | } 412 | }, 413 | "inherits": { 414 | "version": "2.0.3", 415 | "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", 416 | "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" 417 | }, 418 | "ipaddr.js": { 419 | "version": "1.9.1", 420 | "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", 421 | "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==" 422 | }, 423 | "is-plain-obj": { 424 | "version": "1.1.0", 425 | "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz", 426 | "integrity": "sha1-caUMhCnfync8kqOQpKA7OfzVHT4=" 427 | }, 428 | "js2xmlparser": { 429 | "version": "4.0.1", 430 | "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.1.tgz", 431 | "integrity": "sha512-KrPTolcw6RocpYjdC7pL7v62e55q7qOMHvLX1UCLc5AAS8qeJ6nukarEJAF2KL2PZxlbGueEbINqZR2bDe/gUw==", 432 | "dev": true, 433 | "requires": { 434 | "xmlcreate": "^2.0.3" 435 | } 436 | }, 437 | "jsdoc": { 438 | "version": "3.6.6", 439 | "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.6.tgz", 440 | "integrity": "sha512-znR99e1BHeyEkSvgDDpX0sTiTu+8aQyDl9DawrkOGZTTW8hv0deIFXx87114zJ7gRaDZKVQD/4tr1ifmJp9xhQ==", 441 | "dev": true, 442 | "requires": { 443 | "@babel/parser": "^7.9.4", 444 | "bluebird": "^3.7.2", 445 | "catharsis": "^0.8.11", 446 | "escape-string-regexp": "^2.0.0", 447 | "js2xmlparser": "^4.0.1", 448 | "klaw": "^3.0.0", 449 | "markdown-it": "^10.0.0", 450 | "markdown-it-anchor": "^5.2.7", 451 | "marked": "^0.8.2", 452 | "mkdirp": "^1.0.4", 453 | "requizzle": "^0.2.3", 454 | "strip-json-comments": "^3.1.0", 455 | "taffydb": "2.6.2", 456 | "underscore": "~1.10.2" 457 | } 458 | }, 459 | "jsdoc-http-plugin": { 460 | "version": "0.3.2", 461 | "resolved": "https://registry.npmjs.org/jsdoc-http-plugin/-/jsdoc-http-plugin-0.3.2.tgz", 462 | "integrity": "sha512-BoTD3kDu+bvl2MVp1NnSPYwyz4JRzcrufV5bN4kH7uqt4jwu5xBKpFF7VVk/eTDem3EBUQ2SvVfog71F1kTkjg==", 463 | "dev": true, 464 | "requires": { 465 | "jsdoc": "^3.4.3" 466 | } 467 | }, 468 | "jsdoc-template": { 469 | "version": "git+https://github.com/braintree/jsdoc-template.git#a69b52b77f707b800e224860c2bb87c414411c4d", 470 | "from": "git+https://github.com/braintree/jsdoc-template.git" 471 | }, 472 | "jsonfile": { 473 | "version": "4.0.0", 474 | "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", 475 | "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", 476 | "requires": { 477 | "graceful-fs": "^4.1.6" 478 | } 479 | }, 480 | "klaw": { 481 | "version": "3.0.0", 482 | "resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz", 483 | "integrity": "sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==", 484 | "dev": true, 485 | "requires": { 486 | "graceful-fs": "^4.1.9" 487 | } 488 | }, 489 | "linkify-it": { 490 | "version": "2.2.0", 491 | "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-2.2.0.tgz", 492 | "integrity": "sha512-GnAl/knGn+i1U/wjBz3akz2stz+HrHLsxMwHQGofCDfPvlf+gDKN58UtfmUquTY4/MXeE2x7k19KQmeoZi94Iw==", 493 | "dev": true, 494 | "requires": { 495 | "uc.micro": "^1.0.1" 496 | } 497 | }, 498 | "locate-path": { 499 | "version": "5.0.0", 500 | "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", 501 | "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", 502 | "requires": { 503 | "p-locate": "^4.1.0" 504 | } 505 | }, 506 | "lodash": { 507 | "version": "4.17.20", 508 | "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.20.tgz", 509 | "integrity": "sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA==" 510 | }, 511 | "make-dir": { 512 | "version": "3.1.0", 513 | "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", 514 | "integrity": "sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==", 515 | "requires": { 516 | "semver": "^6.0.0" 517 | } 518 | }, 519 | "markdown-it": { 520 | "version": "10.0.0", 521 | "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-10.0.0.tgz", 522 | "integrity": "sha512-YWOP1j7UbDNz+TumYP1kpwnP0aEa711cJjrAQrzd0UXlbJfc5aAq0F/PZHjiioqDC1NKgvIMX+o+9Bk7yuM2dg==", 523 | "dev": true, 524 | "requires": { 525 | "argparse": "^1.0.7", 526 | "entities": "~2.0.0", 527 | "linkify-it": "^2.0.0", 528 | "mdurl": "^1.0.1", 529 | "uc.micro": "^1.0.5" 530 | } 531 | }, 532 | "markdown-it-anchor": { 533 | "version": "5.3.0", 534 | "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-5.3.0.tgz", 535 | "integrity": "sha512-/V1MnLL/rgJ3jkMWo84UR+K+jF1cxNG1a+KwqeXqTIJ+jtA8aWSHuigx8lTzauiIjBDbwF3NcWQMotd0Dm39jA==", 536 | "dev": true 537 | }, 538 | "marked": { 539 | "version": "0.8.2", 540 | "resolved": "https://registry.npmjs.org/marked/-/marked-0.8.2.tgz", 541 | "integrity": "sha512-EGwzEeCcLniFX51DhTpmTom+dSA/MG/OBUDjnWtHbEnjAH180VzUeAw+oE4+Zv+CoYBWyRlYOTR0N8SO9R1PVw==", 542 | "dev": true 543 | }, 544 | "mdurl": { 545 | "version": "1.0.1", 546 | "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", 547 | "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=", 548 | "dev": true 549 | }, 550 | "media-typer": { 551 | "version": "0.3.0", 552 | "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", 553 | "integrity": "sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=" 554 | }, 555 | "merge-descriptors": { 556 | "version": "1.0.1", 557 | "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz", 558 | "integrity": "sha1-sAqqVW3YtEVoFQ7J0blT8/kMu2E=" 559 | }, 560 | "methods": { 561 | "version": "1.1.2", 562 | "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", 563 | "integrity": "sha1-VSmk1nZUE07cxSZmVoNbD4Ua/O4=" 564 | }, 565 | "mime": { 566 | "version": "1.6.0", 567 | "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", 568 | "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==" 569 | }, 570 | "mime-db": { 571 | "version": "1.44.0", 572 | "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.44.0.tgz", 573 | "integrity": "sha512-/NOTfLrsPBVeH7YtFPgsVWveuL+4SjjYxaQ1xtM1KMFj7HdxlBlxeyNLzhyJVx7r4rZGJAZ/6lkKCitSc/Nmpg==" 574 | }, 575 | "mime-types": { 576 | "version": "2.1.27", 577 | "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.27.tgz", 578 | "integrity": "sha512-JIhqnCasI9yD+SsmkquHBxTSEuZdQX5BuQnS2Vc7puQQQ+8yiP5AY5uWhpdv4YL4VM5c6iliiYWPgJ/nJQLp7w==", 579 | "requires": { 580 | "mime-db": "1.44.0" 581 | } 582 | }, 583 | "minami": { 584 | "version": "1.2.3", 585 | "resolved": "https://registry.npmjs.org/minami/-/minami-1.2.3.tgz", 586 | "integrity": "sha1-mbbc37LwpU2hycj3qjoyd4eq+fg=" 587 | }, 588 | "minimatch": { 589 | "version": "3.0.4", 590 | "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", 591 | "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", 592 | "requires": { 593 | "brace-expansion": "^1.1.7" 594 | } 595 | }, 596 | "mkdirp": { 597 | "version": "1.0.4", 598 | "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", 599 | "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", 600 | "dev": true 601 | }, 602 | "ms": { 603 | "version": "2.0.0", 604 | "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", 605 | "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" 606 | }, 607 | "negotiator": { 608 | "version": "0.6.2", 609 | "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.2.tgz", 610 | "integrity": "sha512-hZXc7K2e+PgeI1eDBe/10Ard4ekbfrrqG8Ep+8Jmf4JID2bNg7NvCPOZN+kfF574pFQI7mum2AUqDidoKqcTOw==" 611 | }, 612 | "normalize-url": { 613 | "version": "1.9.1", 614 | "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-1.9.1.tgz", 615 | "integrity": "sha1-LMDWazHqIwNkWENuNiDYWVTGbDw=", 616 | "requires": { 617 | "object-assign": "^4.0.1", 618 | "prepend-http": "^1.0.0", 619 | "query-string": "^4.1.0", 620 | "sort-keys": "^1.0.0" 621 | } 622 | }, 623 | "object-assign": { 624 | "version": "4.1.1", 625 | "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", 626 | "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=" 627 | }, 628 | "on-finished": { 629 | "version": "2.3.0", 630 | "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.3.0.tgz", 631 | "integrity": "sha1-IPEzZIGwg811M3mSoWlxqi2QaUc=", 632 | "requires": { 633 | "ee-first": "1.1.1" 634 | } 635 | }, 636 | "once": { 637 | "version": "1.4.0", 638 | "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", 639 | "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", 640 | "requires": { 641 | "wrappy": "1" 642 | } 643 | }, 644 | "p-limit": { 645 | "version": "2.3.0", 646 | "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", 647 | "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", 648 | "requires": { 649 | "p-try": "^2.0.0" 650 | } 651 | }, 652 | "p-locate": { 653 | "version": "4.1.0", 654 | "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", 655 | "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", 656 | "requires": { 657 | "p-limit": "^2.2.0" 658 | } 659 | }, 660 | "p-try": { 661 | "version": "2.2.0", 662 | "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", 663 | "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==" 664 | }, 665 | "parseurl": { 666 | "version": "1.3.3", 667 | "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", 668 | "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==" 669 | }, 670 | "path-exists": { 671 | "version": "4.0.0", 672 | "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", 673 | "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==" 674 | }, 675 | "path-is-absolute": { 676 | "version": "1.0.1", 677 | "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", 678 | "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=" 679 | }, 680 | "path-to-regexp": { 681 | "version": "0.1.7", 682 | "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.7.tgz", 683 | "integrity": "sha1-32BBeABfUi8V60SQ5yR6G/qmf4w=" 684 | }, 685 | "pify": { 686 | "version": "2.3.0", 687 | "resolved": "https://registry.npmjs.org/pify/-/pify-2.3.0.tgz", 688 | "integrity": "sha1-7RQaasBDqEnqWISY59yosVMw6Qw=" 689 | }, 690 | "pinkie": { 691 | "version": "2.0.4", 692 | "resolved": "https://registry.npmjs.org/pinkie/-/pinkie-2.0.4.tgz", 693 | "integrity": "sha1-clVrgM+g1IqXToDnckjoDtT3+HA=" 694 | }, 695 | "pinkie-promise": { 696 | "version": "2.0.1", 697 | "resolved": "https://registry.npmjs.org/pinkie-promise/-/pinkie-promise-2.0.1.tgz", 698 | "integrity": "sha1-ITXW36ejWMBprJsXh3YogihFD/o=", 699 | "requires": { 700 | "pinkie": "^2.0.0" 701 | } 702 | }, 703 | "pkg-dir": { 704 | "version": "4.2.0", 705 | "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-4.2.0.tgz", 706 | "integrity": "sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==", 707 | "requires": { 708 | "find-up": "^4.0.0" 709 | } 710 | }, 711 | "prepend-http": { 712 | "version": "1.0.4", 713 | "resolved": "https://registry.npmjs.org/prepend-http/-/prepend-http-1.0.4.tgz", 714 | "integrity": "sha1-1PRWKwzjaW5BrFLQ4ALlemNdxtw=" 715 | }, 716 | "proxy-addr": { 717 | "version": "2.0.6", 718 | "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.6.tgz", 719 | "integrity": "sha512-dh/frvCBVmSsDYzw6n926jv974gddhkFPfiN8hPOi30Wax25QZyZEGveluCgliBnqmuM+UJmBErbAUFIoDbjOw==", 720 | "requires": { 721 | "forwarded": "~0.1.2", 722 | "ipaddr.js": "1.9.1" 723 | } 724 | }, 725 | "qs": { 726 | "version": "6.7.0", 727 | "resolved": "https://registry.npmjs.org/qs/-/qs-6.7.0.tgz", 728 | "integrity": "sha512-VCdBRNFTX1fyE7Nb6FYoURo/SPe62QCaAyzJvUjwRaIsc+NePBEniHlvxFmmX56+HZphIGtV0XeCirBtpDrTyQ==" 729 | }, 730 | "query-string": { 731 | "version": "4.3.4", 732 | "resolved": "https://registry.npmjs.org/query-string/-/query-string-4.3.4.tgz", 733 | "integrity": "sha1-u7aTucqRXCMlFbIosaArYJBD2+s=", 734 | "requires": { 735 | "object-assign": "^4.1.0", 736 | "strict-uri-encode": "^1.0.0" 737 | } 738 | }, 739 | "range-parser": { 740 | "version": "1.2.1", 741 | "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", 742 | "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==" 743 | }, 744 | "raw-body": { 745 | "version": "2.4.0", 746 | "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.4.0.tgz", 747 | "integrity": "sha512-4Oz8DUIwdvoa5qMJelxipzi/iJIi40O5cGV1wNYp5hvZP8ZN0T+jiNkL0QepXs+EsQ9XJ8ipEDoiH70ySUJP3Q==", 748 | "requires": { 749 | "bytes": "3.1.0", 750 | "http-errors": "1.7.2", 751 | "iconv-lite": "0.4.24", 752 | "unpipe": "1.0.0" 753 | } 754 | }, 755 | "requizzle": { 756 | "version": "0.2.3", 757 | "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.3.tgz", 758 | "integrity": "sha512-YanoyJjykPxGHii0fZP0uUPEXpvqfBDxWV7s6GKAiiOsiqhX6vHNyW3Qzdmqp/iq/ExbhaGbVrjB4ruEVSM4GQ==", 759 | "dev": true, 760 | "requires": { 761 | "lodash": "^4.17.14" 762 | } 763 | }, 764 | "rimraf": { 765 | "version": "3.0.2", 766 | "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", 767 | "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", 768 | "dev": true, 769 | "requires": { 770 | "glob": "^7.1.3" 771 | } 772 | }, 773 | "safe-buffer": { 774 | "version": "5.1.2", 775 | "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", 776 | "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==" 777 | }, 778 | "safer-buffer": { 779 | "version": "2.1.2", 780 | "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", 781 | "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" 782 | }, 783 | "semver": { 784 | "version": "6.3.0", 785 | "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", 786 | "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==" 787 | }, 788 | "send": { 789 | "version": "0.17.1", 790 | "resolved": "https://registry.npmjs.org/send/-/send-0.17.1.tgz", 791 | "integrity": "sha512-BsVKsiGcQMFwT8UxypobUKyv7irCNRHk1T0G680vk88yf6LBByGcZJOTJCrTP2xVN6yI+XjPJcNuE3V4fT9sAg==", 792 | "requires": { 793 | "debug": "2.6.9", 794 | "depd": "~1.1.2", 795 | "destroy": "~1.0.4", 796 | "encodeurl": "~1.0.2", 797 | "escape-html": "~1.0.3", 798 | "etag": "~1.8.1", 799 | "fresh": "0.5.2", 800 | "http-errors": "~1.7.2", 801 | "mime": "1.6.0", 802 | "ms": "2.1.1", 803 | "on-finished": "~2.3.0", 804 | "range-parser": "~1.2.1", 805 | "statuses": "~1.5.0" 806 | }, 807 | "dependencies": { 808 | "ms": { 809 | "version": "2.1.1", 810 | "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", 811 | "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==" 812 | } 813 | } 814 | }, 815 | "serve-static": { 816 | "version": "1.14.1", 817 | "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.14.1.tgz", 818 | "integrity": "sha512-JMrvUwE54emCYWlTI+hGrGv5I8dEwmco/00EvkzIIsR7MqrHonbD9pO2MOfFnpFntl7ecpZs+3mW+XbQZu9QCg==", 819 | "requires": { 820 | "encodeurl": "~1.0.2", 821 | "escape-html": "~1.0.3", 822 | "parseurl": "~1.3.3", 823 | "send": "0.17.1" 824 | } 825 | }, 826 | "setprototypeof": { 827 | "version": "1.1.1", 828 | "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.1.tgz", 829 | "integrity": "sha512-JvdAWfbXeIGaZ9cILp38HntZSFSo3mWg6xGcJJsd+d4aRMOqauag1C63dJfDw7OaMYwEbHMOxEZ1lqVRYP2OAw==" 830 | }, 831 | "sort-keys": { 832 | "version": "1.1.2", 833 | "resolved": "https://registry.npmjs.org/sort-keys/-/sort-keys-1.1.2.tgz", 834 | "integrity": "sha1-RBttTTRnmPG05J6JIK37oOVD+a0=", 835 | "requires": { 836 | "is-plain-obj": "^1.0.0" 837 | } 838 | }, 839 | "sprintf-js": { 840 | "version": "1.0.3", 841 | "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", 842 | "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", 843 | "dev": true 844 | }, 845 | "statuses": { 846 | "version": "1.5.0", 847 | "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", 848 | "integrity": "sha1-Fhx9rBd2Wf2YEfQ3cfqZOBR4Yow=" 849 | }, 850 | "strict-uri-encode": { 851 | "version": "1.1.0", 852 | "resolved": "https://registry.npmjs.org/strict-uri-encode/-/strict-uri-encode-1.1.0.tgz", 853 | "integrity": "sha1-J5siXfHVgrH1TmWt3UNS4Y+qBxM=" 854 | }, 855 | "strip-json-comments": { 856 | "version": "3.1.1", 857 | "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", 858 | "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", 859 | "dev": true 860 | }, 861 | "strip-outer": { 862 | "version": "1.0.1", 863 | "resolved": "https://registry.npmjs.org/strip-outer/-/strip-outer-1.0.1.tgz", 864 | "integrity": "sha512-k55yxKHwaXnpYGsOzg4Vl8+tDrWylxDEpknGjhTiZB8dFRU5rTo9CAzeycivxV3s+zlTKwrs6WxMxR95n26kwg==", 865 | "requires": { 866 | "escape-string-regexp": "^1.0.2" 867 | }, 868 | "dependencies": { 869 | "escape-string-regexp": { 870 | "version": "1.0.5", 871 | "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", 872 | "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=" 873 | } 874 | } 875 | }, 876 | "strip-url-auth": { 877 | "version": "1.0.1", 878 | "resolved": "https://registry.npmjs.org/strip-url-auth/-/strip-url-auth-1.0.1.tgz", 879 | "integrity": "sha1-IrD6OkE4WzO+PzMVUbu4N/oM164=" 880 | }, 881 | "taffydb": { 882 | "version": "2.6.2", 883 | "resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz", 884 | "integrity": "sha1-fLy2S1oUG2ou/CxdLGe04VCyomg=", 885 | "dev": true 886 | }, 887 | "toidentifier": { 888 | "version": "1.0.0", 889 | "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.0.tgz", 890 | "integrity": "sha512-yaOH/Pk/VEhBWWTlhI+qXxDFXlejDGcQipMlyxda9nthulaxLZUNcUqFxokp0vcYnvteJln5FNQDRrxj3YcbVw==" 891 | }, 892 | "trim-repeated": { 893 | "version": "1.0.0", 894 | "resolved": "https://registry.npmjs.org/trim-repeated/-/trim-repeated-1.0.0.tgz", 895 | "integrity": "sha1-42RqLqTokTEr9+rObPsFOAvAHCE=", 896 | "requires": { 897 | "escape-string-regexp": "^1.0.2" 898 | }, 899 | "dependencies": { 900 | "escape-string-regexp": { 901 | "version": "1.0.5", 902 | "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", 903 | "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=" 904 | } 905 | } 906 | }, 907 | "type-is": { 908 | "version": "1.6.18", 909 | "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", 910 | "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", 911 | "requires": { 912 | "media-typer": "0.3.0", 913 | "mime-types": "~2.1.24" 914 | } 915 | }, 916 | "uc.micro": { 917 | "version": "1.0.6", 918 | "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", 919 | "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", 920 | "dev": true 921 | }, 922 | "underscore": { 923 | "version": "1.10.2", 924 | "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.10.2.tgz", 925 | "integrity": "sha512-N4P+Q/BuyuEKFJ43B9gYuOj4TQUHXX+j2FqguVOpjkssLUUrnJofCcBccJSCoeturDoZU6GorDTHSvUDlSQbTg==", 926 | "dev": true 927 | }, 928 | "universalify": { 929 | "version": "0.1.2", 930 | "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", 931 | "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==" 932 | }, 933 | "unpipe": { 934 | "version": "1.0.0", 935 | "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", 936 | "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=" 937 | }, 938 | "utils-merge": { 939 | "version": "1.0.1", 940 | "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", 941 | "integrity": "sha1-n5VxD1CiZ5R7LMwSR0HBAoQn5xM=" 942 | }, 943 | "vary": { 944 | "version": "1.1.2", 945 | "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", 946 | "integrity": "sha1-IpnwLG3tMNSllhsLn3RSShj2NPw=" 947 | }, 948 | "wrappy": { 949 | "version": "1.0.2", 950 | "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", 951 | "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=" 952 | }, 953 | "xmlcreate": { 954 | "version": "2.0.3", 955 | "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.3.tgz", 956 | "integrity": "sha512-HgS+X6zAztGa9zIK3Y3LXuJes33Lz9x+YyTxgrkIdabu2vqcGOWwdfCpf1hWLRrd553wd4QCDf6BBO6FfdsRiQ==", 957 | "dev": true 958 | } 959 | } 960 | } 961 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "jsdoc-tutorial", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "index.js", 6 | "scripts": { 7 | "docs": "jsdoc -c jsdoc.json", 8 | "clean": "rimraf docs", 9 | "docs:deploy": "npm run clean && npm run docs && gh-pages -d docs" 10 | }, 11 | "keywords": [], 12 | "author": "", 13 | "license": "ISC", 14 | "devDependencies": { 15 | "fucazu-minami": "^1.1.7", 16 | "jsdoc": "^3.6.6", 17 | "jsdoc-http-plugin": "^0.3.2", 18 | "rimraf": "^3.0.2" 19 | }, 20 | "dependencies": { 21 | "docdash": "^1.2.0", 22 | "express": "^4.17.1", 23 | "gh-pages": "^3.1.0", 24 | "jsdoc-template": "git+https://github.com/braintree/jsdoc-template.git", 25 | "minami": "^1.2.3" 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/arrays.js: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * Just an Array 4 | * @type {Array} 5 | */ 6 | const age = [18, 22, 17, 30, true, {}, "hello"]; 7 | 8 | /** 9 | * Array of Number 10 | * @type {Array} 11 | */ 12 | const scores = [10, 19.9, 20.0, 33,3, 17.4 ]; 13 | // const scores = [10, 19.9, 20.0, 33,3, 17.4, true]; 14 | 15 | /** 16 | * Arrays of intengers and strings 17 | * @type {Array} 18 | */ 19 | const strnum = [10, 20, "30", 110, 100]; 20 | 21 | /** 22 | * Arrays of names 23 | * @type {Array} 24 | */ 25 | 26 | const names = ["ryan", "joe", "carlos"]; 27 | // names.push(33); -------------------------------------------------------------------------------- /src/browser.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Generates a Table Head 3 | * @param {HTMLTableElement} table The Target Table 4 | * @param {Array} data An array of string names 5 | * @returns {void} 6 | * @author Fazt 7 | */ 8 | function generateTableHead(table, data) { 9 | const thead = table.createTHead(); 10 | const row = thead.insertRow(); 11 | for (const i of data) { 12 | const th = document.createElement("th"); 13 | const text = document.createTextNode(i); 14 | 15 | th.appendChild(text); 16 | row.appendChild(th); 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/class.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Class to create a Programmer 3 | */ 4 | 5 | class Programmer { 6 | /** 7 | * 8 | * @param {Object} user User's Information 9 | * @param {string} language A programming language name 10 | */ 11 | constructor(user, language) { 12 | /** 13 | * @property {string} fullname Programmer's FullName 14 | */ 15 | this.fullname = user.fullname; 16 | /** 17 | * @property {string} language The Programmer's Programming language 18 | */ 19 | this.language = language; 20 | } 21 | 22 | /** 23 | * 24 | * @property {Function} getInfo Get the Programmer's Info 25 | * @returns {void} 26 | */ 27 | getInfo() { 28 | console.log( 29 | `I'm ${this.fullname} and my favorite programming language is ${this.language}` 30 | ); 31 | } 32 | } 33 | 34 | /** 35 | * Know more in {@link Programmer} 36 | */ 37 | const newProgrammer = new Programmer({ fullname: "Ryan Ray" }, "golang"); 38 | newProgrammer.getInfo(); 39 | 40 | /** 41 | * Github Library 42 | * @example 43 | * const github = new Github({ 44 | * username: 'fazt', 45 | * token: 'xyz123' 46 | * }); 47 | * 48 | * const repositories = github.getRepositories(); 49 | * 50 | * @see https://developer.github.com/v3/repos/#list-public-repositories 51 | * 52 | * @todo Implement the rest of methods 53 | */ 54 | class Github { 55 | /** 56 | * @param {Object} options 57 | * @param {string} options.user your username 58 | * @param {string} options.token secret token 59 | */ 60 | constructor({ user, token }) { 61 | this.user = user; 62 | this.token = token; 63 | } 64 | 65 | /** 66 | * List of all Public User's Repositories 67 | * @param {Object} options 68 | * @param {Number} [options.limit=6] The limit of respositories to return 69 | * @return {Array} An array of public repositories 70 | */ 71 | getRepositories({ limit = 6 }) { 72 | return []; 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /src/custom-types.js: -------------------------------------------------------------------------------- 1 | /** 2 | * A User 3 | * @typedef {Object} User 4 | * @property {number} id User Id 5 | * @property {string} name User Name 6 | * @property {number|string} [age] User Age (optional) 7 | * @property {boolean} isActive User is active 8 | */ 9 | 10 | /** 11 | * @type {User} 12 | */ 13 | const myNewUser = { 14 | id: 1, 15 | name: 'Ryan', 16 | isActive: true, 17 | age: 30 18 | }; -------------------------------------------------------------------------------- /src/functions.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Add Two numbers 3 | * @param {number} n1 first Number 4 | * @param {number} n2 second Number 5 | * @returns {number} - Total Addition 6 | */ 7 | function addTwoNumber(n1, n2) { 8 | return n1 + n2; 9 | } 10 | 11 | /** 12 | * Add Two numbers and returns a string 13 | * @param {number} n1 first Number 14 | * @param {number} n2 second Number 15 | * @returns {string} - a text with the response 16 | */ 17 | function addTwo(n1, n2) { 18 | return `The result is ${n1 + n2}`; 19 | } -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Hello world 3 | * @file index.js is the main file 4 | * @author Fazt 5 | * @see Fazt Tech 6 | */ -------------------------------------------------------------------------------- /src/lib/myMath.js: -------------------------------------------------------------------------------- 1 | /** 2 | * My Math Library - Learn More {@tutorial first-tutorial} 3 | * @module Math 4 | */ 5 | 6 | /** 7 | * Add two numbers 8 | * @param {number} x - First Number 9 | * @param { number} y - Second Number 10 | * @returns {number} - Sum of x and y 11 | */ 12 | const add = (x, y) => x + y; 13 | 14 | /** 15 | * Subtract numbers 16 | * @param {number} x - First Number 17 | * @param { number} y - Second Number 18 | * @returns {number} - Subtract of x and y 19 | */ 20 | const subtract = (x, y) => x - y; 21 | -------------------------------------------------------------------------------- /src/objets.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Person Object 3 | * @type {{id: number, firstName: string, lastName: string, age: number}} 4 | */ 5 | const person = { 6 | id: 1, 7 | firstName: "Rayn", 8 | lastName: "Ray", 9 | age: 27, 10 | }; 11 | 12 | /** 13 | * Person Object 14 | * @type {{id: number | string, firstName: string, lastName: string, age: number | string}} 15 | */ 16 | const person2 = { 17 | id: 1, 18 | firstName: "Joe", 19 | lastName: "McMillan", 20 | age: "35", 21 | }; 22 | -------------------------------------------------------------------------------- /src/server.js: -------------------------------------------------------------------------------- 1 | const express = require("express"); 2 | const app = express(); 3 | 4 | /** 5 | * Get All Users 6 | * @name List Users 7 | * @path {GET} /api/users 8 | */ 9 | app.get("/api/users", (req, res) => { 10 | res.json({ users: [] }); 11 | }); 12 | 13 | app.get("/api/products", (req, res) => { 14 | res.json({ products: [] }); 15 | }); 16 | 17 | app.get("/api/auth", (req, res) => { 18 | res.json({ token: "xyz123" }); 19 | }); 20 | 21 | app.listen(3000); 22 | console.log("Server on port", 3000); 23 | -------------------------------------------------------------------------------- /src/strings.js: -------------------------------------------------------------------------------- 1 | /** 2 | * User's FullName 3 | * @type {string} 4 | */ 5 | const fullName = "Ryn Ray"; -------------------------------------------------------------------------------- /tutorials/first-tutorial.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Document 7 | 8 | 9 | 10 |

Welcome to the first tutorial

11 |

Lorem ipsum dolor sit amet consectetur adipisicing elit. Perferendis voluptatibus eum expedita illo vel eveniet eius culpa cum natus numquam minus quae dolorem tempore pariatur consequatur corporis, deserunt minima, quidem unde facere amet fugiat maiores nesciunt? Hic pariatur dolores unde iusto laboriosam dolor! Quia quod, expedita iusto non ad, laborum blanditiis accusamus nam dicta dignissimos quo tenetur ullam ab beatae dolores quis dolorem praesentium ducimus architecto laboriosam quos ea vel. Voluptas nostrum, a quia hic dolor natus odit ducimus nihil officia quae impedit temporibus magnam porro aperiam minus. Dignissimos iusto nostrum vel libero totam, magni suscipit quod ipsa quia velit?

12 | 13 | 14 | -------------------------------------------------------------------------------- /tutorials/second-tutorial.md: -------------------------------------------------------------------------------- 1 | # Second tutorial 2 | 3 | first execute this command 4 | ``` 5 | npm i faztweb 6 | ``` -------------------------------------------------------------------------------- /tutorials/tutorials.json: -------------------------------------------------------------------------------- 1 | { 2 | "first-tutorial": { 3 | "title": "Getting Started" 4 | }, 5 | "second-tutorial": { 6 | "title": "Installation" 7 | } 8 | } --------------------------------------------------------------------------------