diff --git a/CHANGELOG.md b/CHANGELOG.md index 133d4ae..11bf425 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,19 @@ +## v1.0.0-beta.26 + +### Enhancement + +- Enables using `--default-expiration` CLI flag alongside a config file. In the case of it being specified in both locations the CLI flag value takes precedence. [change](https://github.com/ominestre/rotten-deps/pull/83) +- Adds `reason` property to the rules for making notes on why you whitelisted a dependency [change](https://github.com/ominestre/rotten-deps/pull/84) + +### Documentation + +- Replaces unmaintained typedoc pages plugin [change](https://github.com/ominestre/rotten-deps/pull/82) +- Revises the release and config docs. The config docs were missing a property and the formatting was changed for better readability at a glance. [change](https://github.com/ominestre/rotten-deps/pull/80) + +### Chores + +- Replaces `cli-table` with `cli-table3` since the former is no longer maintained + ## 1.0.0-beta.25 ### Enhancements diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 0000000..e806dcc --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,78 @@ +:root { + --light-hl-0: #000000; + --dark-hl-0: #C8C8C8; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #001080; + --dark-hl-3: #9CDCFE; + --light-hl-4: #008000; + --dark-hl-4: #6A9955; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #0451A5; + --dark-hl-6: #9CDCFE; + --light-hl-7: #098658; + --dark-hl-7: #B5CEA8; + --light-code-background: #F5F5F5; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --code-background: var(--dark-code-background); +} } + +body.light { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --code-background: var(--light-code-background); +} + +body.dark { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.css b/docs/assets/icons.css new file mode 100644 index 0000000..776a356 --- /dev/null +++ b/docs/assets/icons.css @@ -0,0 +1,1043 @@ +.tsd-kind-icon { + display: block; + position: relative; + padding-left: 20px; + text-indent: -20px; +} +.tsd-kind-icon:before { + content: ""; + display: inline-block; + vertical-align: middle; + width: 17px; + height: 17px; + margin: 0 3px 2px 0; + background-image: url(./icons.png); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-kind-icon:before { + background-image: url(./icons@2x.png); + background-size: 238px 204px; + } +} + +.tsd-signature.tsd-kind-icon:before { + background-position: 0 -153px; +} + +.tsd-kind-object-literal > .tsd-kind-icon:before { + background-position: 0px -17px; +} +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -17px; +} +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -17px; +} + +.tsd-kind-class > .tsd-kind-icon:before { + background-position: 0px -34px; +} +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -34px; +} +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -34px; +} + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -51px; +} + +.tsd-kind-interface > .tsd-kind-icon:before { + background-position: 0px -68px; +} +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -68px; +} +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -68px; +} + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -34px -85px; +} + +.tsd-kind-namespace > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-module > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-enum > .tsd-kind-icon:before { + background-position: 0px -119px; +} +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -119px; +} +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -119px; +} + +.tsd-kind-enum-member > .tsd-kind-icon:before { + background-position: 0px -136px; +} +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -136px; +} +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -136px; +} + +.tsd-kind-signature > .tsd-kind-icon:before { + background-position: 0px -153px; +} +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -153px; +} +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -153px; +} + +.tsd-kind-type-alias > .tsd-kind-icon:before { + background-position: 0px -170px; +} +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -170px; +} +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -170px; +} + +.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -34px -187px; +} + +.tsd-kind-variable > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-property > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-get-signature > .tsd-kind-icon:before { + background-position: -136px -17px; +} +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -17px; +} +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -17px; +} + +.tsd-kind-set-signature > .tsd-kind-icon:before { + background-position: -136px -34px; +} +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -34px; +} +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -34px; +} + +.tsd-kind-accessor > .tsd-kind-icon:before { + background-position: -136px -51px; +} +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -51px; +} +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -51px; +} + +.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-constructor > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-index-signature > .tsd-kind-icon:before { + background-position: -136px -119px; +} +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -119px; +} +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -119px; +} + +.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -136px; +} +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -136px; +} +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -136px; +} + +.tsd-is-static > .tsd-kind-icon:before { + background-position: -136px -153px; +} +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -153px; +} +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -153px; +} +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -153px; +} + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -187px; +} diff --git a/docs/assets/icons.png b/docs/assets/icons.png new file mode 100644 index 0000000..3836d5f Binary files /dev/null and b/docs/assets/icons.png differ diff --git a/docs/assets/icons@2x.png b/docs/assets/icons@2x.png new file mode 100644 index 0000000..5a209e2 Binary files /dev/null and b/docs/assets/icons@2x.png differ diff --git a/docs/assets/main.js b/docs/assets/main.js new file mode 100644 index 0000000..29b78d0 --- /dev/null +++ b/docs/assets/main.js @@ -0,0 +1,52 @@ +(()=>{var Ce=Object.create;var J=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=t=>J(t,"__esModule",{value:!0});var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&(r||i!=="default")&&J(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t},Ae=(t,e)=>De(Me(J(t!=null?Ce(Re(t)):{},"default",!e&&t&&t.__esModule?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t);var de=Fe((ce,he)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(r+=n[l+1]*i[h+1],l+=2,h+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),p=s.str.charAt(1),v;p in s.node.edges?v=s.node.edges[p]:(v=new t.TokenSet,s.node.edges[p]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof ce=="object"?he.exports=r():e.lunr=r()}(this,function(){return t})})()});var le=[];function N(t,e){le.push({selector:e,constructor:t})}var X=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var Q=class{constructor(e){this.el=e.el}};var Z=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ee=class extends Z{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",K(()=>this.onScroll(),10)),window.addEventListener("resize",K(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onScroll(){this.scrollTop=window.scrollY||0;let e=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(e),this.hideShowToolbar()}hideShowToolbar(){var r;let e=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,e!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(r=this.secondaryNav)==null||r.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},I=ee;I.instance=new ee;var te=class extends Q{constructor(e){super(e);this.anchors=[];this.index=-1;I.instance.addEventListener("resize",()=>this.onResize()),I.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let e=window.location.href;e.indexOf("#")!=-1&&(e=e.substr(0,e.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let n=r.href;if(n.indexOf("#")==-1||n.substr(0,e.length)!=e)return;let i=n.substr(n.indexOf("#")+1),s=document.querySelector("a.tsd-anchor[name="+i+"]"),o=r.parentNode;!s||!o||this.anchors.push({link:o,anchor:s,position:0})}),this.onResize()}onResize(){let e;for(let n=0,i=this.anchors.length;nn.position-i.position);let r=new CustomEvent("scroll",{detail:{scrollTop:I.instance.scrollTop}});this.onScroll(r)}onScroll(e){let r=e.detail.scrollTop+5,n=this.anchors,i=n.length-1,s=this.index;for(;s>-1&&n[s].position>r;)s-=1;for(;s-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=s,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var me=Ae(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ve(t,n,r,s)}function Ve(t,e,r,n){r.addEventListener("input",ue(()=>{ze(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?fe(e,-1):s.key==="ArrowDown"?fe(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function ze(t,e,r,n){if(He(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0,a=Math.min(10,s.length);o${pe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes;let p=document.createElement("a");p.href=n.base+u.url,p.classList.add("tsd-kind-icon"),p.innerHTML=l,h.append(p),e.appendChild(h)}}function fe(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Ne(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function pe(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(re(t.substring(s,o)),`${re(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(re(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function re(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var ge=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},ne=class extends Q{constructor(e){super(e);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(r=>{r.addEventListener("touchstart",n=>this.onClick(n)),r.addEventListener("click",n=>this.onClick(n))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(e){if(e<0&&(e=0),e>this.groups.length-1&&(e=this.groups.length-1),this.index==e)return;let r=this.groups[e];if(this.index>-1){let n=this.groups[this.index];n.removeClass("current").addClass("fade-out"),r.addClass("current"),r.addClass("fade-in"),I.instance.triggerResize(),setTimeout(()=>{n.removeClass("fade-out"),r.removeClass("fade-in")},300)}else r.addClass("current"),I.instance.triggerResize();this.index=e}createGroups(){let e=this.el.children;if(e.length<2)return;this.container=this.el.nextElementSibling;let r=this.container.children;this.groups=[];for(let n=0;n{r.signature===e.currentTarget&&this.setIndex(n)})}};var C="mousedown",xe="mousemove",_="mouseup",G={x:0,y:0},ye=!1,ie=!1,Be=!1,A=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Be=!0,C="touchstart",xe="touchmove",_="touchend");document.addEventListener(C,t=>{ie=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;G.y=e.pageY||0,G.x=e.pageX||0});document.addEventListener(xe,t=>{if(!!ie&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=G.x-(e.pageX||0),n=G.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ie=!1});document.addEventListener("click",t=>{ye&&(t.preventDefault(),t.stopImmediatePropagation(),ye=!1)});var se=class extends Q{constructor(e){super(e);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(C,r=>this.onDocumentPointerDown(r)),document.addEventListener(_,r=>this.onDocumentPointerUp(r))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(e){A||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!A&&this.active&&e.target.closest(".col-menu")){let r=e.target.closest("a");if(r){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substr(0,n.indexOf("#"))),r.href.substr(0,n.length)==n&&setTimeout(()=>this.setActive(!1),250)}}}};var ae=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},oe=class extends ae{initialize(){let e=document.querySelector("#tsd-filter-"+this.key);!e||(this.checkbox=e,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(e,r){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(e){return e=="true"}toLocalStorage(e){return e?"true":"false"}},Ee=class extends ae{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let e=document.querySelector("#tsd-filter-"+this.key);if(!e)return;this.select=e;let r=()=>{this.select.classList.add("active")},n=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,r),this.select.addEventListener("mouseover",r),this.select.addEventListener("mouseleave",n),this.select.querySelectorAll("li").forEach(i=>{i.addEventListener(_,s=>{e.classList.remove("active"),this.setValue(s.target.dataset.value||"")})}),document.addEventListener(C,i=>{this.select.contains(i.target)||this.select.classList.remove("active")})}handleValueChange(e,r){this.select.querySelectorAll("li.selected").forEach(s=>{s.classList.remove("selected")});let n=this.select.querySelector('li[data-value="'+r+'"]'),i=this.select.querySelector(".tsd-select-label");n&&i&&(n.classList.add("selected"),i.textContent=n.textContent),document.documentElement.classList.remove("toggle-"+e),document.documentElement.classList.add("toggle-"+r)}fromLocalStorage(e){return e}toLocalStorage(e){return e}},Y=class extends Q{constructor(e){super(e);this.optionVisibility=new Ee("visibility","private"),this.optionInherited=new oe("inherited",!0),this.optionExternals=new oe("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ve();N(te,".menu-highlight");N(ne,".tsd-signatures");N(se,"a[data-toggle]");Y.isSupported()?N(Y,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var qe=new X;Object.defineProperty(window,"app",{value:qe});})(); +/*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + */ +/*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */ diff --git a/docs/assets/pages.css b/docs/assets/pages.css new file mode 100644 index 0000000..3c339a1 --- /dev/null +++ b/docs/assets/pages.css @@ -0,0 +1,30 @@ +.tsd-typography li > ul { + margin: 0; +} +.tsd-navigation li.pages-entry { + border-left: 2px solid var(--color-text-aside); +} +.tsd-navigation li.pages-entry a { + padding-left: 0!important; +} +.tsd-navigation li.pages-entry.pages-entry-page > a { + color: var(--color-link); +} +li.pages-entry-depth-0 { + padding-left: 10px; +} +li.pages-entry-depth-1 { + padding-left: 20px; +} +li.pages-entry-depth-2 { + padding-left: 30px; +} +li.pages-entry-depth-3 { + padding-left: 40px; +} +li.pages-entry-depth-4 { + padding-left: 50px; +} +.tsd-page-toolbar .table-cell .pages-entry { + white-space: normal; +} \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 0000000..00e3583 --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"32\":\"Variable\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"id\":0,\"kind\":2,\"name\":\"lib/config\",\"url\":\"modules/lib_config.html\",\"classes\":\"tsd-kind-module\",\"isPage\":false},{\"id\":1,\"kind\":256,\"name\":\"Config\",\"url\":\"interfaces/lib_config.Config.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":2,\"kind\":1024,\"name\":\"defaultExpiration\",\"url\":\"interfaces/lib_config.Config.html#defaultExpiration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/config.Config\"},{\"id\":3,\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/lib_config.Config.html#kind\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/config.Config\"},{\"id\":4,\"kind\":1024,\"name\":\"rules\",\"url\":\"interfaces/lib_config.Config.html#rules\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/config.Config\"},{\"id\":5,\"kind\":64,\"name\":\"createConfig\",\"url\":\"modules/lib_config.html#createConfig-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":6,\"kind\":64,\"name\":\"createFileReader\",\"url\":\"modules/lib_config.html#createFileReader-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":7,\"kind\":32,\"name\":\"default\",\"url\":\"modules/lib_config.html#default\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":8,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_config.html#default.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib/config.default\"},{\"id\":9,\"kind\":1024,\"name\":\"createFileReader\",\"url\":\"modules/lib_config.html#default.__type.createFileReader\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":10,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_config.html#default.__type.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":11,\"kind\":1024,\"name\":\"createConfig\",\"url\":\"modules/lib_config.html#default.__type.createConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":12,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_config.html#default.__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":13,\"kind\":2,\"name\":\"lib\",\"url\":\"modules/lib.html\",\"classes\":\"tsd-kind-module\",\"isPage\":false},{\"id\":14,\"kind\":4194304,\"name\":\"ReportResponse\",\"url\":\"modules/lib.html#ReportResponse\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":15,\"kind\":64,\"name\":\"generateReport\",\"url\":\"modules/lib.html#generateReport-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":16,\"kind\":32,\"name\":\"configuration\",\"url\":\"modules/lib.html#configuration\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":17,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#configuration.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib.configuration\"},{\"id\":18,\"kind\":1024,\"name\":\"createFileReader\",\"url\":\"modules/lib.html#configuration.__type.createFileReader\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":19,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#configuration.__type.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":20,\"kind\":1024,\"name\":\"createConfig\",\"url\":\"modules/lib.html#configuration.__type.createConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":21,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#configuration.__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":22,\"kind\":32,\"name\":\"npm\",\"url\":\"modules/lib.html#npm-1\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":23,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#npm-1.__type-11\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib.npm\"},{\"id\":24,\"kind\":1024,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib.html#npm-1.__type-11.createOutdatedRequest-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":25,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#npm-1.__type-11.__type-13\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":26,\"kind\":1024,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib.html#npm-1.__type-11.createDetailsRequest-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":27,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#npm-1.__type-11.__type-12\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":28,\"kind\":32,\"name\":\"default\",\"url\":\"modules/lib.html#default\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":29,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib.default\"},{\"id\":30,\"kind\":1024,\"name\":\"configuration\",\"url\":\"modules/lib.html#default.__type-3.configuration-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":31,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":32,\"kind\":1024,\"name\":\"createFileReader\",\"url\":\"modules/lib.html#default.__type-3.__type-4.createFileReader-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":33,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-4.__type-6\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":34,\"kind\":1024,\"name\":\"createConfig\",\"url\":\"modules/lib.html#default.__type-3.__type-4.createConfig-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":35,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-4.__type-5\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":36,\"kind\":1024,\"name\":\"npm\",\"url\":\"modules/lib.html#default.__type-3.npm\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":37,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-8\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":38,\"kind\":1024,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib.html#default.__type-3.__type-8.createOutdatedRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":39,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-8.__type-10\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":40,\"kind\":1024,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib.html#default.__type-3.__type-8.createDetailsRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":41,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-8.__type-9\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":42,\"kind\":1024,\"name\":\"generateReport\",\"url\":\"modules/lib.html#default.__type-3.generateReport\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":43,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-7\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":44,\"kind\":2,\"name\":\"lib/npm-interactions\",\"url\":\"modules/lib_npm_interactions.html\",\"classes\":\"tsd-kind-module\",\"isPage\":false},{\"id\":45,\"kind\":256,\"name\":\"PackageDetails\",\"url\":\"interfaces/lib_npm_interactions.PackageDetails.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":46,\"kind\":1024,\"name\":\"time\",\"url\":\"interfaces/lib_npm_interactions.PackageDetails.html#time\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.PackageDetails\"},{\"id\":47,\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/lib_npm_interactions.PackageDetails.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.PackageDetails\"},{\"id\":48,\"kind\":256,\"name\":\"OutdatedPackage\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":49,\"kind\":1024,\"name\":\"current\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#current\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":50,\"kind\":1024,\"name\":\"wanted\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#wanted\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":51,\"kind\":1024,\"name\":\"latest\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#latest\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":52,\"kind\":1024,\"name\":\"location\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#location\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":53,\"kind\":256,\"name\":\"OutdatedData\",\"url\":\"interfaces/lib_npm_interactions.OutdatedData.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":54,\"kind\":64,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib_npm_interactions.html#createOutdatedRequest-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":55,\"kind\":64,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib_npm_interactions.html#createDetailsRequest-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":56,\"kind\":32,\"name\":\"default\",\"url\":\"modules/lib_npm_interactions.html#default\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":57,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_npm_interactions.html#default.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default\"},{\"id\":58,\"kind\":1024,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib_npm_interactions.html#default.__type.createOutdatedRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":59,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_npm_interactions.html#default.__type.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":60,\"kind\":1024,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib_npm_interactions.html#default.__type.createDetailsRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":61,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_npm_interactions.html#default.__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":62,\"kind\":2048,\"name\":\"Page: Contribute to these docs\",\"url\":\"pages/how-to/contribute-to-docs.html\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external pages-entry\",\"isPage\":true},{\"id\":63,\"kind\":2048,\"name\":\"Page: Create a config file\",\"url\":\"pages/how-to/create-a-config-file.html\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external pages-entry\",\"isPage\":true},{\"id\":64,\"kind\":2048,\"name\":\"Page: Release\",\"url\":\"pages/how-to/create-a-config-file.html\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external pages-entry\",\"isPage\":true}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,26.283]],[\"parent/0\",[]],[\"name/1\",[1,34.622]],[\"parent/1\",[0,2.641]],[\"name/2\",[2,40.025]],[\"parent/2\",[3,3.122]],[\"name/3\",[4,40.025]],[\"parent/3\",[3,3.122]],[\"name/4\",[5,40.025]],[\"parent/4\",[3,3.122]],[\"name/5\",[6,28.405]],[\"parent/5\",[0,2.641]],[\"name/6\",[7,28.405]],[\"parent/6\",[0,2.641]],[\"name/7\",[8,31.063]],[\"parent/7\",[0,2.641]],[\"name/8\",[9,12.367]],[\"parent/8\",[10,4.022]],[\"name/9\",[7,28.405]],[\"parent/9\",[11,2.855]],[\"name/10\",[9,12.367]],[\"parent/10\",[11,2.855]],[\"name/11\",[6,28.405]],[\"parent/11\",[11,2.855]],[\"name/12\",[9,12.367]],[\"parent/12\",[11,2.855]],[\"name/13\",[12,24.516]],[\"parent/13\",[]],[\"name/14\",[13,40.025]],[\"parent/14\",[12,2.464]],[\"name/15\",[14,34.622]],[\"parent/15\",[12,2.464]],[\"name/16\",[15,34.622]],[\"parent/16\",[12,2.464]],[\"name/17\",[9,12.367]],[\"parent/17\",[16,4.022]],[\"name/18\",[7,28.405]],[\"parent/18\",[17,2.855]],[\"name/19\",[9,12.367]],[\"parent/19\",[17,2.855]],[\"name/20\",[6,28.405]],[\"parent/20\",[17,2.855]],[\"name/21\",[9,12.367]],[\"parent/21\",[17,2.855]],[\"name/22\",[18,34.622]],[\"parent/22\",[12,2.464]],[\"name/23\",[9,12.367]],[\"parent/23\",[19,4.022]],[\"name/24\",[20,28.405]],[\"parent/24\",[21,2.855]],[\"name/25\",[9,12.367]],[\"parent/25\",[21,2.855]],[\"name/26\",[22,28.405]],[\"parent/26\",[21,2.855]],[\"name/27\",[9,12.367]],[\"parent/27\",[21,2.855]],[\"name/28\",[8,31.063]],[\"parent/28\",[12,2.464]],[\"name/29\",[9,12.367]],[\"parent/29\",[23,4.022]],[\"name/30\",[15,34.622]],[\"parent/30\",[24,2.464]],[\"name/31\",[9,12.367]],[\"parent/31\",[24,2.464]],[\"name/32\",[7,28.405]],[\"parent/32\",[25,2.179]],[\"name/33\",[9,12.367]],[\"parent/33\",[25,2.179]],[\"name/34\",[6,28.405]],[\"parent/34\",[25,2.179]],[\"name/35\",[9,12.367]],[\"parent/35\",[25,2.179]],[\"name/36\",[18,34.622]],[\"parent/36\",[24,2.464]],[\"name/37\",[9,12.367]],[\"parent/37\",[24,2.464]],[\"name/38\",[20,28.405]],[\"parent/38\",[25,2.179]],[\"name/39\",[9,12.367]],[\"parent/39\",[25,2.179]],[\"name/40\",[22,28.405]],[\"parent/40\",[25,2.179]],[\"name/41\",[9,12.367]],[\"parent/41\",[25,2.179]],[\"name/42\",[14,34.622]],[\"parent/42\",[24,2.464]],[\"name/43\",[9,12.367]],[\"parent/43\",[24,2.464]],[\"name/44\",[26,9.784,27,16.729]],[\"parent/44\",[]],[\"name/45\",[28,40.025]],[\"parent/45\",[26,0.985,27,1.685]],[\"name/46\",[29,40.025]],[\"parent/46\",[26,0.985,30,2.536]],[\"name/47\",[31,40.025]],[\"parent/47\",[26,0.985,30,2.536]],[\"name/48\",[32,40.025]],[\"parent/48\",[26,0.985,27,1.685]],[\"name/49\",[33,40.025]],[\"parent/49\",[26,0.985,34,2.081]],[\"name/50\",[35,40.025]],[\"parent/50\",[26,0.985,34,2.081]],[\"name/51\",[36,40.025]],[\"parent/51\",[26,0.985,34,2.081]],[\"name/52\",[37,40.025]],[\"parent/52\",[26,0.985,34,2.081]],[\"name/53\",[38,40.025]],[\"parent/53\",[26,0.985,27,1.685]],[\"name/54\",[20,28.405]],[\"parent/54\",[26,0.985,27,1.685]],[\"name/55\",[22,28.405]],[\"parent/55\",[26,0.985,27,1.685]],[\"name/56\",[8,31.063]],[\"parent/56\",[26,0.985,27,1.685]],[\"name/57\",[9,12.367]],[\"parent/57\",[26,0.985,39,2.932]],[\"name/58\",[20,28.405]],[\"parent/58\",[26,0.985,40,2.081]],[\"name/59\",[9,12.367]],[\"parent/59\",[26,0.985,40,2.081]],[\"name/60\",[22,28.405]],[\"parent/60\",[26,0.985,40,2.081]],[\"name/61\",[9,12.367]],[\"parent/61\",[26,0.985,40,2.081]],[\"name/62\",[41,124.253,42,160.1,43,160.1,44,160.1,45,160.1]],[\"parent/62\",[]],[\"name/63\",[1,138.488,41,124.253,46,160.1,47,160.1,48,160.1]],[\"parent/63\",[]],[\"name/64\",[41,225.915,49,291.092]],[\"parent/64\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":9,\"name\":{\"8\":{},\"10\":{},\"12\":{},\"17\":{},\"19\":{},\"21\":{},\"23\":{},\"25\":{},\"27\":{},\"29\":{},\"31\":{},\"33\":{},\"35\":{},\"37\":{},\"39\":{},\"41\":{},\"43\":{},\"57\":{},\"59\":{},\"61\":{}},\"parent\":{}}],[\"a\",{\"_index\":47,\"name\":{\"63\":{}},\"parent\":{}}],[\"config\",{\"_index\":1,\"name\":{\"1\":{},\"63\":{}},\"parent\":{}}],[\"configuration\",{\"_index\":15,\"name\":{\"16\":{},\"30\":{}},\"parent\":{}}],[\"contribute\",{\"_index\":42,\"name\":{\"62\":{}},\"parent\":{}}],[\"create\",{\"_index\":46,\"name\":{\"63\":{}},\"parent\":{}}],[\"createconfig\",{\"_index\":6,\"name\":{\"5\":{},\"11\":{},\"20\":{},\"34\":{}},\"parent\":{}}],[\"createdetailsrequest\",{\"_index\":22,\"name\":{\"26\":{},\"40\":{},\"55\":{},\"60\":{}},\"parent\":{}}],[\"createfilereader\",{\"_index\":7,\"name\":{\"6\":{},\"9\":{},\"18\":{},\"32\":{}},\"parent\":{}}],[\"createoutdatedrequest\",{\"_index\":20,\"name\":{\"24\":{},\"38\":{},\"54\":{},\"58\":{}},\"parent\":{}}],[\"current\",{\"_index\":33,\"name\":{\"49\":{}},\"parent\":{}}],[\"default\",{\"_index\":8,\"name\":{\"7\":{},\"28\":{},\"56\":{}},\"parent\":{}}],[\"defaultexpiration\",{\"_index\":2,\"name\":{\"2\":{}},\"parent\":{}}],[\"docs\",{\"_index\":45,\"name\":{\"62\":{}},\"parent\":{}}],[\"file\",{\"_index\":48,\"name\":{\"63\":{}},\"parent\":{}}],[\"generatereport\",{\"_index\":14,\"name\":{\"15\":{},\"42\":{}},\"parent\":{}}],[\"interactions\",{\"_index\":27,\"name\":{\"44\":{}},\"parent\":{\"45\":{},\"48\":{},\"53\":{},\"54\":{},\"55\":{},\"56\":{}}}],[\"interactions.default\",{\"_index\":39,\"name\":{},\"parent\":{\"57\":{}}}],[\"interactions.default.__type\",{\"_index\":40,\"name\":{},\"parent\":{\"58\":{},\"59\":{},\"60\":{},\"61\":{}}}],[\"interactions.outdatedpackage\",{\"_index\":34,\"name\":{},\"parent\":{\"49\":{},\"50\":{},\"51\":{},\"52\":{}}}],[\"interactions.packagedetails\",{\"_index\":30,\"name\":{},\"parent\":{\"46\":{},\"47\":{}}}],[\"kind\",{\"_index\":4,\"name\":{\"3\":{}},\"parent\":{}}],[\"latest\",{\"_index\":36,\"name\":{\"51\":{}},\"parent\":{}}],[\"lib\",{\"_index\":12,\"name\":{\"13\":{}},\"parent\":{\"14\":{},\"15\":{},\"16\":{},\"22\":{},\"28\":{}}}],[\"lib.configuration\",{\"_index\":16,\"name\":{},\"parent\":{\"17\":{}}}],[\"lib.configuration.__type\",{\"_index\":17,\"name\":{},\"parent\":{\"18\":{},\"19\":{},\"20\":{},\"21\":{}}}],[\"lib.default\",{\"_index\":23,\"name\":{},\"parent\":{\"29\":{}}}],[\"lib.default.__type\",{\"_index\":24,\"name\":{},\"parent\":{\"30\":{},\"31\":{},\"36\":{},\"37\":{},\"42\":{},\"43\":{}}}],[\"lib.default.__type.__type\",{\"_index\":25,\"name\":{},\"parent\":{\"32\":{},\"33\":{},\"34\":{},\"35\":{},\"38\":{},\"39\":{},\"40\":{},\"41\":{}}}],[\"lib.npm\",{\"_index\":19,\"name\":{},\"parent\":{\"23\":{}}}],[\"lib.npm.__type\",{\"_index\":21,\"name\":{},\"parent\":{\"24\":{},\"25\":{},\"26\":{},\"27\":{}}}],[\"lib/config\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{\"1\":{},\"5\":{},\"6\":{},\"7\":{}}}],[\"lib/config.config\",{\"_index\":3,\"name\":{},\"parent\":{\"2\":{},\"3\":{},\"4\":{}}}],[\"lib/config.default\",{\"_index\":10,\"name\":{},\"parent\":{\"8\":{}}}],[\"lib/config.default.__type\",{\"_index\":11,\"name\":{},\"parent\":{\"9\":{},\"10\":{},\"11\":{},\"12\":{}}}],[\"lib/npm\",{\"_index\":26,\"name\":{\"44\":{}},\"parent\":{\"45\":{},\"46\":{},\"47\":{},\"48\":{},\"49\":{},\"50\":{},\"51\":{},\"52\":{},\"53\":{},\"54\":{},\"55\":{},\"56\":{},\"57\":{},\"58\":{},\"59\":{},\"60\":{},\"61\":{}}}],[\"location\",{\"_index\":37,\"name\":{\"52\":{}},\"parent\":{}}],[\"name\",{\"_index\":31,\"name\":{\"47\":{}},\"parent\":{}}],[\"npm\",{\"_index\":18,\"name\":{\"22\":{},\"36\":{}},\"parent\":{}}],[\"outdateddata\",{\"_index\":38,\"name\":{\"53\":{}},\"parent\":{}}],[\"outdatedpackage\",{\"_index\":32,\"name\":{\"48\":{}},\"parent\":{}}],[\"packagedetails\",{\"_index\":28,\"name\":{\"45\":{}},\"parent\":{}}],[\"page\",{\"_index\":41,\"name\":{\"62\":{},\"63\":{},\"64\":{}},\"parent\":{}}],[\"release\",{\"_index\":49,\"name\":{\"64\":{}},\"parent\":{}}],[\"reportresponse\",{\"_index\":13,\"name\":{\"14\":{}},\"parent\":{}}],[\"rules\",{\"_index\":5,\"name\":{\"4\":{}},\"parent\":{}}],[\"these\",{\"_index\":44,\"name\":{\"62\":{}},\"parent\":{}}],[\"time\",{\"_index\":29,\"name\":{\"46\":{}},\"parent\":{}}],[\"to\",{\"_index\":43,\"name\":{\"62\":{}},\"parent\":{}}],[\"wanted\",{\"_index\":35,\"name\":{\"50\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 0000000..a16ed02 --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1413 @@ +@import url("./icons.css"); + +:root { + /* Light */ + --light-color-background: #fcfcfc; + --light-color-secondary-background: #fff; + --light-color-text: #222; + --light-color-text-aside: #707070; + --light-color-link: #4da6ff; + --light-color-menu-divider: #eee; + --light-color-menu-divider-focus: #000; + --light-color-menu-label: #707070; + --light-color-panel: var(--light-color-secondary-background); + --light-color-panel-divider: #eee; + --light-color-comment-tag: #707070; + --light-color-comment-tag-text: #fff; + --light-color-ts: #9600ff; + --light-color-ts-interface: #647f1b; + --light-color-ts-enum: #937210; + --light-color-ts-class: #0672de; + --light-color-ts-private: #707070; + --light-color-toolbar: #fff; + --light-color-toolbar-text: #333; + --light-icon-filter: invert(0); + --light-external-icon: url("data:image/svg+xml;utf8,"); + + /* Dark */ + --dark-color-background: #36393f; + --dark-color-secondary-background: #2f3136; + --dark-color-text: #ffffff; + --dark-color-text-aside: #e6e4e4; + --dark-color-link: #00aff4; + --dark-color-menu-divider: #eee; + --dark-color-menu-divider-focus: #000; + --dark-color-menu-label: #707070; + --dark-color-panel: var(--dark-color-secondary-background); + --dark-color-panel-divider: #818181; + --dark-color-comment-tag: #dcddde; + --dark-color-comment-tag-text: #2f3136; + --dark-color-ts: #c97dff; + --dark-color-ts-interface: #9cbe3c; + --dark-color-ts-enum: #d6ab29; + --dark-color-ts-class: #3695f3; + --dark-color-ts-private: #e2e2e2; + --dark-color-toolbar: #34373c; + --dark-color-toolbar-text: #ffffff; + --dark-icon-filter: invert(1); + --dark-external-icon: url("data:image/svg+xml;utf8,"); +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); + } +} + +body { + margin: 0; +} + +body.light { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); +} + +body.dark { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +h2 { + font-size: 1.5em; + margin: 0.83em 0; +} + +h3 { + font-size: 1.17em; + margin: 1em 0; +} + +h4, +.tsd-index-panel h3 { + font-size: 1em; + margin: 1.33em 0; +} + +h5 { + font-size: 0.83em; + margin: 1.67em 0; +} + +h6 { + font-size: 0.67em; + margin: 2.33em 0; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 0 40px; +} +@media (max-width: 640px) { + .container { + padding: 0 20px; + } +} + +.container-main { + padding-bottom: 200px; +} + +.row { + display: flex; + position: relative; + margin: 0 -10px; +} +.row:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +.col-4, +.col-8 { + box-sizing: border-box; + float: left; + padding: 0 10px; +} + +.col-4 { + width: 33.3333333333%; +} +.col-8 { + width: 66.6666666667%; +} + +ul.tsd-descriptions > li > :first-child, +.tsd-panel > :first-child, +.col-8 > :first-child, +.col-4 > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child, +.tsd-panel > :first-child > :first-child, +.col-8 > :first-child > :first-child, +.col-4 > :first-child > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child > :first-child, +.tsd-panel > :first-child > :first-child > :first-child, +.col-8 > :first-child > :first-child > :first-child, +.col-4 > :first-child > :first-child > :first-child { + margin-top: 0; +} +ul.tsd-descriptions > li > :last-child, +.tsd-panel > :last-child, +.col-8 > :last-child, +.col-4 > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child, +.tsd-panel > :last-child > :last-child, +.col-8 > :last-child > :last-child, +.col-4 > :last-child > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child > :last-child, +.tsd-panel > :last-child > :last-child > :last-child, +.col-8 > :last-child > :last-child > :last-child, +.col-4 > :last-child > :last-child > :last-child { + margin-bottom: 0; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 14px; +} + +pre { + padding: 10px; +} +pre code { + padding: 0; + font-size: 100%; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +@media (min-width: 901px) and (max-width: 1024px) { + html .col-content { + width: 72%; + } + html .col-menu { + width: 28%; + } + html .tsd-navigation { + padding-left: 10px; + } +} +@media (max-width: 900px) { + html .col-content { + float: none; + width: 100%; + } + html .col-menu { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + width: 100%; + padding: 20px 20px 0 0; + max-width: 450px; + visibility: hidden; + background-color: var(--color-panel); + transform: translate(100%, 0); + } + html .col-menu > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu :is(header, footer, .col-content) { + animation: shift-to-left 0.4s; + } + + .to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu :is(header, footer, .col-content) { + animation: unshift-to-left 0.4s; + } + + .from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu :is(header, footer, .col-content) { + transform: translate(-25%, 0); + } + .has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + display: grid; + grid-template-rows: auto 1fr; + max-height: 100vh; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +.tsd-page-title { + padding: 70px 0 20px 0; + margin: 0 0 40px 0; + background: var(--color-panel); + box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); +} +.tsd-page-title h1 { + margin: 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +dl.tsd-comment-tags { + overflow: hidden; +} +dl.tsd-comment-tags dt { + float: left; + padding: 1px 5px; + margin: 0 10px 0 0; + border-radius: 4px; + border: 1px solid var(--color-comment-tag); + color: var(--color-comment-tag); + font-size: 0.8em; + font-weight: normal; +} +dl.tsd-comment-tags dd { + margin: 0 0 10px 0; +} +dl.tsd-comment-tags dd:before, +dl.tsd-comment-tags dd:after { + display: table; + content: " "; +} +dl.tsd-comment-tags dd pre, +dl.tsd-comment-tags dd:after { + clear: both; +} +dl.tsd-comment-tags p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.toggle-protected .tsd-is-private { + display: none; +} + +.toggle-public .tsd-is-private, +.toggle-public .tsd-is-protected, +.toggle-public .tsd-is-private-protected { + display: none; +} + +.toggle-inherited .tsd-is-inherited { + display: none; +} + +.toggle-externals .tsd-is-external { + display: none; +} + +#tsd-filter { + position: relative; + display: inline-block; + height: 40px; + vertical-align: bottom; +} +.no-filter #tsd-filter { + display: none; +} +#tsd-filter .tsd-filter-group { + display: inline-block; + height: 40px; + vertical-align: bottom; + white-space: nowrap; +} +#tsd-filter input { + display: none; +} +@media (max-width: 900px) { + #tsd-filter .tsd-filter-group { + display: block; + position: absolute; + top: 40px; + right: 20px; + height: auto; + background-color: var(--color-panel); + visibility: hidden; + transform: translate(50%, 0); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + .has-options #tsd-filter .tsd-filter-group { + visibility: visible; + } + .to-has-options #tsd-filter .tsd-filter-group { + animation: fade-in 0.2s; + } + .from-has-options #tsd-filter .tsd-filter-group { + animation: fade-out 0.2s; + } + #tsd-filter label, + #tsd-filter .tsd-select { + display: block; + padding-right: 20px; + } +} + +footer { + border-top: 1px solid var(--color-panel-divider); + background-color: var(--color-panel); +} +footer:after { + content: ""; + display: table; +} +footer.with-border-bottom { + border-bottom: 1px solid var(--color-panel-divider); +} +footer .tsd-legend-group { + font-size: 0; +} +footer .tsd-legend { + display: inline-block; + width: 25%; + padding: 0; + font-size: 16px; + list-style: none; + line-height: 1.333em; + vertical-align: top; +} +@media (max-width: 900px) { + footer .tsd-legend { + width: 50%; + } +} + +.tsd-hierarchy { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-index-panel .tsd-index-content { + margin-bottom: -30px !important; +} +.tsd-index-panel .tsd-index-section { + margin-bottom: 30px !important; +} +.tsd-index-panel h3 { + margin: 0 -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + -webkit-column-gap: 20px; + -moz-column-gap: 20px; + -ms-column-gap: 20px; + -o-column-gap: 20px; + column-gap: 20px; + padding: 0; + list-style: none; + line-height: 1.333em; +} +@media (max-width: 900px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 1; + -moz-column-count: 1; + -ms-column-count: 1; + -o-column-count: 1; + column-count: 1; + } +} +@media (min-width: 901px) and (max-width: 1024px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 2; + -moz-column-count: 2; + -ms-column-count: 2; + -o-column-count: 2; + column-count: 2; + } +} +.tsd-index-panel ul.tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel .tsd-parent-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-parent-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-parent-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-parent-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-is-private a { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 1px 5px; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 14px; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member [data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member [data-tsd-kind="Interface"] { + color: var(--color-ts-interface); +} +.tsd-member [data-tsd-kind="Enum"] { + color: var(--color-ts-enum); +} +.tsd-member [data-tsd-kind="Class"] { + color: var(--color-ts-class); +} +.tsd-member [data-tsd-kind="Private"] { + color: var(--color-ts-private); +} + +.tsd-navigation { + margin: 0 0 0 40px; +} +.tsd-navigation a { + display: block; + padding-top: 2px; + padding-bottom: 2px; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary { + padding-bottom: 40px; +} +.tsd-navigation.primary a { + display: block; + padding-top: 6px; + padding-bottom: 6px; +} +.tsd-navigation.primary ul li a { + padding-left: 5px; +} +.tsd-navigation.primary ul li li a { + padding-left: 25px; +} +.tsd-navigation.primary ul li li li a { + padding-left: 45px; +} +.tsd-navigation.primary ul li li li li a { + padding-left: 65px; +} +.tsd-navigation.primary ul li li li li li a { + padding-left: 85px; +} +.tsd-navigation.primary ul li li li li li li a { + padding-left: 105px; +} +.tsd-navigation.primary > ul { + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li { + border-top: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li.current > a { + font-weight: bold; +} +.tsd-navigation.primary li.label span { + display: block; + padding: 20px 0 6px 5px; + color: var(--color-menu-label); +} +.tsd-navigation.primary li.globals + li > span, +.tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary { + max-height: calc(100vh - 1rem - 40px); + overflow: auto; + position: sticky; + top: calc(0.5rem + 40px); + transition: 0.3s; +} +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary ul { + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 25px; +} +.tsd-navigation.secondary ul li li a { + padding-left: 45px; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 65px; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 85px; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 105px; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 125px; +} +.tsd-navigation.secondary ul.current a { + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.focus > a, +.tsd-navigation.secondary ul.current li.focus > a { + border-left-color: var(--color-menu-divider-focus); +} +.tsd-navigation.secondary li.current { + margin-top: 20px; + margin-bottom: 20px; + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.current > a { + font-weight: bold; +} + +@media (min-width: 901px) { + .menu-sticky-wrap { + position: static; + } +} + +.tsd-panel { + margin: 20px 0; + padding: 20px; + background-color: var(--color-panel); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5em -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: 0; +} +.tsd-panel table { + display: block; + width: 100%; + overflow: auto; + margin-top: 10px; + word-break: normal; + word-break: keep-all; + border-collapse: collapse; +} +.tsd-panel table th { + font-weight: bold; +} +.tsd-panel table th, +.tsd-panel table td { + padding: 6px 13px; + border: 1px solid var(--color-panel-divider); +} +.tsd-panel table tr { + background: var(--color-background); +} +.tsd-panel table tr:nth-child(even) { + background: var(--color-secondary-background); +} + +.tsd-panel-group { + margin: 60px 0; +} +.tsd-panel-group > h1, +.tsd-panel-group > h2, +.tsd-panel-group > h3 { + padding-left: 20px; + padding-right: 20px; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 40px; + height: 40px; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-panel); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-panel-divider); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-panel-divider); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +.tsd-signature { + margin: 0 0 1em 0; + padding: 10px; + border: 1px solid var(--color-panel-divider); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} +.tsd-signature.tsd-kind-icon { + padding-left: 30px; +} +.tsd-signature.tsd-kind-icon:before { + top: 10px; + left: 10px; +} +.tsd-panel > .tsd-signature { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signature.tsd-kind-icon:before { + left: 20px; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + border: 1px solid var(--color-panel-divider); +} +.tsd-signatures .tsd-signature { + margin: 0; + border-width: 1px 0 0 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-signature:first-child { + border-top-width: 0; +} +.tsd-signatures .tsd-signature.current { + background-color: var(--color-panel-divider); +} +.tsd-signatures.active > .tsd-signature { + cursor: pointer; +} +.tsd-panel > .tsd-signatures { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { + left: 20px; +} +.tsd-panel > a.anchor + .tsd-signatures { + border-top-width: 0; + margin-top: -20px; +} + +ul.tsd-descriptions { + position: relative; + overflow: hidden; + padding: 0; + list-style: none; +} +ul.tsd-descriptions.active > .tsd-description { + display: none; +} +ul.tsd-descriptions.active > .tsd-description.current { + display: block; +} +ul.tsd-descriptions.active > .tsd-description.fade-in { + animation: fade-in-delayed 0.3s; +} +ul.tsd-descriptions.active > .tsd-description.fade-out { + animation: fade-out-delayed 0.3s; + position: absolute; + display: block; + top: 0; + left: 0; + right: 0; + opacity: 0; + visibility: hidden; +} +ul.tsd-descriptions h4, +ul.tsd-descriptions .tsd-index-panel h3, +.tsd-index-panel ul.tsd-descriptions h3 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} + +ul.tsd-parameters, +ul.tsd-type-parameters { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameters > li.tsd-parameter-signature, +ul.tsd-type-parameters > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameters h5, +ul.tsd-type-parameters h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +ul.tsd-parameters .tsd-comment, +ul.tsd-type-parameters .tsd-comment { + margin-top: -0.5em; +} + +.tsd-sources { + font-size: 14px; + color: var(--color-text-aside); + margin: 0 0 1em 0; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul, +.tsd-sources p { + margin: 0 !important; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + height: 40px; + color: var(--color-toolbar-text); + background: var(--color-toolbar); + border-bottom: 1px solid var(--color-panel-divider); + transition: transform 0.3s linear; +} +.tsd-page-toolbar a { + color: var(--color-toolbar-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .table-wrap { + display: table; + width: 100%; + height: 40px; +} +.tsd-page-toolbar .table-cell { + display: table-cell; + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-select .tsd-select-list li:before, +.tsd-select .tsd-select-label:before, +.tsd-widget:before { + content: ""; + display: inline-block; + width: 40px; + height: 40px; + margin: 0 -8px 0 0; + background-image: url(./widgets.png); + background-repeat: no-repeat; + text-indent: -1024px; + vertical-align: bottom; + filter: var(--icon-filter); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-select .tsd-select-list li:before, + .tsd-select .tsd-select-label:before, + .tsd-widget:before { + background-image: url(./widgets@2x.png); + background-size: 320px 40px; + } +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-panel-divider); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} +.tsd-widget.search:before { + background-position: 0 0; +} +.tsd-widget.menu:before { + background-position: -40px 0; +} +.tsd-widget.options:before { + background-position: -80px 0; +} +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +@media (max-width: 900px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +.tsd-select { + position: relative; + display: inline-block; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-select .tsd-select-label { + opacity: 0.6; + transition: opacity 0.2s; +} +.tsd-select .tsd-select-label:before { + background-position: -240px 0; +} +.tsd-select.active .tsd-select-label { + opacity: 0.8; +} +.tsd-select.active .tsd-select-list { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} +.tsd-select .tsd-select-list { + position: absolute; + visibility: hidden; + top: 40px; + left: 0; + margin: 0; + padding: 0; + opacity: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + transition: visibility 0s 0.2s, opacity 0.2s; +} +.tsd-select .tsd-select-list li { + padding: 0 20px 0 0; + background-color: var(--color-background); +} +.tsd-select .tsd-select-list li:before { + background-position: 40px 0; +} +.tsd-select .tsd-select-list li:nth-child(even) { + background-color: var(--color-panel); +} +.tsd-select .tsd-select-list li:hover { + background-color: var(--color-panel-divider); +} +.tsd-select .tsd-select-list li.selected:before { + background-position: -200px 0; +} +@media (max-width: 900px) { + .tsd-select .tsd-select-list { + top: 0; + left: auto; + right: 100%; + margin-right: -5px; + } + .tsd-select .tsd-select-label:before { + background-position: -280px 0; + } +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + margin-left: 10px; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} diff --git a/docs/assets/widgets.png b/docs/assets/widgets.png new file mode 100644 index 0000000..c738053 Binary files /dev/null and b/docs/assets/widgets.png differ diff --git a/docs/assets/widgets@2x.png b/docs/assets/widgets@2x.png new file mode 100644 index 0000000..4bbbd57 Binary files /dev/null and b/docs/assets/widgets@2x.png differ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..f6178f5 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,92 @@ +rotten-deps - v1.0.0-beta.26
Options
All
  • Public
  • Public/Protected
  • All
Menu

rotten-deps - v1.0.0-beta.26

+ +

Rotten Deps

+
+

Node.js CI

+ + +

What is Rotten Deps?

+
+

Rotten Deps builds upon tools like yarn outdated and npm outdated to provide more than just a pass or fail state to outdated dependencies. You can configure a global or per dependency compliance period which will trigger a warn instead of a fail. This provides more breathing room for updating without blocking your builds.

+ + +

Why and when should I use this?

+
+ + +

Ignoring dependencies

+
+

Sometimes cases arise where due to some tech debt or other concern you're unable to update a specific dependency. If you have npm outdated or yarn outdated in your CI flow this job will constantly fail either blocking your builds or getting the team into the habit of ignoring the output.

+ + +

Dependency specific compliance periods

+
+

Assuming you've decided that 14 days is an acceptable compliance periods for updates but you have one critical dependency that you like to keep patched. The inverse scenario also applies where maybe you're not that worried about a specific dev dependency falling out of date.

+ + +

Global compliance period

+
+

This is good for setting organization base rules if you are working in an organization that has patching compliance windows.

+ + +

How is days outdated determined?

+
+

We use your current version of a dependency as it is installed in your node_modules. Then based off a list of +versions we determine the next semver version which is not a pre-release and use that as our comparison point. Days outdated is +then calculated as the delta between the UTC seconds now versus the UTC seconds of next version's publish date. The delta is +then converted and rounded to days and used in the report.

+

There is a special case where if you forget to install your project first using yarn install or npm install you won't have +a node_modules/ so the wanted version is used instead which is determined based on how you pinned a version in your package.json.

+ + +

How do I use this?

+
+ + +

Prerequisites

+
+
    +
  1. NodeJS
      +
    • We currently support 12.x, 14.x. and 16.x. Other versions may work but are not part of our nightly and push testing.
    • +
    +
  2. +
+ + +

Installation

+
+

npm i -g rotten-deps or yarn global add rotten-deps to install this utility globally

+
    +
  • OR -
  • +
+

npm i --save-dev rotten-deps or yarn add --dev rotten-deps to install it locally in your project.

+ + +

Usage

+
+

You can find more in-depth documentation hosted on our GitHub pages.

+ + +

CLI

+
+

To see details on command usage and options use rotten-deps --help, or if you installed it locally node ./node_modules/.bin/rotten-deps --help.

+ + +

API

+
+

At this time the API isn't officially supported but you can probably figure it out based on the reference docs hosted on our GitHub Pages

+ + +

Exit codes and meanings

+
+
    +
  • 0 indicates that no dependencies are stale or outdated
  • +
  • 1 indicates that you have outdated dependencies
  • +
  • 2 indicates that you have stale dependencies but no outdated
  • +
+ + +

Contributing

+
+

For instructions on contributing to this project please see CONTRIBUTING.md.

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/lib_config.Config.html b/docs/interfaces/lib_config.Config.html new file mode 100644 index 0000000..dd096f6 --- /dev/null +++ b/docs/interfaces/lib_config.Config.html @@ -0,0 +1 @@ +Config | rotten-deps - v1.0.0-beta.26
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Config

Index

Properties

defaultExpiration?: number
kind?: "config"
rules: Rule[]

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/lib_npm_interactions.OutdatedData.html b/docs/interfaces/lib_npm_interactions.OutdatedData.html new file mode 100644 index 0000000..69f8e00 --- /dev/null +++ b/docs/interfaces/lib_npm_interactions.OutdatedData.html @@ -0,0 +1 @@ +OutdatedData | rotten-deps - v1.0.0-beta.26
Options
All
  • Public
  • Public/Protected
  • All
Menu

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/lib_npm_interactions.OutdatedPackage.html b/docs/interfaces/lib_npm_interactions.OutdatedPackage.html new file mode 100644 index 0000000..eea5e52 --- /dev/null +++ b/docs/interfaces/lib_npm_interactions.OutdatedPackage.html @@ -0,0 +1 @@ +OutdatedPackage | rotten-deps - v1.0.0-beta.26
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • OutdatedPackage

Index

Properties

current: string
latest: string
location: string
wanted: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/lib_npm_interactions.PackageDetails.html b/docs/interfaces/lib_npm_interactions.PackageDetails.html new file mode 100644 index 0000000..7658b77 --- /dev/null +++ b/docs/interfaces/lib_npm_interactions.PackageDetails.html @@ -0,0 +1 @@ +PackageDetails | rotten-deps - v1.0.0-beta.26
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PackageDetails

Index

Properties

Properties

name: string
time: Record<string, string>

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 0000000..0a833f1 --- /dev/null +++ b/docs/modules.html @@ -0,0 +1 @@ +rotten-deps - v1.0.0-beta.26
Options
All
  • Public
  • Public/Protected
  • All
Menu

rotten-deps - v1.0.0-beta.26

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/lib.html b/docs/modules/lib.html new file mode 100644 index 0000000..48fb7a7 --- /dev/null +++ b/docs/modules/lib.html @@ -0,0 +1,43 @@ +lib | rotten-deps - v1.0.0-beta.26
Options
All
  • Public
  • Public/Protected
  • All
Menu
+

Rotten Deps API

+

Index

Type aliases

ReportResponse: Report | ReportWithWarning

Variables

configuration: { createConfig: (config: Config) => Config; createFileReader: (absoluteFilePath: string) => FileReader } = ...

Type declaration

  • createConfig: (config: Config) => Config
      • +

        Validates a raw configuration file and generates a report if any rules are +misconfigured.

        +

        Parameters

        • config: Config
          +

          rotten deps configuration object

          +

        Returns Config

  • createFileReader: (absoluteFilePath: string) => FileReader
      • (absoluteFilePath: string): FileReader
      • +

        Creates a filereader function for fetching the contents of a config +file at the provided path.

        +

        Parameters

        • absoluteFilePath: string
          +

          absolute path to the configuration file

          +

        Returns FileReader

default: { configuration: { createConfig: (config: Config) => Config; createFileReader: (absoluteFilePath: string) => FileReader }; generateReport: (c: Config, r?: Reporter) => Promise<ReportResponse | Error>; npm: { createDetailsRequest: (dependencyName: string) => DetailsRequest; createOutdatedRequest: () => OutdatedRequest } }

Type declaration

  • configuration: { createConfig: (config: Config) => Config; createFileReader: (absoluteFilePath: string) => FileReader }
    • createConfig: (config: Config) => Config
        • +

          Validates a raw configuration file and generates a report if any rules are +misconfigured.

          +

          Parameters

          • config: Config
            +

            rotten deps configuration object

            +

          Returns Config

    • createFileReader: (absoluteFilePath: string) => FileReader
        • (absoluteFilePath: string): FileReader
        • +

          Creates a filereader function for fetching the contents of a config +file at the provided path.

          +

          Parameters

          • absoluteFilePath: string
            +

            absolute path to the configuration file

            +

          Returns FileReader

  • generateReport: (c: Config, r?: Reporter) => Promise<ReportResponse | Error>
      • +

        Compares the details on each dependency flagged as outdated in order to +determine how stale a version actually is.

        +

        Parameters

        • c: Config
        • Optional r: Reporter
          +

          Optional reporter object with functions for hooking middleware into the report generation process

          +

        Returns Promise<ReportResponse | Error>

  • npm: { createDetailsRequest: (dependencyName: string) => DetailsRequest; createOutdatedRequest: () => OutdatedRequest }
    • createDetailsRequest: (dependencyName: string) => DetailsRequest
        • (dependencyName: string): DetailsRequest
        • +

          Creates a function to run the npm view command for a specific dependency

          +

          Parameters

          • dependencyName: string
            +

          Returns DetailsRequest

    • createOutdatedRequest: () => OutdatedRequest
        • (): OutdatedRequest
        • +

          Creates a function for running npm outdated

          +

          Returns OutdatedRequest

npm: { createDetailsRequest: (dependencyName: string) => DetailsRequest; createOutdatedRequest: () => OutdatedRequest } = ...

Type declaration

  • createDetailsRequest: (dependencyName: string) => DetailsRequest
      • (dependencyName: string): DetailsRequest
      • +

        Creates a function to run the npm view command for a specific dependency

        +

        Parameters

        • dependencyName: string
          +

        Returns DetailsRequest

  • createOutdatedRequest: () => OutdatedRequest
      • (): OutdatedRequest
      • +

        Creates a function for running npm outdated

        +

        Returns OutdatedRequest

Functions

  • +

    Compares the details on each dependency flagged as outdated in order to +determine how stale a version actually is.

    +

    Parameters

    • c: Config
    • Optional r: Reporter
      +

      Optional reporter object with functions for hooking middleware into the report generation process

      +

    Returns Promise<ReportResponse | Error>

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/lib_config.html b/docs/modules/lib_config.html new file mode 100644 index 0000000..b2edff0 --- /dev/null +++ b/docs/modules/lib_config.html @@ -0,0 +1,23 @@ +lib/config | rotten-deps - v1.0.0-beta.26
Options
All
  • Public
  • Public/Protected
  • All
Menu
+

Rotten Deps configuration library

+

Index

Interfaces

Variables

Functions

Variables

default: { createConfig: (config: Config) => Config; createFileReader: (absoluteFilePath: string) => FileReader }

Type declaration

  • createConfig: (config: Config) => Config
      • +

        Validates a raw configuration file and generates a report if any rules are +misconfigured.

        +

        Parameters

        • config: Config
          +

          rotten deps configuration object

          +

        Returns Config

  • createFileReader: (absoluteFilePath: string) => FileReader
      • (absoluteFilePath: string): FileReader
      • +

        Creates a filereader function for fetching the contents of a config +file at the provided path.

        +

        Parameters

        • absoluteFilePath: string
          +

          absolute path to the configuration file

          +

        Returns FileReader

Functions

  • +

    Validates a raw configuration file and generates a report if any rules are +misconfigured.

    +

    Parameters

    • config: Config
      +

      rotten deps configuration object

      +

    Returns Config

  • createFileReader(absoluteFilePath: string): FileReader
  • +

    Creates a filereader function for fetching the contents of a config +file at the provided path.

    +

    Parameters

    • absoluteFilePath: string
      +

      absolute path to the configuration file

      +

    Returns FileReader

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/lib_npm_interactions.html b/docs/modules/lib_npm_interactions.html new file mode 100644 index 0000000..55b471a --- /dev/null +++ b/docs/modules/lib_npm_interactions.html @@ -0,0 +1,13 @@ +lib/npm-interactions | rotten-deps - v1.0.0-beta.26
Options
All
  • Public
  • Public/Protected
  • All
Menu
+

Rotten Deps NPM Interactions library

+

Index

Variables

default: { createDetailsRequest: (dependencyName: string) => DetailsRequest; createOutdatedRequest: () => OutdatedRequest }

Type declaration

  • createDetailsRequest: (dependencyName: string) => DetailsRequest
      • (dependencyName: string): DetailsRequest
      • +

        Creates a function to run the npm view command for a specific dependency

        +

        Parameters

        • dependencyName: string
          +

        Returns DetailsRequest

  • createOutdatedRequest: () => OutdatedRequest
      • (): OutdatedRequest
      • +

        Creates a function for running npm outdated

        +

        Returns OutdatedRequest

Functions

  • createDetailsRequest(dependencyName: string): DetailsRequest
  • +

    Creates a function to run the npm view command for a specific dependency

    +

    Parameters

    • dependencyName: string
      +

    Returns DetailsRequest

  • createOutdatedRequest(): OutdatedRequest

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/pages/how-to/contribute-to-docs.html b/docs/pages/how-to/contribute-to-docs.html new file mode 100644 index 0000000..403f5c6 --- /dev/null +++ b/docs/pages/how-to/contribute-to-docs.html @@ -0,0 +1,42 @@ +Contribute to these docs | rotten-deps - v1.0.0-beta.26
Options
All
  • Public
  • Public/Protected
  • All
Menu
+ +

How to contribute to the documentation

+
+ + +

Structure and organization

+
+

The documentation is based on the Divio Documentation System. This system doesn't have one thing called documentation, it has four: tutorials, how-to guides, technical reference, and explanations.

+

Technical references are generated by Typedoc based one comments within the TypeScript files themselves using the TSDoc standard. You can also use TypeDoc Includes to pull these markdown files into the reference docs.

+

How-to, explanations, and tutorials reside as markdown files within documentation/. docs/ is the generated output for github pages and is ignored.

+
documentation
+├── explanations
+├── how-tos
+└── tutorials
+
+ + +

Creating a new how-to, tutorial, or explanation file

+
+ + +

Step one

+
+

Create your new .md file in one of the folders mentioned above based upon your documentation type. The filename doesn't have to match the title of the doc but it should be somewhat descriptive.

+ + +

Step two

+
+

Update the typedoc.js configuration file. The pluginPages object contains all of the configuration for embedding markdown in the generated docs.

+
pluginPages: {
source: './documentation/',
pages: [
{
title: 'How To',
children: [
{ title: 'Contribute to these docs', source: './how-to/contribute-to-docs.md' },
{ title: 'Create a config file', source: './how-to/create-a-config-file.md' },
{ title: 'Release', source: './how-to/create-a-config-file.md' },
],
},
],
}, +
+

Above you can see a page with just a title and no source for How To. This creates the How To section header and brings all the specified child documents under it.

+ + +

Updating API/Reference documentation

+
+

To modify the reference documents you need to change the TSDoc comments in the actual typescript source files under src/.

+
/**
* Creates a file-reader function for fetching the contents of a config
* file at the provided path.
* @param absoluteFilePath absolute path to the configuration file
*/ +
+

When the tsdoc generator runs it will pull this comment into the reference docs for that particular module. In this example we have a function description and a parameter description. The param types and returns are generated from the function definition.

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/pages/how-to/create-a-config-file.html b/docs/pages/how-to/create-a-config-file.html new file mode 100644 index 0000000..abba6ac --- /dev/null +++ b/docs/pages/how-to/create-a-config-file.html @@ -0,0 +1,37 @@ +Release | rotten-deps - v1.0.0-beta.26
Options
All
  • Public
  • Public/Protected
  • All
Menu
+ +

How to create and use a configuration file

+
+

Let's assume you're in a situation where you want to use a global compliance period of 14 days, but due to technical limitations you are stuck to a specific version of ExpressJS and want to ignore it. Let's also assume you want to allow captain-picard 100 days to comply.

+
    +
  1. Create a .json configuration file, named anything you want, somewhere on your file system

    +
  2. +
  3. Create a config with 2 rules for your specific use case and set the default compliance period to 14 days

    +
    {
    "defaultExpiration": 14,
    "rules": [
    {
    "dependencyName": "express",
    "ignore": true,
    },
    {
    "dependencyName": "captain-picard",
    "daysUntilExpiration": 100
    }
    ]
    } +
    +
  4. +
  5. Run Rotten Deps by using rotten-deps --config-path <absolute-path-to-your-config>. Rotten Deps will attempt to resolve a relative path which is useful if you're keeping it with your project but absolute path is preferred.

    +
  6. +
+

You should now see an output that reflects that express was ignored as well as not failing if you're other dependencies are within their defined compliance period. If this doesn't work as expected or you have questions feel free to drop us an issue on our issue board.

+ + +

Config Options

+
+ + +

defaultExpiration: number

+
+

This is a number value to use as the default expiration for all dependencies. This is overridden if any specific dependency has it's own expiration date.

+ + +

rules: Array<Rule>

+
+

This is a collection of rules for each dependency. The individual rules have the following properties:

+
    +
  • dependencyName: string The name of the dependency you're configuring a rule for
  • +
  • OPTIONAL ignore: boolean Sets the dependency to be ignored. This will never trigger a fail due to being outdated.
  • +
  • OPTIONAL daysUntilExpiration: number This sets the expiration period for the individual dependency
  • +
  • OPTIONAL reason: string This sets the reason for the specific rule which will be output into the table. Useful for memorizing why you whitelisted something to make it more likely that you follow up and fix later.
  • +
+

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/package.json b/package.json index 59c9643..74ae4d5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "rotten-deps", - "version": "1.0.0-beta.25", + "version": "1.0.0-beta.26", "description": "The command `npm outdated` only has two endpoints which are pass or fail. This dichotomy isn't very useful for CI flows which have pass, fail, or warn. This CLI utility combines `npm outdated` and `npm view` in order to establish a compliance period for dependency checks. This way if a dependency update is within your compliance period you can trigger a warn or if it's beyond your compliance period it can trigger a fail.", "main": "lib/index.js", "bin": "bin/rotten-deps.js",