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..a13094d --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,22 @@ +:root { + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --code-background: var(--dark-code-background); +} } + +body.light { + --code-background: var(--light-code-background); +} + +body.dark { + --code-background: var(--dark-code-background); +} + +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..31494ad --- /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)=>{if(e&&typeof e=="object"||typeof e=="function")for(let n of Oe(e))!_e.call(t,n)&&n!=="default"&&J(t,n,{get:()=>e[n],enumerable:!(r=Pe(e,n))||r.enumerable});return t},Ae=t=>De(Me(J(t!=null?Ce(Re(t)):{},"default",t&&t.__esModule&&"default"in t?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t);var de=Fe((ue,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(oc?h+=2:a==c&&(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 c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,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),f=s.str.charAt(1),v;f in s.node.edges?v=s.node.edges[f]:(v=new t.TokenSet,s.node.edges[f]=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),c=0;c1?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 ue=="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(){let e=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,e!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.secondaryNav.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 ce=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var pe=Ae(de());function fe(){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",ce(()=>{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"?me(e,-1):s.key==="ArrowDown"?me(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=pe.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=n.index.search(`*${i}*`);for(let o=0,a=Math.min(10,s.length);o${ve(c.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=c.classes;let f=document.createElement("a");f.href=n.base+c.url,f.classList.add("tsd-kind-icon"),f.innerHTML=l,h.append(f),e.appendChild(h)}}function me(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 ve(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",ye="mousemove",_="mouseup",G={x:0,y:0},xe=!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",ye="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(ye,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=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!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 oe=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)}},ae=class extends oe{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 oe{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 ae("inherited",!0),this.optionExternals=new ae("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function be(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),we(t.value)})}function we(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}}fe();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&&be(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/search.js b/docs/assets/search.js new file mode 100644 index 0000000..a94cab9 --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = {"kinds":{"2":"Module","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","4194304":"Type alias","16777216":"Reference"},"rows":[{"id":0,"kind":2,"name":"api","url":"modules/api.html","classes":"tsd-kind-module"},{"id":1,"kind":64,"name":"getStudentInfo","url":"modules/api.html#getStudentInfo","classes":"tsd-kind-function tsd-parent-kind-module","parent":"api"},{"id":2,"kind":64,"name":"getActivity","url":"modules/api.html#getActivity","classes":"tsd-kind-function tsd-parent-kind-module","parent":"api"},{"id":3,"kind":64,"name":"getBehaviour","url":"modules/api.html#getBehaviour","classes":"tsd-kind-function tsd-parent-kind-module","parent":"api"},{"id":4,"kind":64,"name":"listHomeworks","url":"modules/api.html#listHomeworks","classes":"tsd-kind-function tsd-parent-kind-module","parent":"api"},{"id":5,"kind":64,"name":"getLessons","url":"modules/api.html#getLessons","classes":"tsd-kind-function tsd-parent-kind-module","parent":"api"},{"id":6,"kind":2,"name":"client","url":"modules/client.html","classes":"tsd-kind-module"},{"id":7,"kind":128,"name":"ClasschartsClient","url":"classes/client.ClasschartsClient.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"client"},{"id":8,"kind":512,"name":"constructor","url":"classes/client.ClasschartsClient.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"client.ClasschartsClient"},{"id":9,"kind":1024,"name":"studentCode","url":"classes/client.ClasschartsClient.html#studentCode","classes":"tsd-kind-property tsd-parent-kind-class","parent":"client.ClasschartsClient"},{"id":10,"kind":1024,"name":"dateOfBirth","url":"classes/client.ClasschartsClient.html#dateOfBirth","classes":"tsd-kind-property tsd-parent-kind-class","parent":"client.ClasschartsClient"},{"id":11,"kind":1024,"name":"studentId","url":"classes/client.ClasschartsClient.html#studentId","classes":"tsd-kind-property tsd-parent-kind-class","parent":"client.ClasschartsClient"},{"id":12,"kind":1024,"name":"studentName","url":"classes/client.ClasschartsClient.html#studentName","classes":"tsd-kind-property tsd-parent-kind-class","parent":"client.ClasschartsClient"},{"id":13,"kind":1024,"name":"authCookies","url":"classes/client.ClasschartsClient.html#authCookies","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"client.ClasschartsClient"},{"id":14,"kind":1024,"name":"sessionId","url":"classes/client.ClasschartsClient.html#sessionId","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"client.ClasschartsClient"},{"id":15,"kind":2048,"name":"makeAuthedRequest","url":"classes/client.ClasschartsClient.html#makeAuthedRequest","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"client.ClasschartsClient"},{"id":16,"kind":2048,"name":"init","url":"classes/client.ClasschartsClient.html#init","classes":"tsd-kind-method tsd-parent-kind-class","parent":"client.ClasschartsClient"},{"id":17,"kind":2048,"name":"getStudentInfo","url":"classes/client.ClasschartsClient.html#getStudentInfo","classes":"tsd-kind-method tsd-parent-kind-class","parent":"client.ClasschartsClient"},{"id":18,"kind":2048,"name":"getActivity","url":"classes/client.ClasschartsClient.html#getActivity","classes":"tsd-kind-method tsd-parent-kind-class","parent":"client.ClasschartsClient"},{"id":19,"kind":2048,"name":"getBehaviour","url":"classes/client.ClasschartsClient.html#getBehaviour","classes":"tsd-kind-method tsd-parent-kind-class","parent":"client.ClasschartsClient"},{"id":20,"kind":2048,"name":"listHomeworks","url":"classes/client.ClasschartsClient.html#listHomeworks","classes":"tsd-kind-method tsd-parent-kind-class","parent":"client.ClasschartsClient"},{"id":21,"kind":2048,"name":"getLessons","url":"classes/client.ClasschartsClient.html#getLessons","classes":"tsd-kind-method tsd-parent-kind-class","parent":"client.ClasschartsClient"},{"id":22,"kind":2,"name":"consts","url":"modules/consts.html","classes":"tsd-kind-module"},{"id":23,"kind":32,"name":"BASE_URL","url":"modules/consts.html#BASE_URL","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"consts"},{"id":24,"kind":32,"name":"API_BASE","url":"modules/consts.html#API_BASE","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"consts"},{"id":25,"kind":2,"name":"index","url":"modules/index.html","classes":"tsd-kind-module"},{"id":26,"kind":2,"name":"types","url":"modules/types.html","classes":"tsd-kind-module"},{"id":27,"kind":256,"name":"Student","url":"interfaces/types.Student.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"types"},{"id":28,"kind":1024,"name":"id","url":"interfaces/types.Student.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":29,"kind":1024,"name":"name","url":"interfaces/types.Student.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":30,"kind":1024,"name":"first_name","url":"interfaces/types.Student.html#first_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":31,"kind":1024,"name":"last_name","url":"interfaces/types.Student.html#last_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":32,"kind":1024,"name":"avatar_url","url":"interfaces/types.Student.html#avatar_url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":33,"kind":1024,"name":"display_behaviour","url":"interfaces/types.Student.html#display_behaviour","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":34,"kind":1024,"name":"display_parent_behaviour","url":"interfaces/types.Student.html#display_parent_behaviour","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":35,"kind":1024,"name":"display_homework","url":"interfaces/types.Student.html#display_homework","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":36,"kind":1024,"name":"display_rewards","url":"interfaces/types.Student.html#display_rewards","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":37,"kind":1024,"name":"display_detentions","url":"interfaces/types.Student.html#display_detentions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":38,"kind":1024,"name":"display_report_cards","url":"interfaces/types.Student.html#display_report_cards","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":39,"kind":1024,"name":"display_classes","url":"interfaces/types.Student.html#display_classes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":40,"kind":1024,"name":"display_announcements","url":"interfaces/types.Student.html#display_announcements","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":41,"kind":1024,"name":"display_attendance","url":"interfaces/types.Student.html#display_attendance","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":42,"kind":1024,"name":"display_attendance_type","url":"interfaces/types.Student.html#display_attendance_type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":43,"kind":1024,"name":"display_attendance_percentage","url":"interfaces/types.Student.html#display_attendance_percentage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":44,"kind":1024,"name":"display_activity","url":"interfaces/types.Student.html#display_activity","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":45,"kind":1024,"name":"display_mental_health","url":"interfaces/types.Student.html#display_mental_health","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":46,"kind":1024,"name":"display_timetable","url":"interfaces/types.Student.html#display_timetable","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":47,"kind":1024,"name":"is_disabled","url":"interfaces/types.Student.html#is_disabled","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":48,"kind":1024,"name":"display_two_way_communications","url":"interfaces/types.Student.html#display_two_way_communications","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":49,"kind":1024,"name":"display_absences","url":"interfaces/types.Student.html#display_absences","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":50,"kind":1024,"name":"can_upload_attachments","url":"interfaces/types.Student.html#can_upload_attachments","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":51,"kind":1024,"name":"display_event_badges","url":"interfaces/types.Student.html#display_event_badges","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":52,"kind":1024,"name":"display_avatars","url":"interfaces/types.Student.html#display_avatars","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":53,"kind":1024,"name":"display_concern_submission","url":"interfaces/types.Student.html#display_concern_submission","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":54,"kind":1024,"name":"display_custom_fields","url":"interfaces/types.Student.html#display_custom_fields","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":55,"kind":1024,"name":"pupil_concerns_help_text","url":"interfaces/types.Student.html#pupil_concerns_help_text","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":56,"kind":1024,"name":"allow_pupils_add_timetable_notes","url":"interfaces/types.Student.html#allow_pupils_add_timetable_notes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":57,"kind":1024,"name":"announcements_count","url":"interfaces/types.Student.html#announcements_count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":58,"kind":1024,"name":"messages_count","url":"interfaces/types.Student.html#messages_count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":59,"kind":1024,"name":"pusher_channel_name","url":"interfaces/types.Student.html#pusher_channel_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":60,"kind":1024,"name":"has_birthday","url":"interfaces/types.Student.html#has_birthday","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":61,"kind":1024,"name":"has_new_survey","url":"interfaces/types.Student.html#has_new_survey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":62,"kind":1024,"name":"survey_id","url":"interfaces/types.Student.html#survey_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":63,"kind":1024,"name":"detention_alias_plural_uc","url":"interfaces/types.Student.html#detention_alias_plural_uc","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Student"},{"id":64,"kind":256,"name":"GetActivityOptions","url":"interfaces/types.GetActivityOptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"types"},{"id":65,"kind":1024,"name":"from","url":"interfaces/types.GetActivityOptions.html#from","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.GetActivityOptions"},{"id":66,"kind":1024,"name":"to","url":"interfaces/types.GetActivityOptions.html#to","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.GetActivityOptions"},{"id":67,"kind":256,"name":"ActivityTimelinePoint","url":"interfaces/types.ActivityTimelinePoint.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"types"},{"id":68,"kind":1024,"name":"positive","url":"interfaces/types.ActivityTimelinePoint.html#positive","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityTimelinePoint"},{"id":69,"kind":1024,"name":"negative","url":"interfaces/types.ActivityTimelinePoint.html#negative","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityTimelinePoint"},{"id":70,"kind":1024,"name":"name","url":"interfaces/types.ActivityTimelinePoint.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityTimelinePoint"},{"id":71,"kind":1024,"name":"start","url":"interfaces/types.ActivityTimelinePoint.html#start","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityTimelinePoint"},{"id":72,"kind":1024,"name":"end","url":"interfaces/types.ActivityTimelinePoint.html#end","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityTimelinePoint"},{"id":73,"kind":256,"name":"ActivityResponse","url":"interfaces/types.ActivityResponse.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"types"},{"id":74,"kind":1024,"name":"timeline","url":"interfaces/types.ActivityResponse.html#timeline","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityResponse"},{"id":75,"kind":1024,"name":"positiveReasons","url":"interfaces/types.ActivityResponse.html#positiveReasons","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityResponse"},{"id":76,"kind":1024,"name":"negative_reasons","url":"interfaces/types.ActivityResponse.html#negative_reasons","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityResponse"},{"id":77,"kind":1024,"name":"other_positive","url":"interfaces/types.ActivityResponse.html#other_positive","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityResponse"},{"id":78,"kind":1024,"name":"other_negative","url":"interfaces/types.ActivityResponse.html#other_negative","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityResponse"},{"id":79,"kind":1024,"name":"other_positive_count","url":"interfaces/types.ActivityResponse.html#other_positive_count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityResponse"},{"id":80,"kind":1024,"name":"other_negative_count","url":"interfaces/types.ActivityResponse.html#other_negative_count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.ActivityResponse"},{"id":81,"kind":256,"name":"GetBehaviourOptions","url":"interfaces/types.GetBehaviourOptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"types"},{"id":82,"kind":1024,"name":"from","url":"interfaces/types.GetBehaviourOptions.html#from","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.GetBehaviourOptions"},{"id":83,"kind":1024,"name":"to","url":"interfaces/types.GetBehaviourOptions.html#to","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.GetBehaviourOptions"},{"id":84,"kind":1024,"name":"last_id","url":"interfaces/types.GetBehaviourOptions.html#last_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.GetBehaviourOptions"},{"id":85,"kind":256,"name":"BehaviourPoint","url":"interfaces/types.BehaviourPoint.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"types"},{"id":86,"kind":1024,"name":"id","url":"interfaces/types.BehaviourPoint.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":87,"kind":1024,"name":"type","url":"interfaces/types.BehaviourPoint.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":88,"kind":1024,"name":"polarity","url":"interfaces/types.BehaviourPoint.html#polarity","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":89,"kind":1024,"name":"reason","url":"interfaces/types.BehaviourPoint.html#reason","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":90,"kind":1024,"name":"score","url":"interfaces/types.BehaviourPoint.html#score","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":91,"kind":1024,"name":"timestamp","url":"interfaces/types.BehaviourPoint.html#timestamp","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":92,"kind":1024,"name":"timestamp_custom_time","url":"interfaces/types.BehaviourPoint.html#timestamp_custom_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":93,"kind":1024,"name":"style","url":"interfaces/types.BehaviourPoint.html#style","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":94,"kind":65536,"name":"__type","url":"interfaces/types.BehaviourPoint.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":95,"kind":1024,"name":"border_color","url":"interfaces/types.BehaviourPoint.html#__type.border_color","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.BehaviourPoint.__type"},{"id":96,"kind":1024,"name":"custom_class","url":"interfaces/types.BehaviourPoint.html#__type.custom_class","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.BehaviourPoint.__type"},{"id":97,"kind":1024,"name":"pupil_name","url":"interfaces/types.BehaviourPoint.html#pupil_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":98,"kind":1024,"name":"lesson_name","url":"interfaces/types.BehaviourPoint.html#lesson_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":99,"kind":1024,"name":"teacher_name","url":"interfaces/types.BehaviourPoint.html#teacher_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":100,"kind":1024,"name":"room_name","url":"interfaces/types.BehaviourPoint.html#room_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":101,"kind":1024,"name":"note","url":"interfaces/types.BehaviourPoint.html#note","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":102,"kind":1024,"name":"_can_delete","url":"interfaces/types.BehaviourPoint.html#_can_delete","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":103,"kind":1024,"name":"detention_date","url":"interfaces/types.BehaviourPoint.html#detention_date","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":104,"kind":1024,"name":"detention_time","url":"interfaces/types.BehaviourPoint.html#detention_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":105,"kind":1024,"name":"detention_location","url":"interfaces/types.BehaviourPoint.html#detention_location","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":106,"kind":1024,"name":"detention_type","url":"interfaces/types.BehaviourPoint.html#detention_type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.BehaviourPoint"},{"id":107,"kind":4194304,"name":"BehaviourResponse","url":"modules/types.html#BehaviourResponse","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"types"},{"id":108,"kind":4194304,"name":"DisplayDate","url":"modules/types.html#DisplayDate","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"types"},{"id":109,"kind":256,"name":"GetHomeworkOptions","url":"interfaces/types.GetHomeworkOptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"types"},{"id":110,"kind":1024,"name":"displayDate","url":"interfaces/types.GetHomeworkOptions.html#displayDate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.GetHomeworkOptions"},{"id":111,"kind":1024,"name":"fromDate","url":"interfaces/types.GetHomeworkOptions.html#fromDate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.GetHomeworkOptions"},{"id":112,"kind":1024,"name":"toDate","url":"interfaces/types.GetHomeworkOptions.html#toDate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.GetHomeworkOptions"},{"id":113,"kind":256,"name":"Homework","url":"interfaces/types.Homework.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"types"},{"id":114,"kind":1024,"name":"lesson","url":"interfaces/types.Homework.html#lesson","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":115,"kind":1024,"name":"subject","url":"interfaces/types.Homework.html#subject","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":116,"kind":1024,"name":"teacher","url":"interfaces/types.Homework.html#teacher","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":117,"kind":1024,"name":"homework_type","url":"interfaces/types.Homework.html#homework_type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":118,"kind":1024,"name":"id","url":"interfaces/types.Homework.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":119,"kind":1024,"name":"title","url":"interfaces/types.Homework.html#title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":120,"kind":1024,"name":"meta_title","url":"interfaces/types.Homework.html#meta_title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":121,"kind":1024,"name":"description","url":"interfaces/types.Homework.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":122,"kind":1024,"name":"issue_date","url":"interfaces/types.Homework.html#issue_date","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":123,"kind":1024,"name":"due_date","url":"interfaces/types.Homework.html#due_date","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":124,"kind":1024,"name":"completion_time_unit","url":"interfaces/types.Homework.html#completion_time_unit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":125,"kind":1024,"name":"completion_time_value","url":"interfaces/types.Homework.html#completion_time_value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":126,"kind":1024,"name":"publish_time","url":"interfaces/types.Homework.html#publish_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":127,"kind":1024,"name":"status","url":"interfaces/types.Homework.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":128,"kind":65536,"name":"__type","url":"interfaces/types.Homework.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"types.Homework"},{"id":129,"kind":1024,"name":"id","url":"interfaces/types.Homework.html#__type.id-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.Homework.__type"},{"id":130,"kind":1024,"name":"state","url":"interfaces/types.Homework.html#__type.state","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.Homework.__type"},{"id":131,"kind":1024,"name":"mark","url":"interfaces/types.Homework.html#__type.mark","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.Homework.__type"},{"id":132,"kind":1024,"name":"mark_relative","url":"interfaces/types.Homework.html#__type.mark_relative","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.Homework.__type"},{"id":133,"kind":1024,"name":"ticked","url":"interfaces/types.Homework.html#__type.ticked","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.Homework.__type"},{"id":134,"kind":1024,"name":"allow_attachments","url":"interfaces/types.Homework.html#__type.allow_attachments","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.Homework.__type"},{"id":135,"kind":1024,"name":"first_seen_date","url":"interfaces/types.Homework.html#__type.first_seen_date","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.Homework.__type"},{"id":136,"kind":1024,"name":"last_seen_date","url":"interfaces/types.Homework.html#__type.last_seen_date","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.Homework.__type"},{"id":137,"kind":1024,"name":"attachments","url":"interfaces/types.Homework.html#__type.attachments","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.Homework.__type"},{"id":138,"kind":1024,"name":"has_feedback","url":"interfaces/types.Homework.html#__type.has_feedback","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"types.Homework.__type"},{"id":139,"kind":1024,"name":"validated_links","url":"interfaces/types.Homework.html#validated_links","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":140,"kind":1024,"name":"validated_attachments","url":"interfaces/types.Homework.html#validated_attachments","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Homework"},{"id":141,"kind":4194304,"name":"HomeworksResponse","url":"modules/types.html#HomeworksResponse","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"types"},{"id":142,"kind":256,"name":"GetLessonsOptions","url":"interfaces/types.GetLessonsOptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"types"},{"id":143,"kind":1024,"name":"date","url":"interfaces/types.GetLessonsOptions.html#date","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.GetLessonsOptions"},{"id":144,"kind":256,"name":"Lesson","url":"interfaces/types.Lesson.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"types"},{"id":145,"kind":1024,"name":"teacher_name","url":"interfaces/types.Lesson.html#teacher_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":146,"kind":1024,"name":"lesson_name","url":"interfaces/types.Lesson.html#lesson_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":147,"kind":1024,"name":"subject_name","url":"interfaces/types.Lesson.html#subject_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":148,"kind":1024,"name":"is_alternative_lesson","url":"interfaces/types.Lesson.html#is_alternative_lesson","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":149,"kind":1024,"name":"period_name","url":"interfaces/types.Lesson.html#period_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":150,"kind":1024,"name":"period_number","url":"interfaces/types.Lesson.html#period_number","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":151,"kind":1024,"name":"room_name","url":"interfaces/types.Lesson.html#room_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":152,"kind":1024,"name":"date","url":"interfaces/types.Lesson.html#date","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":153,"kind":1024,"name":"start_time","url":"interfaces/types.Lesson.html#start_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":154,"kind":1024,"name":"end_time","url":"interfaces/types.Lesson.html#end_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":155,"kind":1024,"name":"key","url":"interfaces/types.Lesson.html#key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":156,"kind":1024,"name":"note_abstract","url":"interfaces/types.Lesson.html#note_abstract","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":157,"kind":1024,"name":"note","url":"interfaces/types.Lesson.html#note","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":158,"kind":1024,"name":"pupil_note_abstract","url":"interfaces/types.Lesson.html#pupil_note_abstract","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":159,"kind":1024,"name":"pupil_note","url":"interfaces/types.Lesson.html#pupil_note","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":160,"kind":1024,"name":"pupil_note_raw","url":"interfaces/types.Lesson.html#pupil_note_raw","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"types.Lesson"},{"id":161,"kind":4194304,"name":"LessonsResponse","url":"modules/types.html#LessonsResponse","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"types"},{"id":162,"kind":16777216,"name":"ClasschartsClient","url":"modules/index.html#ClasschartsClient","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":163,"kind":16777216,"name":"getStudentInfo","url":"modules/index.html#getStudentInfo","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":164,"kind":16777216,"name":"getActivity","url":"modules/index.html#getActivity","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":165,"kind":16777216,"name":"getBehaviour","url":"modules/index.html#getBehaviour","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":166,"kind":16777216,"name":"listHomeworks","url":"modules/index.html#listHomeworks","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":167,"kind":16777216,"name":"getLessons","url":"modules/index.html#getLessons","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,32.581]],["parent/0",[]],["name/1",[1,38.771]],["parent/1",[0,3.218]],["name/2",[2,38.771]],["parent/2",[0,3.218]],["name/3",[3,38.771]],["parent/3",[0,3.218]],["name/4",[4,38.771]],["parent/4",[0,3.218]],["name/5",[5,38.771]],["parent/5",[0,3.218]],["name/6",[6,42.136]],["parent/6",[]],["name/7",[7,42.136]],["parent/7",[6,4.161]],["name/8",[8,47.244]],["parent/8",[9,2.425]],["name/9",[10,47.244]],["parent/9",[9,2.425]],["name/10",[11,47.244]],["parent/10",[9,2.425]],["name/11",[12,47.244]],["parent/11",[9,2.425]],["name/12",[13,47.244]],["parent/12",[9,2.425]],["name/13",[14,47.244]],["parent/13",[9,2.425]],["name/14",[15,47.244]],["parent/14",[9,2.425]],["name/15",[16,47.244]],["parent/15",[9,2.425]],["name/16",[17,47.244]],["parent/16",[9,2.425]],["name/17",[1,38.771]],["parent/17",[9,2.425]],["name/18",[2,38.771]],["parent/18",[9,2.425]],["name/19",[3,38.771]],["parent/19",[9,2.425]],["name/20",[4,38.771]],["parent/20",[9,2.425]],["name/21",[5,38.771]],["parent/21",[9,2.425]],["name/22",[18,38.771]],["parent/22",[]],["name/23",[19,47.244]],["parent/23",[18,3.829]],["name/24",[20,47.244]],["parent/24",[18,3.829]],["name/25",[21,31.15]],["parent/25",[]],["name/26",[22,23.891]],["parent/26",[]],["name/27",[23,47.244]],["parent/27",[22,2.359]],["name/28",[24,36.258]],["parent/28",[25,1.514]],["name/29",[26,42.136]],["parent/29",[25,1.514]],["name/30",[27,47.244]],["parent/30",[25,1.514]],["name/31",[28,47.244]],["parent/31",[25,1.514]],["name/32",[29,47.244]],["parent/32",[25,1.514]],["name/33",[30,47.244]],["parent/33",[25,1.514]],["name/34",[31,47.244]],["parent/34",[25,1.514]],["name/35",[32,47.244]],["parent/35",[25,1.514]],["name/36",[33,47.244]],["parent/36",[25,1.514]],["name/37",[34,47.244]],["parent/37",[25,1.514]],["name/38",[35,47.244]],["parent/38",[25,1.514]],["name/39",[36,47.244]],["parent/39",[25,1.514]],["name/40",[37,47.244]],["parent/40",[25,1.514]],["name/41",[38,47.244]],["parent/41",[25,1.514]],["name/42",[39,47.244]],["parent/42",[25,1.514]],["name/43",[40,47.244]],["parent/43",[25,1.514]],["name/44",[41,47.244]],["parent/44",[25,1.514]],["name/45",[42,47.244]],["parent/45",[25,1.514]],["name/46",[43,47.244]],["parent/46",[25,1.514]],["name/47",[44,47.244]],["parent/47",[25,1.514]],["name/48",[45,47.244]],["parent/48",[25,1.514]],["name/49",[46,47.244]],["parent/49",[25,1.514]],["name/50",[47,47.244]],["parent/50",[25,1.514]],["name/51",[48,47.244]],["parent/51",[25,1.514]],["name/52",[49,47.244]],["parent/52",[25,1.514]],["name/53",[50,47.244]],["parent/53",[25,1.514]],["name/54",[51,47.244]],["parent/54",[25,1.514]],["name/55",[52,47.244]],["parent/55",[25,1.514]],["name/56",[53,47.244]],["parent/56",[25,1.514]],["name/57",[54,47.244]],["parent/57",[25,1.514]],["name/58",[55,47.244]],["parent/58",[25,1.514]],["name/59",[56,47.244]],["parent/59",[25,1.514]],["name/60",[57,47.244]],["parent/60",[25,1.514]],["name/61",[58,47.244]],["parent/61",[25,1.514]],["name/62",[59,47.244]],["parent/62",[25,1.514]],["name/63",[60,47.244]],["parent/63",[25,1.514]],["name/64",[61,47.244]],["parent/64",[22,2.359]],["name/65",[62,42.136]],["parent/65",[63,4.161]],["name/66",[64,42.136]],["parent/66",[63,4.161]],["name/67",[65,47.244]],["parent/67",[22,2.359]],["name/68",[66,47.244]],["parent/68",[67,3.383]],["name/69",[68,47.244]],["parent/69",[67,3.383]],["name/70",[26,42.136]],["parent/70",[67,3.383]],["name/71",[69,47.244]],["parent/71",[67,3.383]],["name/72",[70,47.244]],["parent/72",[67,3.383]],["name/73",[71,47.244]],["parent/73",[22,2.359]],["name/74",[72,47.244]],["parent/74",[73,3.076]],["name/75",[74,47.244]],["parent/75",[73,3.076]],["name/76",[75,47.244]],["parent/76",[73,3.076]],["name/77",[76,47.244]],["parent/77",[73,3.076]],["name/78",[77,47.244]],["parent/78",[73,3.076]],["name/79",[78,47.244]],["parent/79",[73,3.076]],["name/80",[79,47.244]],["parent/80",[73,3.076]],["name/81",[80,47.244]],["parent/81",[22,2.359]],["name/82",[62,42.136]],["parent/82",[81,3.829]],["name/83",[64,42.136]],["parent/83",[81,3.829]],["name/84",[82,47.244]],["parent/84",[81,3.829]],["name/85",[83,47.244]],["parent/85",[22,2.359]],["name/86",[24,36.258]],["parent/86",[84,2.133]],["name/87",[85,47.244]],["parent/87",[84,2.133]],["name/88",[86,47.244]],["parent/88",[84,2.133]],["name/89",[87,47.244]],["parent/89",[84,2.133]],["name/90",[88,47.244]],["parent/90",[84,2.133]],["name/91",[89,47.244]],["parent/91",[84,2.133]],["name/92",[90,47.244]],["parent/92",[84,2.133]],["name/93",[91,47.244]],["parent/93",[84,2.133]],["name/94",[92,42.136]],["parent/94",[84,2.133]],["name/95",[93,47.244]],["parent/95",[94,4.161]],["name/96",[95,47.244]],["parent/96",[94,4.161]],["name/97",[96,47.244]],["parent/97",[84,2.133]],["name/98",[97,42.136]],["parent/98",[84,2.133]],["name/99",[98,42.136]],["parent/99",[84,2.133]],["name/100",[99,42.136]],["parent/100",[84,2.133]],["name/101",[100,42.136]],["parent/101",[84,2.133]],["name/102",[101,47.244]],["parent/102",[84,2.133]],["name/103",[102,47.244]],["parent/103",[84,2.133]],["name/104",[103,47.244]],["parent/104",[84,2.133]],["name/105",[104,47.244]],["parent/105",[84,2.133]],["name/106",[105,47.244]],["parent/106",[84,2.133]],["name/107",[106,47.244]],["parent/107",[22,2.359]],["name/108",[107,42.136]],["parent/108",[22,2.359]],["name/109",[108,47.244]],["parent/109",[22,2.359]],["name/110",[107,42.136]],["parent/110",[109,3.829]],["name/111",[110,47.244]],["parent/111",[109,3.829]],["name/112",[111,47.244]],["parent/112",[109,3.829]],["name/113",[112,47.244]],["parent/113",[22,2.359]],["name/114",[113,42.136]],["parent/114",[114,2.24]],["name/115",[115,47.244]],["parent/115",[114,2.24]],["name/116",[116,47.244]],["parent/116",[114,2.24]],["name/117",[117,47.244]],["parent/117",[114,2.24]],["name/118",[24,36.258]],["parent/118",[114,2.24]],["name/119",[118,47.244]],["parent/119",[114,2.24]],["name/120",[119,47.244]],["parent/120",[114,2.24]],["name/121",[120,47.244]],["parent/121",[114,2.24]],["name/122",[121,47.244]],["parent/122",[114,2.24]],["name/123",[122,47.244]],["parent/123",[114,2.24]],["name/124",[123,47.244]],["parent/124",[114,2.24]],["name/125",[124,47.244]],["parent/125",[114,2.24]],["name/126",[125,47.244]],["parent/126",[114,2.24]],["name/127",[126,47.244]],["parent/127",[114,2.24]],["name/128",[92,42.136]],["parent/128",[114,2.24]],["name/129",[24,36.258]],["parent/129",[127,2.744]],["name/130",[128,47.244]],["parent/130",[127,2.744]],["name/131",[129,47.244]],["parent/131",[127,2.744]],["name/132",[130,47.244]],["parent/132",[127,2.744]],["name/133",[131,47.244]],["parent/133",[127,2.744]],["name/134",[132,47.244]],["parent/134",[127,2.744]],["name/135",[133,47.244]],["parent/135",[127,2.744]],["name/136",[134,47.244]],["parent/136",[127,2.744]],["name/137",[135,47.244]],["parent/137",[127,2.744]],["name/138",[136,47.244]],["parent/138",[127,2.744]],["name/139",[137,47.244]],["parent/139",[114,2.24]],["name/140",[138,47.244]],["parent/140",[114,2.24]],["name/141",[139,47.244]],["parent/141",[22,2.359]],["name/142",[140,47.244]],["parent/142",[22,2.359]],["name/143",[141,42.136]],["parent/143",[142,4.666]],["name/144",[113,42.136]],["parent/144",[22,2.359]],["name/145",[98,42.136]],["parent/145",[143,2.298]],["name/146",[97,42.136]],["parent/146",[143,2.298]],["name/147",[144,47.244]],["parent/147",[143,2.298]],["name/148",[145,47.244]],["parent/148",[143,2.298]],["name/149",[146,47.244]],["parent/149",[143,2.298]],["name/150",[147,47.244]],["parent/150",[143,2.298]],["name/151",[99,42.136]],["parent/151",[143,2.298]],["name/152",[141,42.136]],["parent/152",[143,2.298]],["name/153",[148,47.244]],["parent/153",[143,2.298]],["name/154",[149,47.244]],["parent/154",[143,2.298]],["name/155",[150,47.244]],["parent/155",[143,2.298]],["name/156",[151,47.244]],["parent/156",[143,2.298]],["name/157",[100,42.136]],["parent/157",[143,2.298]],["name/158",[152,47.244]],["parent/158",[143,2.298]],["name/159",[153,47.244]],["parent/159",[143,2.298]],["name/160",[154,47.244]],["parent/160",[143,2.298]],["name/161",[155,47.244]],["parent/161",[22,2.359]],["name/162",[7,42.136]],["parent/162",[21,3.076]],["name/163",[1,38.771]],["parent/163",[21,3.076]],["name/164",[2,38.771]],["parent/164",[21,3.076]],["name/165",[3,38.771]],["parent/165",[21,3.076]],["name/166",[4,38.771]],["parent/166",[21,3.076]],["name/167",[5,38.771]],["parent/167",[21,3.076]]],"invertedIndex":[["__type",{"_index":92,"name":{"94":{},"128":{}},"parent":{}}],["_can_delete",{"_index":101,"name":{"102":{}},"parent":{}}],["activityresponse",{"_index":71,"name":{"73":{}},"parent":{}}],["activitytimelinepoint",{"_index":65,"name":{"67":{}},"parent":{}}],["allow_attachments",{"_index":132,"name":{"134":{}},"parent":{}}],["allow_pupils_add_timetable_notes",{"_index":53,"name":{"56":{}},"parent":{}}],["announcements_count",{"_index":54,"name":{"57":{}},"parent":{}}],["api",{"_index":0,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{}}}],["api_base",{"_index":20,"name":{"24":{}},"parent":{}}],["attachments",{"_index":135,"name":{"137":{}},"parent":{}}],["authcookies",{"_index":14,"name":{"13":{}},"parent":{}}],["avatar_url",{"_index":29,"name":{"32":{}},"parent":{}}],["base_url",{"_index":19,"name":{"23":{}},"parent":{}}],["behaviourpoint",{"_index":83,"name":{"85":{}},"parent":{}}],["behaviourresponse",{"_index":106,"name":{"107":{}},"parent":{}}],["border_color",{"_index":93,"name":{"95":{}},"parent":{}}],["can_upload_attachments",{"_index":47,"name":{"50":{}},"parent":{}}],["classchartsclient",{"_index":7,"name":{"7":{},"162":{}},"parent":{}}],["client",{"_index":6,"name":{"6":{}},"parent":{"7":{}}}],["client.classchartsclient",{"_index":9,"name":{},"parent":{"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{}}}],["completion_time_unit",{"_index":123,"name":{"124":{}},"parent":{}}],["completion_time_value",{"_index":124,"name":{"125":{}},"parent":{}}],["constructor",{"_index":8,"name":{"8":{}},"parent":{}}],["consts",{"_index":18,"name":{"22":{}},"parent":{"23":{},"24":{}}}],["custom_class",{"_index":95,"name":{"96":{}},"parent":{}}],["date",{"_index":141,"name":{"143":{},"152":{}},"parent":{}}],["dateofbirth",{"_index":11,"name":{"10":{}},"parent":{}}],["description",{"_index":120,"name":{"121":{}},"parent":{}}],["detention_alias_plural_uc",{"_index":60,"name":{"63":{}},"parent":{}}],["detention_date",{"_index":102,"name":{"103":{}},"parent":{}}],["detention_location",{"_index":104,"name":{"105":{}},"parent":{}}],["detention_time",{"_index":103,"name":{"104":{}},"parent":{}}],["detention_type",{"_index":105,"name":{"106":{}},"parent":{}}],["display_absences",{"_index":46,"name":{"49":{}},"parent":{}}],["display_activity",{"_index":41,"name":{"44":{}},"parent":{}}],["display_announcements",{"_index":37,"name":{"40":{}},"parent":{}}],["display_attendance",{"_index":38,"name":{"41":{}},"parent":{}}],["display_attendance_percentage",{"_index":40,"name":{"43":{}},"parent":{}}],["display_attendance_type",{"_index":39,"name":{"42":{}},"parent":{}}],["display_avatars",{"_index":49,"name":{"52":{}},"parent":{}}],["display_behaviour",{"_index":30,"name":{"33":{}},"parent":{}}],["display_classes",{"_index":36,"name":{"39":{}},"parent":{}}],["display_concern_submission",{"_index":50,"name":{"53":{}},"parent":{}}],["display_custom_fields",{"_index":51,"name":{"54":{}},"parent":{}}],["display_detentions",{"_index":34,"name":{"37":{}},"parent":{}}],["display_event_badges",{"_index":48,"name":{"51":{}},"parent":{}}],["display_homework",{"_index":32,"name":{"35":{}},"parent":{}}],["display_mental_health",{"_index":42,"name":{"45":{}},"parent":{}}],["display_parent_behaviour",{"_index":31,"name":{"34":{}},"parent":{}}],["display_report_cards",{"_index":35,"name":{"38":{}},"parent":{}}],["display_rewards",{"_index":33,"name":{"36":{}},"parent":{}}],["display_timetable",{"_index":43,"name":{"46":{}},"parent":{}}],["display_two_way_communications",{"_index":45,"name":{"48":{}},"parent":{}}],["displaydate",{"_index":107,"name":{"108":{},"110":{}},"parent":{}}],["due_date",{"_index":122,"name":{"123":{}},"parent":{}}],["end",{"_index":70,"name":{"72":{}},"parent":{}}],["end_time",{"_index":149,"name":{"154":{}},"parent":{}}],["first_name",{"_index":27,"name":{"30":{}},"parent":{}}],["first_seen_date",{"_index":133,"name":{"135":{}},"parent":{}}],["from",{"_index":62,"name":{"65":{},"82":{}},"parent":{}}],["fromdate",{"_index":110,"name":{"111":{}},"parent":{}}],["getactivity",{"_index":2,"name":{"2":{},"18":{},"164":{}},"parent":{}}],["getactivityoptions",{"_index":61,"name":{"64":{}},"parent":{}}],["getbehaviour",{"_index":3,"name":{"3":{},"19":{},"165":{}},"parent":{}}],["getbehaviouroptions",{"_index":80,"name":{"81":{}},"parent":{}}],["gethomeworkoptions",{"_index":108,"name":{"109":{}},"parent":{}}],["getlessons",{"_index":5,"name":{"5":{},"21":{},"167":{}},"parent":{}}],["getlessonsoptions",{"_index":140,"name":{"142":{}},"parent":{}}],["getstudentinfo",{"_index":1,"name":{"1":{},"17":{},"163":{}},"parent":{}}],["has_birthday",{"_index":57,"name":{"60":{}},"parent":{}}],["has_feedback",{"_index":136,"name":{"138":{}},"parent":{}}],["has_new_survey",{"_index":58,"name":{"61":{}},"parent":{}}],["homework",{"_index":112,"name":{"113":{}},"parent":{}}],["homework_type",{"_index":117,"name":{"117":{}},"parent":{}}],["homeworksresponse",{"_index":139,"name":{"141":{}},"parent":{}}],["id",{"_index":24,"name":{"28":{},"86":{},"118":{},"129":{}},"parent":{}}],["index",{"_index":21,"name":{"25":{}},"parent":{"162":{},"163":{},"164":{},"165":{},"166":{},"167":{}}}],["init",{"_index":17,"name":{"16":{}},"parent":{}}],["is_alternative_lesson",{"_index":145,"name":{"148":{}},"parent":{}}],["is_disabled",{"_index":44,"name":{"47":{}},"parent":{}}],["issue_date",{"_index":121,"name":{"122":{}},"parent":{}}],["key",{"_index":150,"name":{"155":{}},"parent":{}}],["last_id",{"_index":82,"name":{"84":{}},"parent":{}}],["last_name",{"_index":28,"name":{"31":{}},"parent":{}}],["last_seen_date",{"_index":134,"name":{"136":{}},"parent":{}}],["lesson",{"_index":113,"name":{"114":{},"144":{}},"parent":{}}],["lesson_name",{"_index":97,"name":{"98":{},"146":{}},"parent":{}}],["lessonsresponse",{"_index":155,"name":{"161":{}},"parent":{}}],["listhomeworks",{"_index":4,"name":{"4":{},"20":{},"166":{}},"parent":{}}],["makeauthedrequest",{"_index":16,"name":{"15":{}},"parent":{}}],["mark",{"_index":129,"name":{"131":{}},"parent":{}}],["mark_relative",{"_index":130,"name":{"132":{}},"parent":{}}],["messages_count",{"_index":55,"name":{"58":{}},"parent":{}}],["meta_title",{"_index":119,"name":{"120":{}},"parent":{}}],["name",{"_index":26,"name":{"29":{},"70":{}},"parent":{}}],["negative",{"_index":68,"name":{"69":{}},"parent":{}}],["negative_reasons",{"_index":75,"name":{"76":{}},"parent":{}}],["note",{"_index":100,"name":{"101":{},"157":{}},"parent":{}}],["note_abstract",{"_index":151,"name":{"156":{}},"parent":{}}],["other_negative",{"_index":77,"name":{"78":{}},"parent":{}}],["other_negative_count",{"_index":79,"name":{"80":{}},"parent":{}}],["other_positive",{"_index":76,"name":{"77":{}},"parent":{}}],["other_positive_count",{"_index":78,"name":{"79":{}},"parent":{}}],["period_name",{"_index":146,"name":{"149":{}},"parent":{}}],["period_number",{"_index":147,"name":{"150":{}},"parent":{}}],["polarity",{"_index":86,"name":{"88":{}},"parent":{}}],["positive",{"_index":66,"name":{"68":{}},"parent":{}}],["positivereasons",{"_index":74,"name":{"75":{}},"parent":{}}],["publish_time",{"_index":125,"name":{"126":{}},"parent":{}}],["pupil_concerns_help_text",{"_index":52,"name":{"55":{}},"parent":{}}],["pupil_name",{"_index":96,"name":{"97":{}},"parent":{}}],["pupil_note",{"_index":153,"name":{"159":{}},"parent":{}}],["pupil_note_abstract",{"_index":152,"name":{"158":{}},"parent":{}}],["pupil_note_raw",{"_index":154,"name":{"160":{}},"parent":{}}],["pusher_channel_name",{"_index":56,"name":{"59":{}},"parent":{}}],["reason",{"_index":87,"name":{"89":{}},"parent":{}}],["room_name",{"_index":99,"name":{"100":{},"151":{}},"parent":{}}],["score",{"_index":88,"name":{"90":{}},"parent":{}}],["sessionid",{"_index":15,"name":{"14":{}},"parent":{}}],["start",{"_index":69,"name":{"71":{}},"parent":{}}],["start_time",{"_index":148,"name":{"153":{}},"parent":{}}],["state",{"_index":128,"name":{"130":{}},"parent":{}}],["status",{"_index":126,"name":{"127":{}},"parent":{}}],["student",{"_index":23,"name":{"27":{}},"parent":{}}],["studentcode",{"_index":10,"name":{"9":{}},"parent":{}}],["studentid",{"_index":12,"name":{"11":{}},"parent":{}}],["studentname",{"_index":13,"name":{"12":{}},"parent":{}}],["style",{"_index":91,"name":{"93":{}},"parent":{}}],["subject",{"_index":115,"name":{"115":{}},"parent":{}}],["subject_name",{"_index":144,"name":{"147":{}},"parent":{}}],["survey_id",{"_index":59,"name":{"62":{}},"parent":{}}],["teacher",{"_index":116,"name":{"116":{}},"parent":{}}],["teacher_name",{"_index":98,"name":{"99":{},"145":{}},"parent":{}}],["ticked",{"_index":131,"name":{"133":{}},"parent":{}}],["timeline",{"_index":72,"name":{"74":{}},"parent":{}}],["timestamp",{"_index":89,"name":{"91":{}},"parent":{}}],["timestamp_custom_time",{"_index":90,"name":{"92":{}},"parent":{}}],["title",{"_index":118,"name":{"119":{}},"parent":{}}],["to",{"_index":64,"name":{"66":{},"83":{}},"parent":{}}],["todate",{"_index":111,"name":{"112":{}},"parent":{}}],["type",{"_index":85,"name":{"87":{}},"parent":{}}],["types",{"_index":22,"name":{"26":{}},"parent":{"27":{},"64":{},"67":{},"73":{},"81":{},"85":{},"107":{},"108":{},"109":{},"113":{},"141":{},"142":{},"144":{},"161":{}}}],["types.activityresponse",{"_index":73,"name":{},"parent":{"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{}}}],["types.activitytimelinepoint",{"_index":67,"name":{},"parent":{"68":{},"69":{},"70":{},"71":{},"72":{}}}],["types.behaviourpoint",{"_index":84,"name":{},"parent":{"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{}}}],["types.behaviourpoint.__type",{"_index":94,"name":{},"parent":{"95":{},"96":{}}}],["types.getactivityoptions",{"_index":63,"name":{},"parent":{"65":{},"66":{}}}],["types.getbehaviouroptions",{"_index":81,"name":{},"parent":{"82":{},"83":{},"84":{}}}],["types.gethomeworkoptions",{"_index":109,"name":{},"parent":{"110":{},"111":{},"112":{}}}],["types.getlessonsoptions",{"_index":142,"name":{},"parent":{"143":{}}}],["types.homework",{"_index":114,"name":{},"parent":{"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"139":{},"140":{}}}],["types.homework.__type",{"_index":127,"name":{},"parent":{"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{}}}],["types.lesson",{"_index":143,"name":{},"parent":{"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"160":{}}}],["types.student",{"_index":25,"name":{},"parent":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"62":{},"63":{}}}],["validated_attachments",{"_index":138,"name":{"140":{}},"parent":{}}],["validated_links",{"_index":137,"name":{"139":{}},"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..28f90b6 --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1388 @@ +@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 { + 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%; +} 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/classes/client.ClasschartsClient.html b/docs/classes/client.ClasschartsClient.html new file mode 100644 index 0000000..e325905 --- /dev/null +++ b/docs/classes/client.ClasschartsClient.html @@ -0,0 +1,32 @@ +ClasschartsClient | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClasschartsClient

+

The base client

+

Hierarchy

  • ClasschartsClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ClasschartsClient(studentCode: string, dateOfBirth: null | string): ClasschartsClient

  • Parameters

    • studentCode: string
      +

      Classcharts student code

      +
    • dateOfBirth: null | string
      +

      Student's date of birth

      +

    Returns ClasschartsClient

Properties

Private authCookies

authCookies: undefined | string[]

dateOfBirth

dateOfBirth: string = ''

Private sessionId

sessionId: string = ''

studentCode

studentCode: string = ''

studentId

studentId: number = 0

studentName

studentName: string = ''

Methods

getActivity

getBehaviour

getLessons

getStudentInfo

  • +

    Gets general information about the logged in student

    +

    Returns Promise<Student>

    Student object

    +

init

  • init(): Promise<void>
  • +

    Initialises the client and authenticates with classcharts

    +

    Returns Promise<void>

listHomeworks

Private makeAuthedRequest

  • makeAuthedRequest(path: string, options: Omit<RequestOptions, "origin" | "path">): Promise<any>

  • Parameters

    • path: string
    • options: Omit<RequestOptions, "origin" | "path">

    Returns Promise<any>

Legend

  • Class
  • Constructor
  • Property
  • Method
  • Variable
  • Function
  • Type alias
  • Private property
  • Private method
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..e5d006f --- /dev/null +++ b/docs/index.html @@ -0,0 +1,6 @@ +classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

classcharts-api

+ +

Classcharts API

+ +

A very WIP client for the classcharts API

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/types.ActivityResponse.html b/docs/interfaces/types.ActivityResponse.html new file mode 100644 index 0000000..45e5b86 --- /dev/null +++ b/docs/interfaces/types.ActivityResponse.html @@ -0,0 +1 @@ +ActivityResponse | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ActivityResponse

Hierarchy

  • ActivityResponse

Index

Properties

Properties

negative_reasons

negative_reasons: Record<string, string>

other_negative

other_negative: any[]

other_negative_count

other_negative_count: any[]

other_positive

other_positive: any[]

other_positive_count

other_positive_count: any[]

positiveReasons

positiveReasons: Record<string, string>

timeline

timeline: ActivityTimelinePoint[]

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/types.ActivityTimelinePoint.html b/docs/interfaces/types.ActivityTimelinePoint.html new file mode 100644 index 0000000..cb60f45 --- /dev/null +++ b/docs/interfaces/types.ActivityTimelinePoint.html @@ -0,0 +1 @@ +ActivityTimelinePoint | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ActivityTimelinePoint

Hierarchy

  • ActivityTimelinePoint

Index

Properties

Properties

end

end: string

name

name: string

negative

negative: number

positive

positive: number

start

start: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/types.BehaviourPoint.html b/docs/interfaces/types.BehaviourPoint.html new file mode 100644 index 0000000..914ee1c --- /dev/null +++ b/docs/interfaces/types.BehaviourPoint.html @@ -0,0 +1 @@ +BehaviourPoint | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BehaviourPoint

Hierarchy

  • BehaviourPoint

Index

Properties

Properties

_can_delete

_can_delete: string

detention_date

detention_date: null | string

detention_location

detention_location: null | string

detention_time

detention_time: null | string

detention_type

detention_type: null | string

id

id: number

lesson_name

lesson_name: string

note

note: string

polarity

polarity: string

pupil_name

pupil_name: string

reason

reason: string

room_name

room_name: null | string

score

score: number

style

style: { border_color: null | string; custom_class: null | string }

Type declaration

  • border_color: null | string
  • custom_class: null | string

teacher_name

teacher_name: string

timestamp

timestamp: string

timestamp_custom_time

timestamp_custom_time: null | string

type

type: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/types.GetActivityOptions.html b/docs/interfaces/types.GetActivityOptions.html new file mode 100644 index 0000000..ffddbac --- /dev/null +++ b/docs/interfaces/types.GetActivityOptions.html @@ -0,0 +1 @@ +GetActivityOptions | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetActivityOptions

Hierarchy

  • GetActivityOptions

Index

Properties

Properties

from

from: undefined | string

to

to: undefined | string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/types.GetBehaviourOptions.html b/docs/interfaces/types.GetBehaviourOptions.html new file mode 100644 index 0000000..a5d52fd --- /dev/null +++ b/docs/interfaces/types.GetBehaviourOptions.html @@ -0,0 +1 @@ +GetBehaviourOptions | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetBehaviourOptions

Hierarchy

  • GetBehaviourOptions

Index

Properties

Properties

from

from: undefined | string

last_id

last_id: undefined | string

to

to: undefined | string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/types.GetHomeworkOptions.html b/docs/interfaces/types.GetHomeworkOptions.html new file mode 100644 index 0000000..5b72060 --- /dev/null +++ b/docs/interfaces/types.GetHomeworkOptions.html @@ -0,0 +1 @@ +GetHomeworkOptions | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetHomeworkOptions

Hierarchy

  • GetHomeworkOptions

Index

Properties

Properties

displayDate

displayDate: DisplayDate

fromDate

fromDate: string

toDate

toDate: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/types.GetLessonsOptions.html b/docs/interfaces/types.GetLessonsOptions.html new file mode 100644 index 0000000..2cfc58f --- /dev/null +++ b/docs/interfaces/types.GetLessonsOptions.html @@ -0,0 +1 @@ +GetLessonsOptions | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetLessonsOptions

Hierarchy

  • GetLessonsOptions

Index

Properties

Properties

date

date: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/types.Homework.html b/docs/interfaces/types.Homework.html new file mode 100644 index 0000000..4ed3a82 --- /dev/null +++ b/docs/interfaces/types.Homework.html @@ -0,0 +1 @@ +Homework | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Homework

Hierarchy

  • Homework

Index

Properties

Properties

completion_time_unit

completion_time_unit: string

completion_time_value

completion_time_value: string

description

description: string

due_date

due_date: string

homework_type

homework_type: string

id

id: number

issue_date

issue_date: string

lesson

lesson: string

meta_title

meta_title: string

publish_time

publish_time: string

status

status: { allow_attachments: string; attachments: any[]; first_seen_date: string; has_feedback: boolean; id: number; last_seen_date: string; mark: null; mark_relative: number; state: null; ticked: boolean }

Type declaration

  • allow_attachments: string
  • attachments: any[]
  • first_seen_date: string
  • has_feedback: boolean
  • id: number
  • last_seen_date: string
  • mark: null
  • mark_relative: number
  • state: null
  • ticked: boolean

subject

subject: string

teacher

teacher: string

title

title: string

validated_attachments

validated_attachments: any[]

validated_links

validated_links: any[]

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/types.Lesson.html b/docs/interfaces/types.Lesson.html new file mode 100644 index 0000000..b68977c --- /dev/null +++ b/docs/interfaces/types.Lesson.html @@ -0,0 +1 @@ +Lesson | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Lesson

Hierarchy

  • Lesson

Index

Properties

Properties

date

date: string

end_time

end_time: string

is_alternative_lesson

is_alternative_lesson: boolean

key

key: number

lesson_name

lesson_name: string

note

note: string

note_abstract

note_abstract: string

period_name

period_name: string

period_number

period_number: string

pupil_note

pupil_note: string

pupil_note_abstract

pupil_note_abstract: string

pupil_note_raw

pupil_note_raw: string

room_name

room_name: string

start_time

start_time: string

subject_name

subject_name: string

teacher_name

teacher_name: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/types.Student.html b/docs/interfaces/types.Student.html new file mode 100644 index 0000000..c01d994 --- /dev/null +++ b/docs/interfaces/types.Student.html @@ -0,0 +1 @@ +Student | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Student

Hierarchy

  • Student

Index

Properties

Properties

allow_pupils_add_timetable_notes

allow_pupils_add_timetable_notes: boolean

announcements_count

announcements_count: number

avatar_url

avatar_url: string

can_upload_attachments

can_upload_attachments: null | string

detention_alias_plural_uc

detention_alias_plural_uc: string

display_absences

display_absences: boolean

display_activity

display_activity: boolean

display_announcements

display_announcements: boolean

display_attendance

display_attendance: boolean

display_attendance_percentage

display_attendance_percentage: boolean

display_attendance_type

display_attendance_type: string

display_avatars

display_avatars: boolean

display_behaviour

display_behaviour: boolean

display_classes

display_classes: boolean

display_concern_submission

display_concern_submission: boolean

display_custom_fields

display_custom_fields: boolean

display_detentions

display_detentions: boolean

display_event_badges

display_event_badges: boolean

display_homework

display_homework: boolean

display_mental_health

display_mental_health: boolean

display_parent_behaviour

display_parent_behaviour: boolean

display_report_cards

display_report_cards: boolean

display_rewards

display_rewards: boolean

display_timetable

display_timetable: boolean

display_two_way_communications

display_two_way_communications: boolean

first_name

first_name: string

has_birthday

has_birthday: boolean

has_new_survey

has_new_survey: boolean

id

id: number

is_disabled

is_disabled: boolean

last_name

last_name: string

messages_count

messages_count: number

name

name: string

pupil_concerns_help_text

pupil_concerns_help_text: string

pusher_channel_name

pusher_channel_name: string

survey_id

survey_id: null | number

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

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..0f6fb5a --- /dev/null +++ b/docs/modules.html @@ -0,0 +1 @@ +classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

classcharts-api

Index

Modules

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/api.html b/docs/modules/api.html new file mode 100644 index 0000000..4eb82ed --- /dev/null +++ b/docs/modules/api.html @@ -0,0 +1 @@ +api | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module api

Index

Functions

Functions

getActivity

getBehaviour

getLessons

getStudentInfo

  • getStudentInfo(studentCode: string, dateOfBirth: null | string): Promise<Student>

  • Parameters

    • studentCode: string
    • dateOfBirth: null | string

    Returns Promise<Student>

listHomeworks

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/client.html b/docs/modules/client.html new file mode 100644 index 0000000..aa30bc5 --- /dev/null +++ b/docs/modules/client.html @@ -0,0 +1 @@ +client | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module client

Index

Classes

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/consts.html b/docs/modules/consts.html new file mode 100644 index 0000000..fd9e5c1 --- /dev/null +++ b/docs/modules/consts.html @@ -0,0 +1 @@ +consts | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module consts

Index

Variables

Variables

API_BASE

API_BASE: string = ...

BASE_URL

BASE_URL: "https://www.classcharts.com" = 'https://www.classcharts.com'

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html new file mode 100644 index 0000000..bf3e77d --- /dev/null +++ b/docs/modules/index.html @@ -0,0 +1 @@ +index | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module index

Index

References

References

ClasschartsClient

Re-exports ClasschartsClient

getActivity

Re-exports getActivity

getBehaviour

Re-exports getBehaviour

getLessons

Re-exports getLessons

getStudentInfo

Re-exports getStudentInfo

listHomeworks

Re-exports listHomeworks

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/types.html b/docs/modules/types.html new file mode 100644 index 0000000..5e3ee14 --- /dev/null +++ b/docs/modules/types.html @@ -0,0 +1 @@ +types | classcharts-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module types

Index

Interfaces

Type aliases

Type aliases

BehaviourResponse

BehaviourResponse: BehaviourPoint[]

DisplayDate

DisplayDate: "due_date" | "issue_date"

HomeworksResponse

HomeworksResponse: Homework[]

LessonsResponse

LessonsResponse: Lesson[]

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/package.json b/package.json index 4c61466..e30c949 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,8 @@ }, "main": "./index.js", "scripts": { - "prepublishOnly": "pnpm tsc && node dist/release.js" + "prepublishOnly": "pnpm tsc && node dist/release.js", + "generateDocs": "pnpm typedoc --entryPointStrategy expand ./src" }, "author": "", "license": "ISC", @@ -16,7 +17,8 @@ }, "devDependencies": { "@types/node": "^16.11.6", + "typedoc": "^0.22.7", "typescript": "^4.4.4" }, - "types": "./index.d.ts" -} + "types": "./types.d.ts" +} \ No newline at end of file diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index baa2f12..9970017 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -2,6 +2,7 @@ lockfileVersion: 5.3 specifiers: '@types/node': ^16.11.6 + typedoc: ^0.22.7 typescript: ^4.4.4 undici: ^4.9.2 @@ -10,6 +11,7 @@ dependencies: devDependencies: '@types/node': 16.11.6 + typedoc: 0.22.7_typescript@4.4.4 typescript: 4.4.4 packages: @@ -18,6 +20,113 @@ packages: resolution: {integrity: sha512-ua7PgUoeQFjmWPcoo9khiPum3Pd60k4/2ZGXt18sm2Slk0W0xZTqt5Y0Ny1NyBiN1EVQ/+FaF9NcY4Qe6rwk5w==} dev: true + /balanced-match/1.0.2: + resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==} + dev: true + + /brace-expansion/1.1.11: + resolution: {integrity: sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==} + dependencies: + balanced-match: 1.0.2 + concat-map: 0.0.1 + dev: true + + /concat-map/0.0.1: + resolution: {integrity: sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=} + dev: true + + /fs.realpath/1.0.0: + resolution: {integrity: sha1-FQStJSMVjKpA20onh8sBQRmU6k8=} + dev: true + + /glob/7.2.0: + resolution: {integrity: sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==} + dependencies: + fs.realpath: 1.0.0 + inflight: 1.0.6 + inherits: 2.0.4 + minimatch: 3.0.4 + once: 1.4.0 + path-is-absolute: 1.0.1 + dev: true + + /inflight/1.0.6: + resolution: {integrity: sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=} + dependencies: + once: 1.4.0 + wrappy: 1.0.2 + dev: true + + /inherits/2.0.4: + resolution: {integrity: sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==} + dev: true + + /jsonc-parser/3.0.0: + resolution: {integrity: sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==} + dev: true + + /lru-cache/5.1.1: + resolution: {integrity: sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==} + dependencies: + yallist: 3.1.1 + dev: true + + /lunr/2.3.9: + resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==} + dev: true + + /marked/3.0.8: + resolution: {integrity: sha512-0gVrAjo5m0VZSJb4rpL59K1unJAMb/hm8HRXqasD8VeC8m91ytDPMritgFSlKonfdt+rRYYpP/JfLxgIX8yoSw==} + engines: {node: '>= 12'} + hasBin: true + dev: true + + /minimatch/3.0.4: + resolution: {integrity: sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==} + dependencies: + brace-expansion: 1.1.11 + dev: true + + /once/1.4.0: + resolution: {integrity: sha1-WDsap3WWHUsROsF9nFC6753Xa9E=} + dependencies: + wrappy: 1.0.2 + dev: true + + /onigasm/2.2.5: + resolution: {integrity: sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==} + dependencies: + lru-cache: 5.1.1 + dev: true + + /path-is-absolute/1.0.1: + resolution: {integrity: sha1-F0uSaHNVNP+8es5r9TpanhtcX18=} + engines: {node: '>=0.10.0'} + dev: true + + /shiki/0.9.12: + resolution: {integrity: sha512-VXcROdldv0/Qu0w2XvzU4IrvTeBNs/Kj/FCmtcEXGz7Tic/veQzliJj6tEiAgoKianhQstpYmbPDStHU5Opqcw==} + dependencies: + jsonc-parser: 3.0.0 + onigasm: 2.2.5 + vscode-textmate: 5.2.0 + dev: true + + /typedoc/0.22.7_typescript@4.4.4: + resolution: {integrity: sha512-ndxxp+tU1Wczvdxp4u2/PvT1qjD6hdFdSdehpORHjE+JXmMkl2bftXCR0upHmsnesBG7VCcr8vfgloGHIH8glQ==} + engines: {node: '>= 12.10.0'} + hasBin: true + peerDependencies: + typescript: 4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x + dependencies: + glob: 7.2.0 + lunr: 2.3.9 + marked: 3.0.8 + minimatch: 3.0.4 + shiki: 0.9.12 + typescript: 4.4.4 + dev: true + /typescript/4.4.4: resolution: {integrity: sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==} engines: {node: '>=4.2.0'} @@ -28,3 +137,15 @@ packages: resolution: {integrity: sha512-O8D4fp0cT7/bOMe7XE2oc0PaBCyc0GsahzQ+nMSeWW0o0+EB2ykXYNhU0kY2nKP589zzS91pLj979NtJrBRwFQ==} engines: {node: '>=12.18'} dev: false + + /vscode-textmate/5.2.0: + resolution: {integrity: sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==} + dev: true + + /wrappy/1.0.2: + resolution: {integrity: sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=} + dev: true + + /yallist/3.1.1: + resolution: {integrity: sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==} + dev: true