diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e2ac6616 --- /dev/null +++ b/.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/assets/highlight.css b/assets/highlight.css new file mode 100644 index 00000000..558e10b2 --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,85 @@ +:root { + --light-hl-0: #0000FF; + --dark-hl-0: #569CD6; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #0070C1; + --dark-hl-2: #4FC1FF; + --light-hl-3: #795E26; + --dark-hl-3: #DCDCAA; + --light-hl-4: #A31515; + --dark-hl-4: #CE9178; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #008000; + --dark-hl-6: #6A9955; + --light-hl-7: #AF00DB; + --dark-hl-7: #C586C0; + --light-hl-8: #267F99; + --dark-hl-8: #4EC9B0; + --light-code-background: #F5F5F5; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --code-background: var(--dark-code-background); +} } + +body.light { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --code-background: var(--light-code-background); +} + +body.dark { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +pre, code { background: var(--code-background); } diff --git a/assets/icons.css b/assets/icons.css new file mode 100644 index 00000000..776a3562 --- /dev/null +++ b/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/assets/icons.png b/assets/icons.png new file mode 100644 index 00000000..3836d5fe Binary files /dev/null and b/assets/icons.png differ diff --git a/assets/icons@2x.png b/assets/icons@2x.png new file mode 100644 index 00000000..5a209e2f Binary files /dev/null and b/assets/icons@2x.png differ diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 00000000..bd45452d --- /dev/null +++ b/assets/main.js @@ -0,0 +1,52 @@ +(()=>{var Ce=Object.create;var ue=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&i!==r&&ue(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t};var Fe=(t,e,r)=>(r=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ue(r,"default",{value:t,enumerable:!0}):r,t));var pe=Me((de,fe)=>{(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,u],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(ol?h+=2:a==l&&(r+=n[u+1]*i[h+1],u+=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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,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),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,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),l=0;l1?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 de=="object"?fe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ce=[];function N(t,e){ce.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){ce.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=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 ie=class extends J{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",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onScroll(){this.scrollTop=window.scrollY||0;let r=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(r),this.hideShowToolbar()}hideShowToolbar(){var n;let r=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,r!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(n=this.secondaryNav)==null||n.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},Q=ie;Q.instance=new ie;var X=class extends k{constructor(r){super(r);this.anchors=[];this.index=-1;Q.instance.addEventListener("resize",()=>this.onResize()),Q.instance.addEventListener("scroll",n=>this.onScroll(n)),this.createAnchors()}createAnchors(){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substr(0,r.indexOf("#"))),this.el.querySelectorAll("a").forEach(n=>{let i=n.href;if(i.indexOf("#")==-1||i.substr(0,r.length)!=r)return;let s=i.substr(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=n.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let r;for(let i=0,s=this.anchors.length;ii.position-s.position);let n=new CustomEvent("scroll",{detail:{scrollTop:Q.instance.scrollTop}});this.onScroll(n)}onScroll(r){let n=r.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>n;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var he=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var ge=Fe(pe());function ye(){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+"/"};Ae(t,n,r,s)}function Ae(t,e,r,n){r.addEventListener("input",he(()=>{He(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?ze(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 Ve(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ge.Index.load(window.searchData.index))}function He(t,e,r,n){var o,a;if(Ve(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let l=0;lu.score-l.score);for(let l=0,u=Math.min(10,s.length);l${ve(h.parent,i)}.${f}`);let p=document.createElement("li");p.classList.value=(a=h.classes)!=null?a:"";let E=document.createElement("a");E.href=n.base+h.url,E.classList.add("tsd-kind-icon"),E.innerHTML=f,p.append(E),e.appendChild(p)}}function me(t,e){var n,i;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 s=r;if(e===1)do s=(n=s.nextElementSibling)!=null?n:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);else do s=(i=s.previousElementSibling)!=null?i:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);s&&(r.classList.remove("current"),s.classList.add("current"))}}function ze(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(se(t.substring(s,o)),`${se(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(se(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function se(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var oe=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}},Z=class extends k{constructor(r){super(r);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(n=>{n.addEventListener("touchstart",i=>this.onClick(i)),n.addEventListener("click",i=>this.onClick(i))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(r){if(r<0&&(r=0),r>this.groups.length-1&&(r=this.groups.length-1),this.index==r)return;let n=this.groups[r];if(this.index>-1){let i=this.groups[this.index];i.removeClass("current").addClass("fade-out"),n.addClass("current"),n.addClass("fade-in"),Q.instance.triggerResize(),setTimeout(()=>{i.removeClass("fade-out"),n.removeClass("fade-in")},300)}else n.addClass("current"),Q.instance.triggerResize();this.index=r}createGroups(){let r=this.el.children;if(r.length<2)return;this.container=this.el.nextElementSibling;let n=this.container.children;this.groups=[];for(let i=0;i{n.signature===r.currentTarget&&this.setIndex(i)})}};var C="mousedown",Le="mousemove",_="mouseup",K={x:0,y:0},xe=!1,ae=!1,je=!1,A=!1,Ee=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Ee?"is-mobile":"not-mobile");Ee&&"ontouchstart"in document.documentElement&&(je=!0,C="touchstart",Le="touchmove",_="touchend");document.addEventListener(C,t=>{ae=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;K.y=e.pageY||0,K.x=e.pageX||0});document.addEventListener(Le,t=>{if(!!ae&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=K.x-(e.pageX||0),n=K.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ae=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var ee=class extends k{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(C,n=>this.onDocumentPointerDown(n)),document.addEventListener(_,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){A||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!A&&this.active&&r.target.closest(".col-menu")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substr(0,i.indexOf("#"))),n.href.substr(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te=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)}},re=class extends te{initialize(){let r=document.querySelector("#tsd-filter-"+this.key);!r||(this.checkbox=r,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(r,n){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(r){return r=="true"}toLocalStorage(r){return r?"true":"false"}},le=class extends te{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let r=document.querySelector("#tsd-filter-"+this.key);if(!r)return;this.select=r;let n=()=>{this.select.classList.add("active")},i=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,n),this.select.addEventListener("mouseover",n),this.select.addEventListener("mouseleave",i),this.select.querySelectorAll("li").forEach(s=>{s.addEventListener(_,o=>{r.classList.remove("active"),this.setValue(o.target.dataset.value||"")})}),document.addEventListener(C,s=>{this.select.contains(s.target)||this.select.classList.remove("active")})}handleValueChange(r,n){this.select.querySelectorAll("li.selected").forEach(o=>{o.classList.remove("selected")});let i=this.select.querySelector('li[data-value="'+n+'"]'),s=this.select.querySelector(".tsd-select-label");i&&s&&(i.classList.add("selected"),s.textContent=i.textContent),document.documentElement.classList.remove("toggle-"+r),document.documentElement.classList.add("toggle-"+n)}fromLocalStorage(r){return r}toLocalStorage(r){return r}},j=class extends k{constructor(r){super(r);this.optionVisibility=new le("visibility","private"),this.optionInherited=new re("inherited",!0),this.optionExternals=new re("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ye();N(X,".menu-highlight");N(Z,".tsd-signatures");N(ee,"a[data-toggle]");j.isSupported()?N(j,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); +/*! + * 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/assets/search.js b/assets/search.js new file mode 100644 index 00000000..fb5311ce --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"8\":\"Enumeration\",\"16\":\"Enumeration Member\",\"32\":\"Variable\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\"},\"rows\":[{\"id\":0,\"kind\":128,\"name\":\"CloudEvent\",\"url\":\"classes/CloudEvent.html\",\"classes\":\"tsd-kind-class tsd-has-type-parameter\"},{\"id\":1,\"kind\":2048,\"name\":\"cloneWith\",\"url\":\"classes/CloudEvent.html#cloneWith-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-static\",\"parent\":\"CloudEvent\"},{\"id\":2,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/CloudEvent.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"CloudEvent\"},{\"id\":3,\"kind\":1024,\"name\":\"id\",\"url\":\"classes/CloudEvent.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":4,\"kind\":1024,\"name\":\"type\",\"url\":\"classes/CloudEvent.html#type\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":5,\"kind\":1024,\"name\":\"source\",\"url\":\"classes/CloudEvent.html#source\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":6,\"kind\":1024,\"name\":\"specversion\",\"url\":\"classes/CloudEvent.html#specversion\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":7,\"kind\":1024,\"name\":\"datacontenttype\",\"url\":\"classes/CloudEvent.html#datacontenttype\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":8,\"kind\":1024,\"name\":\"dataschema\",\"url\":\"classes/CloudEvent.html#dataschema\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":9,\"kind\":1024,\"name\":\"subject\",\"url\":\"classes/CloudEvent.html#subject\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":10,\"kind\":1024,\"name\":\"time\",\"url\":\"classes/CloudEvent.html#time\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":11,\"kind\":1024,\"name\":\"data\",\"url\":\"classes/CloudEvent.html#data\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":12,\"kind\":1024,\"name\":\"data_base64\",\"url\":\"classes/CloudEvent.html#data_base64\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":13,\"kind\":2048,\"name\":\"toJSON\",\"url\":\"classes/CloudEvent.html#toJSON\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":14,\"kind\":2048,\"name\":\"toString\",\"url\":\"classes/CloudEvent.html#toString\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":15,\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/CloudEvent.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":16,\"kind\":2048,\"name\":\"emit\",\"url\":\"classes/CloudEvent.html#emit\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CloudEvent\"},{\"id\":17,\"kind\":2048,\"name\":\"cloneWith\",\"url\":\"classes/CloudEvent.html#cloneWith\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"CloudEvent\"},{\"id\":18,\"kind\":32,\"name\":\"V1\",\"url\":\"modules.html#V1\",\"classes\":\"tsd-kind-variable\"},{\"id\":19,\"kind\":128,\"name\":\"ValidationError\",\"url\":\"classes/ValidationError.html\",\"classes\":\"tsd-kind-class\"},{\"id\":20,\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/ValidationError.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-class\",\"parent\":\"ValidationError\"},{\"id\":21,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/ValidationError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"ValidationError\"},{\"id\":22,\"kind\":8,\"name\":\"Mode\",\"url\":\"enums/Mode.html\",\"classes\":\"tsd-kind-enum\"},{\"id\":23,\"kind\":16,\"name\":\"BINARY\",\"url\":\"enums/Mode.html#BINARY\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"Mode\"},{\"id\":24,\"kind\":16,\"name\":\"STRUCTURED\",\"url\":\"enums/Mode.html#STRUCTURED\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"Mode\"},{\"id\":25,\"kind\":16,\"name\":\"BATCH\",\"url\":\"enums/Mode.html#BATCH\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"Mode\"},{\"id\":26,\"kind\":32,\"name\":\"HTTP\",\"url\":\"modules.html#HTTP\",\"classes\":\"tsd-kind-variable\"},{\"id\":27,\"kind\":32,\"name\":\"Kafka\",\"url\":\"modules.html#Kafka\",\"classes\":\"tsd-kind-variable\"},{\"id\":28,\"kind\":32,\"name\":\"MQTT\",\"url\":\"modules.html#MQTT\",\"classes\":\"tsd-kind-variable\"},{\"id\":29,\"kind\":64,\"name\":\"MQTTMessageFactory\",\"url\":\"modules.html#MQTTMessageFactory\",\"classes\":\"tsd-kind-function tsd-has-type-parameter\"},{\"id\":30,\"kind\":64,\"name\":\"emitterFor\",\"url\":\"modules.html#emitterFor\",\"classes\":\"tsd-kind-function\"},{\"id\":31,\"kind\":64,\"name\":\"httpTransport\",\"url\":\"modules.html#httpTransport\",\"classes\":\"tsd-kind-function\"},{\"id\":32,\"kind\":128,\"name\":\"Emitter\",\"url\":\"classes/Emitter.html\",\"classes\":\"tsd-kind-class\"},{\"id\":33,\"kind\":1024,\"name\":\"instance\",\"url\":\"classes/Emitter.html#instance\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-static\",\"parent\":\"Emitter\"},{\"id\":34,\"kind\":2048,\"name\":\"getInstance\",\"url\":\"classes/Emitter.html#getInstance\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-static\",\"parent\":\"Emitter\"},{\"id\":35,\"kind\":2048,\"name\":\"on\",\"url\":\"classes/Emitter.html#on\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-static\",\"parent\":\"Emitter\"},{\"id\":36,\"kind\":2048,\"name\":\"emitEvent\",\"url\":\"classes/Emitter.html#emitEvent\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static\",\"parent\":\"Emitter\"},{\"id\":37,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Emitter.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Emitter\"},{\"id\":38,\"kind\":256,\"name\":\"CloudEventV1\",\"url\":\"interfaces/CloudEventV1.html\",\"classes\":\"tsd-kind-interface tsd-has-type-parameter\"},{\"id\":39,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/CloudEventV1.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CloudEventV1\"},{\"id\":40,\"kind\":1024,\"name\":\"specversion\",\"url\":\"interfaces/CloudEventV1.html#specversion\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CloudEventV1\"},{\"id\":41,\"kind\":1024,\"name\":\"source\",\"url\":\"interfaces/CloudEventV1.html#source\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"CloudEventV1\"},{\"id\":42,\"kind\":1024,\"name\":\"type\",\"url\":\"interfaces/CloudEventV1.html#type\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"CloudEventV1\"},{\"id\":43,\"kind\":1024,\"name\":\"datacontenttype\",\"url\":\"interfaces/CloudEventV1.html#datacontenttype\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"CloudEventV1\"},{\"id\":44,\"kind\":1024,\"name\":\"dataschema\",\"url\":\"interfaces/CloudEventV1.html#dataschema\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"CloudEventV1\"},{\"id\":45,\"kind\":1024,\"name\":\"subject\",\"url\":\"interfaces/CloudEventV1.html#subject\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"CloudEventV1\"},{\"id\":46,\"kind\":1024,\"name\":\"time\",\"url\":\"interfaces/CloudEventV1.html#time\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"CloudEventV1\"},{\"id\":47,\"kind\":1024,\"name\":\"data\",\"url\":\"interfaces/CloudEventV1.html#data\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"CloudEventV1\"},{\"id\":48,\"kind\":1024,\"name\":\"data_base64\",\"url\":\"interfaces/CloudEventV1.html#data_base64\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"CloudEventV1\"},{\"id\":49,\"kind\":256,\"name\":\"Headers\",\"url\":\"interfaces/Headers.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":50,\"kind\":256,\"name\":\"Binding\",\"url\":\"interfaces/Binding.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":51,\"kind\":256,\"name\":\"Message\",\"url\":\"interfaces/Message.html\",\"classes\":\"tsd-kind-interface tsd-has-type-parameter\"},{\"id\":52,\"kind\":256,\"name\":\"Deserializer\",\"url\":\"interfaces/Deserializer.html\",\"classes\":\"tsd-kind-interface tsd-has-type-parameter\"},{\"id\":53,\"kind\":256,\"name\":\"Serializer\",\"url\":\"interfaces/Serializer.html\",\"classes\":\"tsd-kind-interface tsd-has-type-parameter\"},{\"id\":54,\"kind\":256,\"name\":\"KafkaEvent\",\"url\":\"interfaces/KafkaEvent.html\",\"classes\":\"tsd-kind-interface tsd-has-type-parameter\"},{\"id\":55,\"kind\":1024,\"name\":\"partitionkey\",\"url\":\"interfaces/KafkaEvent.html#partitionkey\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"KafkaEvent\"},{\"id\":56,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/KafkaEvent.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"KafkaEvent\"},{\"id\":57,\"kind\":1024,\"name\":\"specversion\",\"url\":\"interfaces/KafkaEvent.html#specversion\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"KafkaEvent\"},{\"id\":58,\"kind\":1024,\"name\":\"source\",\"url\":\"interfaces/KafkaEvent.html#source\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"KafkaEvent\"},{\"id\":59,\"kind\":1024,\"name\":\"type\",\"url\":\"interfaces/KafkaEvent.html#type\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"KafkaEvent\"},{\"id\":60,\"kind\":1024,\"name\":\"datacontenttype\",\"url\":\"interfaces/KafkaEvent.html#datacontenttype\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"KafkaEvent\"},{\"id\":61,\"kind\":1024,\"name\":\"dataschema\",\"url\":\"interfaces/KafkaEvent.html#dataschema\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"KafkaEvent\"},{\"id\":62,\"kind\":1024,\"name\":\"subject\",\"url\":\"interfaces/KafkaEvent.html#subject\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"KafkaEvent\"},{\"id\":63,\"kind\":1024,\"name\":\"time\",\"url\":\"interfaces/KafkaEvent.html#time\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"KafkaEvent\"},{\"id\":64,\"kind\":1024,\"name\":\"data\",\"url\":\"interfaces/KafkaEvent.html#data\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"KafkaEvent\"},{\"id\":65,\"kind\":1024,\"name\":\"data_base64\",\"url\":\"interfaces/KafkaEvent.html#data_base64\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"KafkaEvent\"},{\"id\":66,\"kind\":256,\"name\":\"KafkaMessage\",\"url\":\"interfaces/KafkaMessage.html\",\"classes\":\"tsd-kind-interface tsd-has-type-parameter\"},{\"id\":67,\"kind\":256,\"name\":\"MQTTMessage\",\"url\":\"interfaces/MQTTMessage.html\",\"classes\":\"tsd-kind-interface tsd-has-type-parameter\"},{\"id\":68,\"kind\":1024,\"name\":\"PUBLISH\",\"url\":\"interfaces/MQTTMessage.html#PUBLISH\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"MQTTMessage\"},{\"id\":69,\"kind\":1024,\"name\":\"payload\",\"url\":\"interfaces/MQTTMessage.html#payload\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"MQTTMessage\"},{\"id\":70,\"kind\":1024,\"name\":\"User Properties\",\"url\":\"interfaces/MQTTMessage.html#User_Properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"MQTTMessage\"},{\"id\":71,\"kind\":256,\"name\":\"TransportFunction\",\"url\":\"interfaces/TransportFunction.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":72,\"kind\":256,\"name\":\"EmitterFunction\",\"url\":\"interfaces/EmitterFunction.html\",\"classes\":\"tsd-kind-interface tsd-has-type-parameter\"},{\"id\":73,\"kind\":256,\"name\":\"Options\",\"url\":\"interfaces/Options.html\",\"classes\":\"tsd-kind-interface\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,14.074]],[\"parent/0\",[]],[\"name/1\",[1,34.199]],[\"parent/1\",[0,1.182]],[\"name/2\",[2,30.815]],[\"parent/2\",[0,1.182]],[\"name/3\",[3,30.815]],[\"parent/3\",[0,1.182]],[\"name/4\",[4,30.815]],[\"parent/4\",[0,1.182]],[\"name/5\",[5,30.815]],[\"parent/5\",[0,1.182]],[\"name/6\",[6,30.815]],[\"parent/6\",[0,1.182]],[\"name/7\",[7,30.815]],[\"parent/7\",[0,1.182]],[\"name/8\",[8,30.815]],[\"parent/8\",[0,1.182]],[\"name/9\",[9,30.815]],[\"parent/9\",[0,1.182]],[\"name/10\",[10,30.815]],[\"parent/10\",[0,1.182]],[\"name/11\",[11,30.815]],[\"parent/11\",[0,1.182]],[\"name/12\",[12,30.815]],[\"parent/12\",[0,1.182]],[\"name/13\",[13,39.335]],[\"parent/13\",[0,1.182]],[\"name/14\",[14,39.335]],[\"parent/14\",[0,1.182]],[\"name/15\",[15,39.335]],[\"parent/15\",[0,1.182]],[\"name/16\",[16,39.335]],[\"parent/16\",[0,1.182]],[\"name/17\",[1,34.199]],[\"parent/17\",[0,1.182]],[\"name/18\",[17,39.335]],[\"parent/18\",[]],[\"name/19\",[18,30.815]],[\"parent/19\",[]],[\"name/20\",[19,39.335]],[\"parent/20\",[18,2.587]],[\"name/21\",[2,30.815]],[\"parent/21\",[18,2.587]],[\"name/22\",[20,28.288]],[\"parent/22\",[]],[\"name/23\",[21,39.335]],[\"parent/23\",[20,2.375]],[\"name/24\",[22,39.335]],[\"parent/24\",[20,2.375]],[\"name/25\",[23,39.335]],[\"parent/25\",[20,2.375]],[\"name/26\",[24,39.335]],[\"parent/26\",[]],[\"name/27\",[25,39.335]],[\"parent/27\",[]],[\"name/28\",[26,39.335]],[\"parent/28\",[]],[\"name/29\",[27,39.335]],[\"parent/29\",[]],[\"name/30\",[28,39.335]],[\"parent/30\",[]],[\"name/31\",[29,39.335]],[\"parent/31\",[]],[\"name/32\",[30,24.591]],[\"parent/32\",[]],[\"name/33\",[31,39.335]],[\"parent/33\",[30,2.065]],[\"name/34\",[32,39.335]],[\"parent/34\",[30,2.065]],[\"name/35\",[33,39.335]],[\"parent/35\",[30,2.065]],[\"name/36\",[34,39.335]],[\"parent/36\",[30,2.065]],[\"name/37\",[2,30.815]],[\"parent/37\",[30,2.065]],[\"name/38\",[35,18.854]],[\"parent/38\",[]],[\"name/39\",[3,30.815]],[\"parent/39\",[35,1.583]],[\"name/40\",[6,30.815]],[\"parent/40\",[35,1.583]],[\"name/41\",[5,30.815]],[\"parent/41\",[35,1.583]],[\"name/42\",[4,30.815]],[\"parent/42\",[35,1.583]],[\"name/43\",[7,30.815]],[\"parent/43\",[35,1.583]],[\"name/44\",[8,30.815]],[\"parent/44\",[35,1.583]],[\"name/45\",[9,30.815]],[\"parent/45\",[35,1.583]],[\"name/46\",[10,30.815]],[\"parent/46\",[35,1.583]],[\"name/47\",[11,30.815]],[\"parent/47\",[35,1.583]],[\"name/48\",[12,30.815]],[\"parent/48\",[35,1.583]],[\"name/49\",[36,39.335]],[\"parent/49\",[]],[\"name/50\",[37,39.335]],[\"parent/50\",[]],[\"name/51\",[38,39.335]],[\"parent/51\",[]],[\"name/52\",[39,39.335]],[\"parent/52\",[]],[\"name/53\",[40,39.335]],[\"parent/53\",[]],[\"name/54\",[41,18.016]],[\"parent/54\",[]],[\"name/55\",[42,39.335]],[\"parent/55\",[41,1.513]],[\"name/56\",[3,30.815]],[\"parent/56\",[41,1.513]],[\"name/57\",[6,30.815]],[\"parent/57\",[41,1.513]],[\"name/58\",[5,30.815]],[\"parent/58\",[41,1.513]],[\"name/59\",[4,30.815]],[\"parent/59\",[41,1.513]],[\"name/60\",[7,30.815]],[\"parent/60\",[41,1.513]],[\"name/61\",[8,30.815]],[\"parent/61\",[41,1.513]],[\"name/62\",[9,30.815]],[\"parent/62\",[41,1.513]],[\"name/63\",[10,30.815]],[\"parent/63\",[41,1.513]],[\"name/64\",[11,30.815]],[\"parent/64\",[41,1.513]],[\"name/65\",[12,30.815]],[\"parent/65\",[41,1.513]],[\"name/66\",[43,39.335]],[\"parent/66\",[]],[\"name/67\",[44,28.288]],[\"parent/67\",[]],[\"name/68\",[45,39.335]],[\"parent/68\",[44,2.375]],[\"name/69\",[46,39.335]],[\"parent/69\",[44,2.375]],[\"name/70\",[47,27.979,48,27.979]],[\"parent/70\",[44,2.375]],[\"name/71\",[49,39.335]],[\"parent/71\",[]],[\"name/72\",[50,39.335]],[\"parent/72\",[]],[\"name/73\",[51,39.335]],[\"parent/73\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":19,\"name\":{\"20\":{}},\"parent\":{}}],[\"batch\",{\"_index\":23,\"name\":{\"25\":{}},\"parent\":{}}],[\"binary\",{\"_index\":21,\"name\":{\"23\":{}},\"parent\":{}}],[\"binding\",{\"_index\":37,\"name\":{\"50\":{}},\"parent\":{}}],[\"clonewith\",{\"_index\":1,\"name\":{\"1\":{},\"17\":{}},\"parent\":{}}],[\"cloudevent\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{\"1\":{},\"2\":{},\"3\":{},\"4\":{},\"5\":{},\"6\":{},\"7\":{},\"8\":{},\"9\":{},\"10\":{},\"11\":{},\"12\":{},\"13\":{},\"14\":{},\"15\":{},\"16\":{},\"17\":{}}}],[\"cloudeventv1\",{\"_index\":35,\"name\":{\"38\":{}},\"parent\":{\"39\":{},\"40\":{},\"41\":{},\"42\":{},\"43\":{},\"44\":{},\"45\":{},\"46\":{},\"47\":{},\"48\":{}}}],[\"constructor\",{\"_index\":2,\"name\":{\"2\":{},\"21\":{},\"37\":{}},\"parent\":{}}],[\"data\",{\"_index\":11,\"name\":{\"11\":{},\"47\":{},\"64\":{}},\"parent\":{}}],[\"data_base64\",{\"_index\":12,\"name\":{\"12\":{},\"48\":{},\"65\":{}},\"parent\":{}}],[\"datacontenttype\",{\"_index\":7,\"name\":{\"7\":{},\"43\":{},\"60\":{}},\"parent\":{}}],[\"dataschema\",{\"_index\":8,\"name\":{\"8\":{},\"44\":{},\"61\":{}},\"parent\":{}}],[\"deserializer\",{\"_index\":39,\"name\":{\"52\":{}},\"parent\":{}}],[\"emit\",{\"_index\":16,\"name\":{\"16\":{}},\"parent\":{}}],[\"emitevent\",{\"_index\":34,\"name\":{\"36\":{}},\"parent\":{}}],[\"emitter\",{\"_index\":30,\"name\":{\"32\":{}},\"parent\":{\"33\":{},\"34\":{},\"35\":{},\"36\":{},\"37\":{}}}],[\"emitterfor\",{\"_index\":28,\"name\":{\"30\":{}},\"parent\":{}}],[\"emitterfunction\",{\"_index\":50,\"name\":{\"72\":{}},\"parent\":{}}],[\"getinstance\",{\"_index\":32,\"name\":{\"34\":{}},\"parent\":{}}],[\"headers\",{\"_index\":36,\"name\":{\"49\":{}},\"parent\":{}}],[\"http\",{\"_index\":24,\"name\":{\"26\":{}},\"parent\":{}}],[\"httptransport\",{\"_index\":29,\"name\":{\"31\":{}},\"parent\":{}}],[\"id\",{\"_index\":3,\"name\":{\"3\":{},\"39\":{},\"56\":{}},\"parent\":{}}],[\"instance\",{\"_index\":31,\"name\":{\"33\":{}},\"parent\":{}}],[\"kafka\",{\"_index\":25,\"name\":{\"27\":{}},\"parent\":{}}],[\"kafkaevent\",{\"_index\":41,\"name\":{\"54\":{}},\"parent\":{\"55\":{},\"56\":{},\"57\":{},\"58\":{},\"59\":{},\"60\":{},\"61\":{},\"62\":{},\"63\":{},\"64\":{},\"65\":{}}}],[\"kafkamessage\",{\"_index\":43,\"name\":{\"66\":{}},\"parent\":{}}],[\"message\",{\"_index\":38,\"name\":{\"51\":{}},\"parent\":{}}],[\"mode\",{\"_index\":20,\"name\":{\"22\":{}},\"parent\":{\"23\":{},\"24\":{},\"25\":{}}}],[\"mqtt\",{\"_index\":26,\"name\":{\"28\":{}},\"parent\":{}}],[\"mqttmessage\",{\"_index\":44,\"name\":{\"67\":{}},\"parent\":{\"68\":{},\"69\":{},\"70\":{}}}],[\"mqttmessagefactory\",{\"_index\":27,\"name\":{\"29\":{}},\"parent\":{}}],[\"on\",{\"_index\":33,\"name\":{\"35\":{}},\"parent\":{}}],[\"options\",{\"_index\":51,\"name\":{\"73\":{}},\"parent\":{}}],[\"partitionkey\",{\"_index\":42,\"name\":{\"55\":{}},\"parent\":{}}],[\"payload\",{\"_index\":46,\"name\":{\"69\":{}},\"parent\":{}}],[\"properties\",{\"_index\":48,\"name\":{\"70\":{}},\"parent\":{}}],[\"publish\",{\"_index\":45,\"name\":{\"68\":{}},\"parent\":{}}],[\"serializer\",{\"_index\":40,\"name\":{\"53\":{}},\"parent\":{}}],[\"source\",{\"_index\":5,\"name\":{\"5\":{},\"41\":{},\"58\":{}},\"parent\":{}}],[\"specversion\",{\"_index\":6,\"name\":{\"6\":{},\"40\":{},\"57\":{}},\"parent\":{}}],[\"structured\",{\"_index\":22,\"name\":{\"24\":{}},\"parent\":{}}],[\"subject\",{\"_index\":9,\"name\":{\"9\":{},\"45\":{},\"62\":{}},\"parent\":{}}],[\"time\",{\"_index\":10,\"name\":{\"10\":{},\"46\":{},\"63\":{}},\"parent\":{}}],[\"tojson\",{\"_index\":13,\"name\":{\"13\":{}},\"parent\":{}}],[\"tostring\",{\"_index\":14,\"name\":{\"14\":{}},\"parent\":{}}],[\"transportfunction\",{\"_index\":49,\"name\":{\"71\":{}},\"parent\":{}}],[\"type\",{\"_index\":4,\"name\":{\"4\":{},\"42\":{},\"59\":{}},\"parent\":{}}],[\"user\",{\"_index\":47,\"name\":{\"70\":{}},\"parent\":{}}],[\"v1\",{\"_index\":17,\"name\":{\"18\":{}},\"parent\":{}}],[\"validate\",{\"_index\":15,\"name\":{\"15\":{}},\"parent\":{}}],[\"validationerror\",{\"_index\":18,\"name\":{\"19\":{}},\"parent\":{\"20\":{},\"21\":{}}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 00000000..6127b27c --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1414 @@ +@import url("./icons.css"); + +:root { + /* Light */ + --light-color-background: #fcfcfc; + --light-color-secondary-background: #fff; + --light-color-text: #222; + --light-color-text-aside: #707070; + --light-color-link: #4da6ff; + --light-color-menu-divider: #eee; + --light-color-menu-divider-focus: #000; + --light-color-menu-label: #707070; + --light-color-panel: var(--light-color-secondary-background); + --light-color-panel-divider: #eee; + --light-color-comment-tag: #707070; + --light-color-comment-tag-text: #fff; + --light-color-ts: #9600ff; + --light-color-ts-interface: #647f1b; + --light-color-ts-enum: #937210; + --light-color-ts-class: #0672de; + --light-color-ts-private: #707070; + --light-color-toolbar: #fff; + --light-color-toolbar-text: #333; + --light-icon-filter: invert(0); + --light-external-icon: url("data:image/svg+xml;utf8,"); + + /* Dark */ + --dark-color-background: #36393f; + --dark-color-secondary-background: #2f3136; + --dark-color-text: #ffffff; + --dark-color-text-aside: #e6e4e4; + --dark-color-link: #00aff4; + --dark-color-menu-divider: #eee; + --dark-color-menu-divider-focus: #000; + --dark-color-menu-label: #707070; + --dark-color-panel: var(--dark-color-secondary-background); + --dark-color-panel-divider: #818181; + --dark-color-comment-tag: #dcddde; + --dark-color-comment-tag-text: #2f3136; + --dark-color-ts: #c97dff; + --dark-color-ts-interface: #9cbe3c; + --dark-color-ts-enum: #d6ab29; + --dark-color-ts-class: #3695f3; + --dark-color-ts-private: #e2e2e2; + --dark-color-toolbar: #34373c; + --dark-color-toolbar-text: #ffffff; + --dark-icon-filter: invert(1); + --dark-external-icon: url("data:image/svg+xml;utf8,"); +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); + } +} + +body { + margin: 0; +} + +body.light { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); +} + +body.dark { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +h2 { + font-size: 1.5em; + margin: 0.83em 0; +} + +h3 { + font-size: 1.17em; + margin: 1em 0; +} + +h4, +.tsd-index-panel h3 { + font-size: 1em; + margin: 1.33em 0; +} + +h5 { + font-size: 0.83em; + margin: 1.67em 0; +} + +h6 { + font-size: 0.67em; + margin: 2.33em 0; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 0 40px; +} +@media (max-width: 640px) { + .container { + padding: 0 20px; + } +} + +.container-main { + padding-bottom: 200px; +} + +.row { + display: flex; + position: relative; + margin: 0 -10px; +} +.row:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +.col-4, +.col-8 { + box-sizing: border-box; + float: left; + padding: 0 10px; +} + +.col-4 { + width: 33.3333333333%; +} +.col-8 { + width: 66.6666666667%; +} + +ul.tsd-descriptions > li > :first-child, +.tsd-panel > :first-child, +.col-8 > :first-child, +.col-4 > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child, +.tsd-panel > :first-child > :first-child, +.col-8 > :first-child > :first-child, +.col-4 > :first-child > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child > :first-child, +.tsd-panel > :first-child > :first-child > :first-child, +.col-8 > :first-child > :first-child > :first-child, +.col-4 > :first-child > :first-child > :first-child { + margin-top: 0; +} +ul.tsd-descriptions > li > :last-child, +.tsd-panel > :last-child, +.col-8 > :last-child, +.col-4 > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child, +.tsd-panel > :last-child > :last-child, +.col-8 > :last-child > :last-child, +.col-4 > :last-child > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child > :last-child, +.tsd-panel > :last-child > :last-child > :last-child, +.col-8 > :last-child > :last-child > :last-child, +.col-4 > :last-child > :last-child > :last-child { + margin-bottom: 0; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 14px; +} + +pre { + padding: 10px; +} +pre code { + padding: 0; + font-size: 100%; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +@media (min-width: 901px) and (max-width: 1024px) { + html .col-content { + width: 72%; + } + html .col-menu { + width: 28%; + } + html .tsd-navigation { + padding-left: 10px; + } +} +@media (max-width: 900px) { + html .col-content { + float: none; + width: 100%; + } + html .col-menu { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + width: 100%; + padding: 20px 20px 0 0; + max-width: 450px; + visibility: hidden; + background-color: var(--color-panel); + transform: translate(100%, 0); + } + html .col-menu > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu :is(header, footer, .col-content) { + animation: shift-to-left 0.4s; + } + + .to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu :is(header, footer, .col-content) { + animation: unshift-to-left 0.4s; + } + + .from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu :is(header, footer, .col-content) { + transform: translate(-25%, 0); + } + .has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + display: grid; + grid-template-rows: auto 1fr; + max-height: 100vh; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +.tsd-page-title { + padding: 70px 0 20px 0; + margin: 0 0 40px 0; + background: var(--color-panel); + box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); +} +.tsd-page-title h1 { + margin: 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +dl.tsd-comment-tags { + overflow: hidden; +} +dl.tsd-comment-tags dt { + float: left; + padding: 1px 5px; + margin: 0 10px 0 0; + border-radius: 4px; + border: 1px solid var(--color-comment-tag); + color: var(--color-comment-tag); + font-size: 0.8em; + font-weight: normal; +} +dl.tsd-comment-tags dd { + margin: 0 0 10px 0; +} +dl.tsd-comment-tags dd:before, +dl.tsd-comment-tags dd:after { + display: table; + content: " "; +} +dl.tsd-comment-tags dd pre, +dl.tsd-comment-tags dd:after { + clear: both; +} +dl.tsd-comment-tags p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.toggle-protected .tsd-is-private { + display: none; +} + +.toggle-public .tsd-is-private, +.toggle-public .tsd-is-protected, +.toggle-public .tsd-is-private-protected { + display: none; +} + +.toggle-inherited .tsd-is-inherited { + display: none; +} + +.toggle-externals .tsd-is-external { + display: none; +} + +#tsd-filter { + position: relative; + display: inline-block; + height: 40px; + vertical-align: bottom; +} +.no-filter #tsd-filter { + display: none; +} +#tsd-filter .tsd-filter-group { + display: inline-block; + height: 40px; + vertical-align: bottom; + white-space: nowrap; +} +#tsd-filter input { + display: none; +} +@media (max-width: 900px) { + #tsd-filter .tsd-filter-group { + display: block; + position: absolute; + top: 40px; + right: 20px; + height: auto; + background-color: var(--color-panel); + visibility: hidden; + transform: translate(50%, 0); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + .has-options #tsd-filter .tsd-filter-group { + visibility: visible; + } + .to-has-options #tsd-filter .tsd-filter-group { + animation: fade-in 0.2s; + } + .from-has-options #tsd-filter .tsd-filter-group { + animation: fade-out 0.2s; + } + #tsd-filter label, + #tsd-filter .tsd-select { + display: block; + padding-right: 20px; + } +} + +footer { + border-top: 1px solid var(--color-panel-divider); + background-color: var(--color-panel); +} +footer:after { + content: ""; + display: table; +} +footer.with-border-bottom { + border-bottom: 1px solid var(--color-panel-divider); +} +footer .tsd-legend-group { + font-size: 0; +} +footer .tsd-legend { + display: inline-block; + width: 25%; + padding: 0; + font-size: 16px; + list-style: none; + line-height: 1.333em; + vertical-align: top; +} +@media (max-width: 900px) { + footer .tsd-legend { + width: 50%; + } +} + +.tsd-hierarchy { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-index-panel .tsd-index-content { + margin-bottom: -30px !important; +} +.tsd-index-panel .tsd-index-section { + margin-bottom: 30px !important; +} +.tsd-index-panel h3 { + margin: 0 -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + -webkit-column-gap: 20px; + -moz-column-gap: 20px; + -ms-column-gap: 20px; + -o-column-gap: 20px; + column-gap: 20px; + padding: 0; + list-style: none; + line-height: 1.333em; +} +@media (max-width: 900px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 1; + -moz-column-count: 1; + -ms-column-count: 1; + -o-column-count: 1; + column-count: 1; + } +} +@media (min-width: 901px) and (max-width: 1024px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 2; + -moz-column-count: 2; + -ms-column-count: 2; + -o-column-count: 2; + column-count: 2; + } +} +.tsd-index-panel ul.tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel .tsd-parent-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-parent-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-parent-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-parent-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-is-private a { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member [data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member [data-tsd-kind="Interface"] { + color: var(--color-ts-interface); +} +.tsd-member [data-tsd-kind="Enum"] { + color: var(--color-ts-enum); +} +.tsd-member [data-tsd-kind="Class"] { + color: var(--color-ts-class); +} +.tsd-member [data-tsd-kind="Private"] { + color: var(--color-ts-private); +} + +.tsd-navigation { + margin: 0 0 0 40px; +} +.tsd-navigation a { + display: block; + padding-top: 2px; + padding-bottom: 2px; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary { + padding-bottom: 40px; +} +.tsd-navigation.primary a { + display: block; + padding-top: 6px; + padding-bottom: 6px; +} +.tsd-navigation.primary ul li a { + padding-left: 5px; +} +.tsd-navigation.primary ul li li a { + padding-left: 25px; +} +.tsd-navigation.primary ul li li li a { + padding-left: 45px; +} +.tsd-navigation.primary ul li li li li a { + padding-left: 65px; +} +.tsd-navigation.primary ul li li li li li a { + padding-left: 85px; +} +.tsd-navigation.primary ul li li li li li li a { + padding-left: 105px; +} +.tsd-navigation.primary > ul { + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li { + border-top: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li.current > a { + font-weight: bold; +} +.tsd-navigation.primary li.label span { + display: block; + padding: 20px 0 6px 5px; + color: var(--color-menu-label); +} +.tsd-navigation.primary li.globals + li > span, +.tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary { + max-height: calc(100vh - 1rem - 40px); + overflow: auto; + position: sticky; + top: calc(0.5rem + 40px); + transition: 0.3s; +} +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary ul { + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 25px; +} +.tsd-navigation.secondary ul li li a { + padding-left: 45px; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 65px; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 85px; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 105px; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 125px; +} +.tsd-navigation.secondary ul.current a { + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.focus > a, +.tsd-navigation.secondary ul.current li.focus > a { + border-left-color: var(--color-menu-divider-focus); +} +.tsd-navigation.secondary li.current { + margin-top: 20px; + margin-bottom: 20px; + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.current > a { + font-weight: bold; +} + +@media (min-width: 901px) { + .menu-sticky-wrap { + position: static; + } +} + +.tsd-panel { + margin: 20px 0; + padding: 20px; + background-color: var(--color-panel); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5em -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: 0; +} +.tsd-panel table { + display: block; + width: 100%; + overflow: auto; + margin-top: 10px; + word-break: normal; + word-break: keep-all; + border-collapse: collapse; +} +.tsd-panel table th { + font-weight: bold; +} +.tsd-panel table th, +.tsd-panel table td { + padding: 6px 13px; + border: 1px solid var(--color-panel-divider); +} +.tsd-panel table tr { + background: var(--color-background); +} +.tsd-panel table tr:nth-child(even) { + background: var(--color-secondary-background); +} + +.tsd-panel-group { + margin: 60px 0; +} +.tsd-panel-group > h1, +.tsd-panel-group > h2, +.tsd-panel-group > h3 { + padding-left: 20px; + padding-right: 20px; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 40px; + height: 40px; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-panel); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-panel-divider); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-panel-divider); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +.tsd-signature { + margin: 0 0 1em 0; + padding: 10px; + border: 1px solid var(--color-panel-divider); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} +.tsd-signature.tsd-kind-icon { + padding-left: 30px; +} +.tsd-signature.tsd-kind-icon:before { + top: 10px; + left: 10px; +} +.tsd-panel > .tsd-signature { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signature.tsd-kind-icon:before { + left: 20px; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + border: 1px solid var(--color-panel-divider); +} +.tsd-signatures .tsd-signature { + margin: 0; + border-width: 1px 0 0 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-signature:first-child { + border-top-width: 0; +} +.tsd-signatures .tsd-signature.current { + background-color: var(--color-panel-divider); +} +.tsd-signatures.active > .tsd-signature { + cursor: pointer; +} +.tsd-panel > .tsd-signatures { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { + left: 20px; +} +.tsd-panel > a.anchor + .tsd-signatures { + border-top-width: 0; + margin-top: -20px; +} + +ul.tsd-descriptions { + position: relative; + overflow: hidden; + padding: 0; + list-style: none; +} +ul.tsd-descriptions.active > .tsd-description { + display: none; +} +ul.tsd-descriptions.active > .tsd-description.current { + display: block; +} +ul.tsd-descriptions.active > .tsd-description.fade-in { + animation: fade-in-delayed 0.3s; +} +ul.tsd-descriptions.active > .tsd-description.fade-out { + animation: fade-out-delayed 0.3s; + position: absolute; + display: block; + top: 0; + left: 0; + right: 0; + opacity: 0; + visibility: hidden; +} +ul.tsd-descriptions h4, +ul.tsd-descriptions .tsd-index-panel h3, +.tsd-index-panel ul.tsd-descriptions h3 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} + +ul.tsd-parameters, +ul.tsd-type-parameters { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameters > li.tsd-parameter-signature, +ul.tsd-type-parameters > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameters h5, +ul.tsd-type-parameters h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +ul.tsd-parameters .tsd-comment, +ul.tsd-type-parameters .tsd-comment { + margin-top: -0.5em; +} + +.tsd-sources { + font-size: 14px; + color: var(--color-text-aside); + margin: 0 0 1em 0; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul, +.tsd-sources p { + margin: 0 !important; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + height: 40px; + color: var(--color-toolbar-text); + background: var(--color-toolbar); + border-bottom: 1px solid var(--color-panel-divider); + transition: transform 0.3s linear; +} +.tsd-page-toolbar a { + color: var(--color-toolbar-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .table-wrap { + display: table; + width: 100%; + height: 40px; +} +.tsd-page-toolbar .table-cell { + display: table-cell; + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-select .tsd-select-list li:before, +.tsd-select .tsd-select-label:before, +.tsd-widget:before { + content: ""; + display: inline-block; + width: 40px; + height: 40px; + margin: 0 -8px 0 0; + background-image: url(./widgets.png); + background-repeat: no-repeat; + text-indent: -1024px; + vertical-align: bottom; + filter: var(--icon-filter); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-select .tsd-select-list li:before, + .tsd-select .tsd-select-label:before, + .tsd-widget:before { + background-image: url(./widgets@2x.png); + background-size: 320px 40px; + } +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-panel-divider); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} +.tsd-widget.search:before { + background-position: 0 0; +} +.tsd-widget.menu:before { + background-position: -40px 0; +} +.tsd-widget.options:before { + background-position: -80px 0; +} +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +@media (max-width: 900px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +.tsd-select { + position: relative; + display: inline-block; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-select .tsd-select-label { + opacity: 0.6; + transition: opacity 0.2s; +} +.tsd-select .tsd-select-label:before { + background-position: -240px 0; +} +.tsd-select.active .tsd-select-label { + opacity: 0.8; +} +.tsd-select.active .tsd-select-list { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} +.tsd-select .tsd-select-list { + position: absolute; + visibility: hidden; + top: 40px; + left: 0; + margin: 0; + padding: 0; + opacity: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + transition: visibility 0s 0.2s, opacity 0.2s; +} +.tsd-select .tsd-select-list li { + padding: 0 20px 0 0; + background-color: var(--color-background); +} +.tsd-select .tsd-select-list li:before { + background-position: 40px 0; +} +.tsd-select .tsd-select-list li:nth-child(even) { + background-color: var(--color-panel); +} +.tsd-select .tsd-select-list li:hover { + background-color: var(--color-panel-divider); +} +.tsd-select .tsd-select-list li.selected:before { + background-position: -200px 0; +} +@media (max-width: 900px) { + .tsd-select .tsd-select-list { + top: 0; + left: auto; + right: 100%; + margin-right: -5px; + } + .tsd-select .tsd-select-label:before { + background-position: -280px 0; + } +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + margin-left: 10px; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} diff --git a/assets/widgets.png b/assets/widgets.png new file mode 100644 index 00000000..c7380532 Binary files /dev/null and b/assets/widgets.png differ diff --git a/assets/widgets@2x.png b/assets/widgets@2x.png new file mode 100644 index 00000000..4bbbd572 Binary files /dev/null and b/assets/widgets@2x.png differ diff --git a/classes/CloudEvent.html b/classes/CloudEvent.html new file mode 100644 index 00000000..0a854325 --- /dev/null +++ b/classes/CloudEvent.html @@ -0,0 +1,129 @@ +CloudEvent | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudEvent<T>

+

A CloudEvent describes event data in common formats to provide +interoperability across services, platforms and systems.

+
see

https://github.com/cloudevents/spec/blob/v1.0/spec.md

+

Type Parameters

  • T = undefined

Hierarchy

  • CloudEvent

Implements

Indexable

[key: string]: unknown

Index

Constructors

  • +

    Creates a new CloudEvent object with the provided properties. If there is a chance that the event +properties will not conform to the CloudEvent specification, you may pass a boolean false as a +second parameter to bypass event validation.

    +

    Type Parameters

    • T = undefined

    Parameters

    • event: Partial<CloudEventV1<T>>
      +

      the event properties

      +
    • strict: boolean = true
      +

      whether to perform event validation when creating the object - default: true

      +

    Returns CloudEvent<T>

Properties

data?: T
+

[OPTIONAL] The event payload. This specification does not place any restriction +on the type of this information. It is encoded into a media format which is +specified by the datacontenttype attribute (e.g. application/json), and adheres +to the dataschema format when those respective attributes are present.

+
data_base64?: string
+

[OPTIONAL] The event payload encoded as base64 data. This is used when the +data is in binary form.

+
datacontenttype?: string
+

[OPTIONAL] Content type of data value. This attribute enables data to +carry any type of content, whereby format and encoding might differ from that +of the chosen event format. For example, an event rendered using the +JSON envelope format might carry an XML payload +in data, and the consumer is informed by this attribute being set to +"application/xml". The rules for how data content is rendered for different +datacontenttype values are defined in the event format specifications; for +example, the JSON event format defines the relationship in +section 3.1.

+
dataschema?: string
+

[OPTIONAL] Identifies the schema that data adheres to. Incompatible +changes to the schema SHOULD be reflected by a different URI. See +Versioning of Attributes in the Primer +for more information. +If present, MUST be a non-empty URI.

+
id: string
+

[REQUIRED] Identifies the event. Producers MUST ensure that source + id +is unique for each distinct event. If a duplicate event is re-sent (e.g. due +to a network error) it MAY have the same id. Consumers MAY assume that +Events with identical source and id are duplicates.

+
source: string
+

[REQUIRED] Identifies the context in which an event happened. Often this +will include information such as the type of the event source, the +organization publishing the event or the process that produced the event. The +exact syntax and semantics behind the data encoded in the URI is defined by +the event producer. +Producers MUST ensure that source + id is unique for each distinct event. +An application MAY assign a unique source to each distinct producer, which +makes it easy to produce unique IDs since no other producer will have the same +source. The application MAY use UUIDs, URNs, DNS authorities or an +application-specific scheme to create unique source identifiers. +A source MAY include more than one producer. In that case the producers MUST +collaborate to ensure that source + id is unique for each distinct event.

+
specversion: string
+

[REQUIRED] The version of the CloudEvents specification which the event +uses. This enables the interpretation of the context. Compliant event +producers MUST use a value of 1.0 when referring to this version of the +specification.

+
subject?: string
+

[OPTIONAL] This describes the subject of the event in the context of the +event producer (identified by source). In publish-subscribe scenarios, a +subscriber will typically subscribe to events emitted by a source, but the +source identifier alone might not be sufficient as a qualifier for any +specific event if the source context has internal sub-structure.

+

Identifying the subject of the event in context metadata (opposed to only in +the data payload) is particularly helpful in generic subscription filtering +scenarios where middleware is unable to interpret the data content. In the +above example, the subscriber might only be interested in blobs with names +ending with '.jpg' or '.jpeg' and the subject attribute allows for +constructing a simple and efficient string-suffix filter for that subset of +events.

+

If present, MUST be a non-empty string.

+
time?: string
+

[OPTIONAL] Timestamp of when the occurrence happened. If the time of the +occurrence cannot be determined then this attribute MAY be set to some other +time (such as the current time) by the CloudEvents producer, however all +producers for the same source MUST be consistent in this respect. In other +words, either they all use the actual time of the occurrence or they all use +the same algorithm to determine the value used.

+
type: string
+

[REQUIRED] This attribute contains a value describing the type of event +related to the originating occurrence. Often this attribute is used for +routing, observability, policy enforcement, etc. The format of this is +producer defined and might include information such as the version of the +type - see +Versioning of Attributes in the Primer +for more information.

+

Methods

  • +

    Clone a CloudEvent with new/updated attributes

    +
    throws

    if the CloudEvent does not conform to the schema

    +

    Parameters

    • options: Partial<CloudEventV1<never>>
      +

      attributes to augment the CloudEvent without a data property

      +
    • Optional strict: boolean
      +

      whether or not to use strict validation when cloning (default: true)

      +

    Returns CloudEvent<T>

    returns a new CloudEvent

    +
  • +

    Clone a CloudEvent with new/updated attributes and new data

    +
    throws

    if the CloudEvent does not conform to the schema

    +

    Type Parameters

    • D

    Parameters

    • options: Partial<CloudEventV1<D>>
      +

      attributes to augment the CloudEvent with a data property and type

      +
    • Optional strict: boolean
      +

      whether or not to use strict validation when cloning (default: true)

      +

    Returns CloudEvent<D>

    returns a new CloudEvent

    +
  • emit(ensureDelivery?: boolean): Promise<CloudEvent<T>>
  • +

    Emit this CloudEvent through the application

    +

    Parameters

    • ensureDelivery: boolean = true
      +

      fail the promise if one listener fail

      +

    Returns Promise<CloudEvent<T>>

    this

    +
  • toJSON(): Record<string, unknown>
  • toString(): string
  • validate(): boolean
  • +

    Validates this CloudEvent against the schema

    +
    throws

    if the CloudEvent does not conform to the schema

    +

    Returns boolean

    true if this event is valid

    +
  • +

    Clone a CloudEvent with new or updated attributes.

    +
    throws

    {ValidationError} if strict is true and the resulting event is invalid

    +

    Parameters

    • event: CloudEventV1<any>
      +

      an object that implements the CloudEventV1 interface

      +
    • options: Partial<CloudEventV1<any>>
      +

      an object with new or updated attributes

      +
    • strict: boolean = true
      +

      true if the resulting event should be valid per the CloudEvent specification

      +

    Returns CloudEvent<any>

    a CloudEvent cloned from event with options applied.

    +

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Emitter.html b/classes/Emitter.html new file mode 100644 index 00000000..d74cb422 --- /dev/null +++ b/classes/Emitter.html @@ -0,0 +1,20 @@ +Emitter | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Emitter

+

A helper class to emit CloudEvents within an application

+

Hierarchy

  • Emitter

Index

Constructors

Properties

Methods

Constructors

Properties

instance: undefined | EventEmitter = undefined
+

Singleton store

+

Methods

  • emitEvent<T>(event: CloudEvent<T>, ensureDelivery?: boolean): Promise<void>
  • +

    Emit an event inside this application

    +

    Type Parameters

    • T

    Parameters

    • event: CloudEvent<T>
      +

      to emit

      +
    • ensureDelivery: boolean = true
      +

      fail the promise if one listener fails

      +

    Returns Promise<void>

  • getInstance(): EventEmitter
  • on(event: "cloudevent" | "newListener" | "removeListener", listener: ((...args: any[]) => void)): void
  • +

    Add a listener for eventing

    +

    Parameters

    • event: "cloudevent" | "newListener" | "removeListener"
      +

      type to listen to

      +
    • listener: ((...args: any[]) => void)
      +

      to call on event

      +
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/ValidationError.html b/classes/ValidationError.html new file mode 100644 index 00000000..b8c3ab57 --- /dev/null +++ b/classes/ValidationError.html @@ -0,0 +1,9 @@ +ValidationError | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ValidationError

+

An Error class that will be thrown when a CloudEvent +cannot be properly validated against a specification.

+

Hierarchy

  • TypeError
    • ValidationError

Index

Constructors

  • new ValidationError(message: string, errors?: null | string[] | ErrorObject<string, Record<string, any>, unknown>[]): ValidationError

Properties

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

Methods

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void
  • +

    Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/Mode.html b/enums/Mode.html new file mode 100644 index 00000000..b25f938a --- /dev/null +++ b/enums/Mode.html @@ -0,0 +1,3 @@ +Mode | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration Mode

+

An enum representing the two transport modes, binary and structured

+
interface

Index

Enumeration Members

Enumeration Members

BATCH: "batch"
BINARY: "binary"
STRUCTURED: "structured"

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000..74c2619d --- /dev/null +++ b/index.html @@ -0,0 +1,274 @@ +cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

cloudevents

+ +

JavaScript SDK for CloudEvents

+
+

Codacy Badge +Codacy Badge +Node.js CI +npm version +vulnerabilities

+

The CloudEvents SDK for JavaScript.

+ + +

Features

+
+
    +
  • Represent CloudEvents in memory
  • +
  • Serialize and deserialize CloudEvents in different event formats.
  • +
  • Send and receive CloudEvents with via different protocol bindings.
  • +
+

Note: Supports CloudEvent version 1.0

+ + +

Installation

+
+

The CloudEvents SDK requires a current LTS version of Node.js. At the moment +those are Node.js 16.x, and Node.js 18.x. To install in your Node.js project:

+
npm install cloudevents
+
+ + +

Receiving and Emitting Events

+
+ + +

Receiving Events

+
+

You can choose any popular web framework for port binding. A CloudEvent +object can be created by simply providing the HTTP protocol binding +the incoming headers and request body.

+
const app = require("express")();
const { HTTP } = require("cloudevents");

app.post("/", (req, res) => {
// body and headers come from an incoming HTTP request, e.g. express.js
const receivedEvent = HTTP.toEvent({ headers: req.headers, body: req.body });
console.log(receivedEvent);
}); +
+ + +

Emitting Events

+
+

The easiest way to send events is to use the built-in HTTP emitter.

+
const { httpTransport, emitterFor, CloudEvent } = require("cloudevents");

// Create an emitter to send events to a receiver
const emit = emitterFor(httpTransport("https://my.receiver.com/endpoint"));

// Create a new CloudEvent
const ce = new CloudEvent({ type, source, data });

// Send it to the endpoint - encoded as HTTP binary by default
emit(ce); +
+

If you prefer to use another transport mechanism for sending events +over HTTP, you can use the HTTP binding to create a Message which +has properties for headers and body, allowing greater flexibility +and customization. For example, the axios module is used here to send +a CloudEvent.

+
const axios = require("axios").default;
const { HTTP, CloudEvent } = require("cloudevents");

const ce = new CloudEvent({ type, source, data });
const message = HTTP.binary(ce); // Or HTTP.structured(ce)

axios({
method: "post",
url: "...",
data: message.body,
headers: message.headers,
}); +
+

You may also use the emitterFor() function as a convenience.

+
const axios = require("axios").default;
const { emitterFor, Mode, CloudEvent } = require("cloudevents");

function sendWithAxios(message) {
// Do what you need with the message headers
// and body in this function, then send the
// event
axios({
method: "post",
url: "...",
data: message.body,
headers: message.headers,
});
}

const emit = emitterFor(sendWithAxios, { mode: Mode.BINARY });
emit(new CloudEvent({ type, source, data })); +
+

You may also use the Emitter singleton to send your CloudEvents.

+
const { emitterFor, httpTransport, Mode, CloudEvent, Emitter } = require("cloudevents");

// Create a CloudEvent emitter function to send events to our receiver
const emit = emitterFor(httpTransport("https://example.com/receiver"));

// Use the emit() function to send a CloudEvent to its endpoint when a "cloudevent" event is emitted
// (see: https://nodejs.org/api/events.html#class-eventemitter)
Emitter.on("cloudevent", emit);

...
// In any part of the code, calling `emit()` on a `CloudEvent` instance will send the event
new CloudEvent({ type, source, data }).emit();

// You can also have several listeners to send the event to several endpoints +
+ + +

CloudEvent Objects

+
+

All created CloudEvent objects are read-only. If you need to update a property or add a new extension to an existing cloud event object, you can use the cloneWith method. This will return a new CloudEvent with any update or new properties. For example:

+
const {
CloudEvent,
} = require("cloudevents");

// Create a new CloudEvent
const ce = new CloudEvent({...});

// Add a new extension to an existing CloudEvent
const ce2 = ce.cloneWith({extension: "Value"}); +
+

You can create a CloudEvent object in many ways, for example, in TypeScript:

+
import { CloudEvent, CloudEventV1, CloudEventV1Attributes } from "cloudevents";
const ce: CloudEventV1<string> = {
specversion: "1.0",
source: "/some/source",
type: "example",
id: "1234"
};
const event = new CloudEvent(ce);
const ce2: CloudEventV1Attributes<string> = {
specversion: "1.0",
source: "/some/source",
type: "example",
};
const event2 = new CloudEvent(ce2);
const event3 = new CloudEvent({
source: "/some/source",
type: "example",
}); +
+ + +

A Note About Big Integers

+
+

When parsing JSON data, if a JSON field value is a number, and that number +is really big, JavaScript loses precision. For example, the Twitter API exposes +the Tweet ID. This is a large number that exceeds the integer space of Number.

+

In order to address this situation, you can set the environment variable +CE_USE_BIG_INT to the string value "true" to enable the use of the +json-bigint package. This +package is not used by default due to the resulting slowdown in parse speed +by a factor of 7x.

+

See for more information: https://github.com/cloudevents/sdk-javascript/issues/489

+ + +

Example Applications

+
+

There are a few trivial example applications in +the examples folder. +There you will find Express.js, TypeScript and Websocket examples.

+ + +

API Transition Guide

+
+

Guide Link

+ + +

Supported specification features

+
+ + + + + + + + + + + + + +
Core Specificationv0.3v1.0
CloudEvents Core:white_check_mark::white_check_mark:
+
+ + + + + + + + + + + + + + + + + + +
Event Formatsv0.3v1.0
AVRO Event Format:x::x:
JSON Event Format:white_check_mark::white_check_mark:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Protocol Bindingsv0.3v1.0
AMQP Protocol Binding:x::x:
HTTP Protocol Binding:white_check_mark::white_check_mark:
Kafka Protocol Binding:x::white_check_mark:
MQTT Protocol Binding:white_check_mark::x:
NATS Protocol Binding:x::x:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Content Modesv0.3v1.0
HTTP Binary:white_check_mark::white_check_mark:
HTTP Structured:white_check_mark::white_check_mark:
HTTP Batch:white_check_mark::white_check_mark:
Kafka Binary:white_check_mark::white_check_mark:
Kafka Structured:white_check_mark::white_check_mark:
Kafka Batch:white_check_mark::white_check_mark:
MQTT Binary:white_check_mark::white_check_mark:
MQTT Structured:white_check_mark::white_check_mark:
+ + +

Community

+
+ + + +

Maintainers

+
+

Currently active maintainers who may be found in the CNCF Slack.

+
    +
  • Lance Ball (@lance)
  • +
  • Lucas Holmquist (@lholmquist)
  • +
+ + +

Contributing

+
+

We love contributions from the community! Please check the +Contributor's Guide +for information on how to get involved.

+

Each SDK may have its own unique processes, tooling and guidelines, common +governance related material can be found in the +CloudEvents community +directory. In particular, in there you will find information concerning +how SDK projects are +managed, +guidelines +for how PR reviews and approval, and our +Code of Conduct +information.

+

If there is a security concern with one of the CloudEvents specifications, or +with one of the project's SDKs, please send an email to +cncf-cloudevents-security@lists.cncf.io.

+ + +

Additional SDK Resources

+
+ +

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/Binding.html b/interfaces/Binding.html new file mode 100644 index 00000000..8aca9196 --- /dev/null +++ b/interfaces/Binding.html @@ -0,0 +1,9 @@ +Binding | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Binding

+

Binding is an interface for transport protocols to implement, +which provides functions for sending CloudEvent Messages over +the wire.

+
interface
property

Serializer binary - converts a CloudEvent into a Message in binary mode

+
property

Serializer structured - converts a CloudEvent into a Message in structured mode

+
property

Deserializer toEvent - converts a Message into a CloudEvent

+
property

{@link Detector} isEvent - determines if a Message can be converted to a CloudEvent

+

Hierarchy

  • Binding

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/CloudEventV1.html b/interfaces/CloudEventV1.html new file mode 100644 index 00000000..89c7b8ba --- /dev/null +++ b/interfaces/CloudEventV1.html @@ -0,0 +1,94 @@ +CloudEventV1 | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CloudEventV1<T>

+

The object interface for CloudEvents 1.0.

+
see

https://github.com/cloudevents/spec/blob/v1.0/spec.md

+

Type Parameters

  • T

Hierarchy

Implemented by

Index

Properties

data?: T
+

[OPTIONAL] The event payload. This specification does not place any restriction +on the type of this information. It is encoded into a media format which is +specified by the datacontenttype attribute (e.g. application/json), and adheres +to the dataschema format when those respective attributes are present.

+
data_base64?: string
+

[OPTIONAL] The event payload encoded as base64 data. This is used when the +data is in binary form.

+
see

https://github.com/cloudevents/spec/blob/v1.0/json-format.md#31-handling-of-data

+
datacontenttype?: string
+

[OPTIONAL] Content type of data value. This attribute enables data to +carry any type of content, whereby format and encoding might differ from that +of the chosen event format. For example, an event rendered using the +JSON envelope format might carry an XML payload +in data, and the consumer is informed by this attribute being set to +"application/xml". The rules for how data content is rendered for different +datacontenttype values are defined in the event format specifications; for +example, the JSON event format defines the relationship in +section 3.1.

+
dataschema?: string
+

[OPTIONAL] Identifies the schema that data adheres to. Incompatible +changes to the schema SHOULD be reflected by a different URI. See +Versioning of Attributes in the Primer +for more information. +If present, MUST be a non-empty URI.

+
id: string
+

[REQUIRED] Identifies the event. Producers MUST ensure that source + id +is unique for each distinct event. If a duplicate event is re-sent (e.g. due +to a network error) it MAY have the same id. Consumers MAY assume that +Events with identical source and id are duplicates.

+
required

Non-empty string. Unique within producer.

+
example

An event counter maintained by the producer

+
example

A UUID

+
source: string
+

[REQUIRED] Identifies the context in which an event happened. Often this +will include information such as the type of the event source, the +organization publishing the event or the process that produced the event. The +exact syntax and semantics behind the data encoded in the URI is defined by +the event producer. +Producers MUST ensure that source + id is unique for each distinct event. +An application MAY assign a unique source to each distinct producer, which +makes it easy to produce unique IDs since no other producer will have the same +source. The application MAY use UUIDs, URNs, DNS authorities or an +application-specific scheme to create unique source identifiers. +A source MAY include more than one producer. In that case the producers MUST +collaborate to ensure that source + id is unique for each distinct event.

+
required

Non-empty URI-reference

+
specversion: string
+

[REQUIRED] The version of the CloudEvents specification which the event +uses. This enables the interpretation of the context. Compliant event +producers MUST use a value of 1.0 when referring to this version of the +specification.

+
required

MUST be a non-empty string.

+
subject?: string
+

[OPTIONAL] This describes the subject of the event in the context of the +event producer (identified by source). In publish-subscribe scenarios, a +subscriber will typically subscribe to events emitted by a source, but the +source identifier alone might not be sufficient as a qualifier for any +specific event if the source context has internal sub-structure.

+

Identifying the subject of the event in context metadata (opposed to only in +the data payload) is particularly helpful in generic subscription filtering +scenarios where middleware is unable to interpret the data content. In the +above example, the subscriber might only be interested in blobs with names +ending with '.jpg' or '.jpeg' and the subject attribute allows for +constructing a simple and efficient string-suffix filter for that subset of +events.

+

If present, MUST be a non-empty string.

+
example

"https://example.com/storage/tenant/container"

+
example

"mynewfile.jpg"

+
time?: string
+

[OPTIONAL] Timestamp of when the occurrence happened. If the time of the +occurrence cannot be determined then this attribute MAY be set to some other +time (such as the current time) by the CloudEvents producer, however all +producers for the same source MUST be consistent in this respect. In other +words, either they all use the actual time of the occurrence or they all use +the same algorithm to determine the value used.

+
example

"2020-08-08T14:48:09.769Z"

+
type: string
+

[REQUIRED] This attribute contains a value describing the type of event +related to the originating occurrence. Often this attribute is used for +routing, observability, policy enforcement, etc. The format of this is +producer defined and might include information such as the version of the +type - see +Versioning of Attributes in the Primer +for more information.

+
required

MUST be a non-empty string

+
should

SHOULD be prefixed with a reverse-DNS name. The prefixed domain dictates the + organization which defines the semantics of this event type.

+
example

com.github.pull.create

+
example

com.example.object.delete.v2

+

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/Deserializer.html b/interfaces/Deserializer.html new file mode 100644 index 00000000..c63c41ec --- /dev/null +++ b/interfaces/Deserializer.html @@ -0,0 +1,4 @@ +Deserializer | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Deserializer

Hierarchy

  • Deserializer

Callable

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/EmitterFunction.html b/interfaces/EmitterFunction.html new file mode 100644 index 00000000..eca2f604 --- /dev/null +++ b/interfaces/EmitterFunction.html @@ -0,0 +1,5 @@ +EmitterFunction | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EmitterFunction

Hierarchy

  • EmitterFunction

Callable

  • +

    EmitterFunction is an invokable interface returned by emitterFor. +Invoke an EmitterFunction with a CloudEvent and optional transport +options to send the event as a Message across supported transports.

    +
    interface

    Type Parameters

    • T

    Parameters

    Returns Promise<unknown>

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/Headers.html b/interfaces/Headers.html new file mode 100644 index 00000000..fa738bf6 --- /dev/null +++ b/interfaces/Headers.html @@ -0,0 +1,4 @@ +Headers | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Headers

+

Headers is an interface representing transport-agnostic headers as +key/value string pairs

+
interface

Hierarchy

  • IncomingHttpHeaders
    • Headers

Indexable

[key: string]: string | string[] | undefined

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/KafkaEvent.html b/interfaces/KafkaEvent.html new file mode 100644 index 00000000..a2b15a13 --- /dev/null +++ b/interfaces/KafkaEvent.html @@ -0,0 +1,97 @@ +KafkaEvent | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KafkaEvent<T>

+

Extends the base CloudEventV1 interface to include a partitionkey field +which is explicitly mapped to KafkaMessage#key

+

Type Parameters

  • T

Hierarchy

Index

Properties

data?: T
+

[OPTIONAL] The event payload. This specification does not place any restriction +on the type of this information. It is encoded into a media format which is +specified by the datacontenttype attribute (e.g. application/json), and adheres +to the dataschema format when those respective attributes are present.

+
data_base64?: string
+

[OPTIONAL] The event payload encoded as base64 data. This is used when the +data is in binary form.

+
see

https://github.com/cloudevents/spec/blob/v1.0/json-format.md#31-handling-of-data

+
datacontenttype?: string
+

[OPTIONAL] Content type of data value. This attribute enables data to +carry any type of content, whereby format and encoding might differ from that +of the chosen event format. For example, an event rendered using the +JSON envelope format might carry an XML payload +in data, and the consumer is informed by this attribute being set to +"application/xml". The rules for how data content is rendered for different +datacontenttype values are defined in the event format specifications; for +example, the JSON event format defines the relationship in +section 3.1.

+
dataschema?: string
+

[OPTIONAL] Identifies the schema that data adheres to. Incompatible +changes to the schema SHOULD be reflected by a different URI. See +Versioning of Attributes in the Primer +for more information. +If present, MUST be a non-empty URI.

+
id: string
+

[REQUIRED] Identifies the event. Producers MUST ensure that source + id +is unique for each distinct event. If a duplicate event is re-sent (e.g. due +to a network error) it MAY have the same id. Consumers MAY assume that +Events with identical source and id are duplicates.

+
required

Non-empty string. Unique within producer.

+
example

An event counter maintained by the producer

+
example

A UUID

+
partitionkey: Key
source: string
+

[REQUIRED] Identifies the context in which an event happened. Often this +will include information such as the type of the event source, the +organization publishing the event or the process that produced the event. The +exact syntax and semantics behind the data encoded in the URI is defined by +the event producer. +Producers MUST ensure that source + id is unique for each distinct event. +An application MAY assign a unique source to each distinct producer, which +makes it easy to produce unique IDs since no other producer will have the same +source. The application MAY use UUIDs, URNs, DNS authorities or an +application-specific scheme to create unique source identifiers. +A source MAY include more than one producer. In that case the producers MUST +collaborate to ensure that source + id is unique for each distinct event.

+
required

Non-empty URI-reference

+
specversion: string
+

[REQUIRED] The version of the CloudEvents specification which the event +uses. This enables the interpretation of the context. Compliant event +producers MUST use a value of 1.0 when referring to this version of the +specification.

+
required

MUST be a non-empty string.

+
subject?: string
+

[OPTIONAL] This describes the subject of the event in the context of the +event producer (identified by source). In publish-subscribe scenarios, a +subscriber will typically subscribe to events emitted by a source, but the +source identifier alone might not be sufficient as a qualifier for any +specific event if the source context has internal sub-structure.

+

Identifying the subject of the event in context metadata (opposed to only in +the data payload) is particularly helpful in generic subscription filtering +scenarios where middleware is unable to interpret the data content. In the +above example, the subscriber might only be interested in blobs with names +ending with '.jpg' or '.jpeg' and the subject attribute allows for +constructing a simple and efficient string-suffix filter for that subset of +events.

+

If present, MUST be a non-empty string.

+
example

"https://example.com/storage/tenant/container"

+
example

"mynewfile.jpg"

+
time?: string
+

[OPTIONAL] Timestamp of when the occurrence happened. If the time of the +occurrence cannot be determined then this attribute MAY be set to some other +time (such as the current time) by the CloudEvents producer, however all +producers for the same source MUST be consistent in this respect. In other +words, either they all use the actual time of the occurrence or they all use +the same algorithm to determine the value used.

+
example

"2020-08-08T14:48:09.769Z"

+
type: string
+

[REQUIRED] This attribute contains a value describing the type of event +related to the originating occurrence. Often this attribute is used for +routing, observability, policy enforcement, etc. The format of this is +producer defined and might include information such as the version of the +type - see +Versioning of Attributes in the Primer +for more information.

+
required

MUST be a non-empty string

+
should

SHOULD be prefixed with a reverse-DNS name. The prefixed domain dictates the + organization which defines the semantics of this event type.

+
example

com.github.pull.create

+
example

com.example.object.delete.v2

+

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/KafkaMessage.html b/interfaces/KafkaMessage.html new file mode 100644 index 00000000..8710ee8a --- /dev/null +++ b/interfaces/KafkaMessage.html @@ -0,0 +1,4 @@ +KafkaMessage | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KafkaMessage<T>

+

Extends the base Message type to include +Kafka-specific fields

+

Type Parameters

  • T = string

Hierarchy

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/MQTTMessage.html b/interfaces/MQTTMessage.html new file mode 100644 index 00000000..923940be --- /dev/null +++ b/interfaces/MQTTMessage.html @@ -0,0 +1,13 @@ +MQTTMessage | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MQTTMessage<T>

+

Extends the base Message interface to include MQTT attributes, some of which +are aliases of the {Message} attributes.

+

Type Parameters

  • T

Hierarchy

Index

Properties

PUBLISH: undefined | Record<string, undefined | string>
+

Identifies this message as a PUBLISH packet. MQTTMessages created with +the binary and structured Serializers will contain a "Content Type" +property in the PUBLISH record.

+
see

https://github.com/cloudevents/spec/blob/v1.0.1/mqtt-protocol-binding.md#3-mqtt-publish-message-mapping

+
User Properties: undefined | Headers
+

Alias of {Message#headers}

+
payload: undefined | T
+

Alias of {Message#body}

+

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/Message.html b/interfaces/Message.html new file mode 100644 index 00000000..d230be9c --- /dev/null +++ b/interfaces/Message.html @@ -0,0 +1,6 @@ +Message | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Message<T>

+

Message is an interface representing a CloudEvent as a +transport-agnostic message

+
interface
property

Headers headers - the headers for the event Message

+
property

{T | string | Buffer | unknown} body - the body of the event Message

+

Type Parameters

  • T = string

Hierarchy

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/Options.html b/interfaces/Options.html new file mode 100644 index 00000000..dd8c9f1e --- /dev/null +++ b/interfaces/Options.html @@ -0,0 +1,4 @@ +Options | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Options

+

Options is an additional, optional dictionary of options that may +be passed to an EmitterFunction and TransportFunction

+
interface

Hierarchy

  • Options

Indexable

[key: string]: string | Record<string, unknown> | unknown

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/Serializer.html b/interfaces/Serializer.html new file mode 100644 index 00000000..69ed2432 --- /dev/null +++ b/interfaces/Serializer.html @@ -0,0 +1,4 @@ +Serializer | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Serializer

Hierarchy

  • Serializer

Callable

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/TransportFunction.html b/interfaces/TransportFunction.html new file mode 100644 index 00000000..6cebdbe7 --- /dev/null +++ b/interfaces/TransportFunction.html @@ -0,0 +1,5 @@ +TransportFunction | cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TransportFunction

Hierarchy

  • TransportFunction

Callable

  • TransportFunction(message: Message<string>, options?: Options): Promise<unknown>
  • +

    TransportFunction is an invokable interface provided to the emitterFactory. +A TransportFunction's responsiblity is to send a JSON encoded event Message +across the wire.

    +
    interface

    Parameters

    Returns Promise<unknown>

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/modules.html b/modules.html new file mode 100644 index 00000000..19444dbf --- /dev/null +++ b/modules.html @@ -0,0 +1,43 @@ +cloudevents
Options
All
  • Public
  • Public/Protected
  • All
Menu

cloudevents

Index

Variables

HTTP: Binding = ...
+

Bindings for HTTP transport support

+
implements

Binding

+
Kafka: Binding = ...
+

Bindings for Kafka transport

+
implements

Binding

+
MQTT: Binding = ...
+

Binding for MQTT transport support

+
implements

@linkcode Binding

+
V1: "1.0" = "1.0"
+

Constants representing the CloudEvent specification version

+

Functions

  • MQTTMessageFactory<T>(contentType: string, headers: Record<string, unknown>, body: T): MQTTMessage<T>
  • +

    A helper function to create an MQTTMessage object, with "User Properties" as an alias +for "headers" and "payload" an alias for body, and a "PUBLISH" record with a "Content Type" +property.

    +

    Type Parameters

    • T

    Parameters

    • contentType: string
      +

      the "Content Type" attribute on PUBLISH

      +
    • headers: Record<string, unknown>
      +

      the headers and "User Properties"

      +
    • body: T
      +

      the message body/payload

      +

    Returns MQTTMessage<T>

    a message initialized with the provided attributes

    +
  • +

    httpTransport provides a simple HTTP Transport function, which can send a CloudEvent, +encoded as a Message to the endpoint. The returned function can be used with emitterFor() +to provide an event emitter, for example:

    +

    const emitter = emitterFor(httpTransport("http://example.com")); +emitter.emit(myCloudEvent) + .then(resp => console.log(resp));

    +

    Parameters

    • sink: string | URL
      +

      the destination endpoint for the event

      +

    Returns TransportFunction

    a function which can be used to send CloudEvents to sink

    +

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file