diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/v1/.nojekyll b/v1/.nojekyll new file mode 100644 index 00000000..e2ac6616 --- /dev/null +++ b/v1/.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/v1/assets/highlight.css b/v1/assets/highlight.css new file mode 100644 index 00000000..bdfca481 --- /dev/null +++ b/v1/assets/highlight.css @@ -0,0 +1,146 @@ +:root { + --light-hl-0: #000000; + --dark-hl-0: #d4d4d4; + --light-hl-1: #af00db; + --dark-hl-1: #c586c0; + --light-hl-2: #001080; + --dark-hl-2: #9cdcfe; + --light-hl-3: #a31515; + --dark-hl-3: #ce9178; + --light-hl-4: #008000; + --dark-hl-4: #6a9955; + --light-hl-5: #0000ff; + --dark-hl-5: #569cd6; + --light-hl-6: #0070c1; + --dark-hl-6: #4fc1ff; + --light-hl-7: #795e26; + --dark-hl-7: #dcdcaa; + --light-hl-8: #800000; + --dark-hl-8: #808080; + --light-hl-9: #800000; + --dark-hl-9: #569cd6; + --light-hl-10: #000000ff; + --dark-hl-10: #d4d4d4; + --light-hl-11: #ff0000; + --dark-hl-11: #9cdcfe; + --light-hl-12: #0000ff; + --dark-hl-12: #ce9178; + --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); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --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); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --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); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --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); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --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); +} +.hl-9 { + color: var(--hl-9); +} +.hl-10 { + color: var(--hl-10); +} +.hl-11 { + color: var(--hl-11); +} +.hl-12 { + color: var(--hl-12); +} +pre, +code { + background: var(--code-background); +} diff --git a/v1/assets/icons.css b/v1/assets/icons.css new file mode 100644 index 00000000..c0ffdc11 --- /dev/null +++ b/v1/assets/icons.css @@ -0,0 +1,935 @@ +.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/v1/assets/icons.png b/v1/assets/icons.png new file mode 100644 index 00000000..3836d5fe Binary files /dev/null and b/v1/assets/icons.png differ diff --git a/v1/assets/icons@2x.png b/v1/assets/icons@2x.png new file mode 100644 index 00000000..5a209e2f Binary files /dev/null and b/v1/assets/icons@2x.png differ diff --git a/v1/assets/main.js b/v1/assets/main.js new file mode 100644 index 00000000..93a73e00 --- /dev/null +++ b/v1/assets/main.js @@ -0,0 +1,2065 @@ +;(() => { + 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; i < n.length; i++) { + var s = n[i], + o = e[s] + if (Array.isArray(o)) { + r[s] = o.slice() + continue + } + if (typeof o == 'string' || typeof o == 'number' || typeof o == 'boolean') { + r[s] = o + continue + } + throw new TypeError('clone is not deep and does not support nested objects') + } + return r + }), + (t.FieldRef = function (e, r, n) { + ;(this.docRef = e), (this.fieldName = r), (this._stringValue = n) + }), + (t.FieldRef.joiner = '/'), + (t.FieldRef.fromString = function (e) { + var r = e.indexOf(t.FieldRef.joiner) + if (r === -1) throw 'malformed field ref string' + var n = e.slice(0, r), + i = e.slice(r + 1) + return new t.FieldRef(i, n, e) + }), + (t.FieldRef.prototype.toString = function () { + return ( + this._stringValue == null && + (this._stringValue = this.fieldName + t.FieldRef.joiner + this.docRef), + this._stringValue + ) + }) + ;(t.Set = function (e) { + if (((this.elements = Object.create(null)), e)) { + this.length = e.length + for (var r = 0; r < this.length; r++) this.elements[e[r]] = !0 + } else this.length = 0 + }), + (t.Set.complete = { + intersect: function (e) { + return e + }, + union: function () { + return this + }, + contains: function () { + return !0 + }, + }), + (t.Set.empty = { + intersect: function () { + return this + }, + union: function (e) { + return e + }, + contains: function () { + return !1 + }, + }), + (t.Set.prototype.contains = function (e) { + return !!this.elements[e] + }), + (t.Set.prototype.intersect = function (e) { + var r, + n, + i, + s = [] + if (e === t.Set.complete) return this + if (e === t.Set.empty) return e + this.length < e.length ? ((r = this), (n = e)) : ((r = e), (n = this)), + (i = Object.keys(r.elements)) + for (var o = 0; o < i.length; o++) { + var a = i[o] + a in n.elements && s.push(a) + } + return new t.Set(s) + }), + (t.Set.prototype.union = function (e) { + return e === t.Set.complete + ? t.Set.complete + : e === t.Set.empty + ? this + : new t.Set(Object.keys(this.elements).concat(Object.keys(e.elements))) + }), + (t.idf = function (e, r) { + var n = 0 + for (var i in e) i != '_index' && (n += Object.keys(e[i]).length) + var s = (r - n + 0.5) / (n + 0.5) + return Math.log(1 + Math.abs(s)) + }), + (t.Token = function (e, r) { + ;(this.str = e || ''), (this.metadata = r || {}) + }), + (t.Token.prototype.toString = function () { + return this.str + }), + (t.Token.prototype.update = function (e) { + return (this.str = e(this.str, this.metadata)), this + }), + (t.Token.prototype.clone = function (e) { + return ( + (e = + e || + function (r) { + return r + }), + new t.Token(e(this.str, this.metadata), this.metadata) + ) + }) + ;(t.tokenizer = function (e, r) { + if (e == null || e == null) return [] + if (Array.isArray(e)) + return e.map(function (f) { + return new t.Token(t.utils.asString(f).toLowerCase(), t.utils.clone(r)) + }) + for (var n = e.toString().toLowerCase(), i = n.length, s = [], o = 0, a = 0; o <= i; o++) { + var l = n.charAt(o), + u = o - a + if (l.match(t.tokenizer.separator) || o == i) { + if (u > 0) { + 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; n < r; n++) { + for (var i = this._stack[n], s = [], o = 0; o < e.length; o++) { + var a = i(e[o], o, e) + if (!(a == null || a === '')) + if (Array.isArray(a)) for (var l = 0; l < a.length; l++) s.push(a[l]) + else s.push(a) + } + e = s + } + return e + }), + (t.Pipeline.prototype.runString = function (e, r) { + var n = new t.Token(e, r) + return this.run([n]).map(function (i) { + return i.toString() + }) + }), + (t.Pipeline.prototype.reset = function () { + this._stack = [] + }), + (t.Pipeline.prototype.toJSON = function () { + return this._stack.map(function (e) { + return t.Pipeline.warnIfFunctionNotRegistered(e), e.label + }) + }) + ;(t.Vector = function (e) { + ;(this._magnitude = 0), (this.elements = e || []) + }), + (t.Vector.prototype.positionForIndex = function (e) { + if (this.elements.length == 0) return 0 + for ( + var r = 0, + n = this.elements.length / 2, + i = n - r, + s = Math.floor(i / 2), + o = this.elements[s * 2]; + i > 1 && (o < e && (r = s), o > e && (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 (o < e) return (s + 1) * 2 + }), + (t.Vector.prototype.insert = function (e, r) { + this.upsert(e, r, function () { + throw 'duplicate index' + }) + }), + (t.Vector.prototype.upsert = function (e, r, n) { + this._magnitude = 0 + var i = this.positionForIndex(e) + this.elements[i] == e + ? (this.elements[i + 1] = n(this.elements[i + 1], r)) + : this.elements.splice(i, 0, e, r) + }), + (t.Vector.prototype.magnitude = function () { + if (this._magnitude) return this._magnitude + for (var e = 0, r = this.elements.length, n = 1; n < r; n += 2) { + var i = this.elements[n] + e += i * i + } + return (this._magnitude = Math.sqrt(e)) + }), + (t.Vector.prototype.dot = function (e) { + for ( + var r = 0, + n = this.elements, + i = e.elements, + s = n.length, + o = i.length, + a = 0, + l = 0, + u = 0, + h = 0; + u < s && h < o; + + ) + (a = n[u]), + (l = i[h]), + a < l + ? (u += 2) + : a > l + ? (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; + r < this.elements.length; + r += 2, n++ + ) + e[n] = this.elements[r] + return e + }), + (t.Vector.prototype.toJSON = function () { + return this.elements + }) + ;(t.stemmer = (function () { + var e = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log', + }, + r = { icate: 'ic', ative: '', alize: 'al', iciti: 'ic', ical: 'ic', ful: '', ness: '' }, + n = '[^aeiou]', + i = '[aeiouy]', + s = n + '[^aeiouy]*', + o = i + '[aeiou]*', + a = '^(' + s + ')?' + o + s, + l = '^(' + s + ')?' + o + s + '(' + o + ')?$', + u = '^(' + s + ')?' + o + s + o + s, + h = '^(' + s + ')?' + i, + f = new RegExp(a), + p = new RegExp(u), + E = new RegExp(l), + y = new RegExp(h), + b = /^(.+?)(ss|i)es$/, + m = /^(.+?)([^s])s$/, + v = /^(.+?)eed$/, + T = /^(.+?)(ed|ing)$/, + w = /.$/, + I = /(at|bl|iz)$/, + M = new RegExp('([^aeiouylsz])\\1$'), + B = new RegExp('^' + s + i + '[^aeiouwxy]$'), + V = /^(.+?[^aeiou])y$/, + q = + /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/, + $ = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/, + H = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/, + W = /^(.+?)(s|t)(ion)$/, + P = /^(.+?)e$/, + U = /ll$/, + G = new RegExp('^' + s + i + '[^aeiouwxy]$'), + z = function (c) { + var g, O, S, d, x, R, F + if (c.length < 3) return c + if ( + ((S = c.substr(0, 1)), + S == 'y' && (c = S.toUpperCase() + c.substr(1)), + (d = b), + (x = m), + d.test(c) ? (c = c.replace(d, '$1$2')) : x.test(c) && (c = c.replace(x, '$1$2')), + (d = v), + (x = T), + d.test(c)) + ) { + var L = d.exec(c) + ;(d = f), d.test(L[1]) && ((d = w), (c = c.replace(d, ''))) + } else if (x.test(c)) { + var L = x.exec(c) + ;(g = L[1]), + (x = y), + x.test(g) && + ((c = g), + (x = I), + (R = M), + (F = B), + x.test(c) + ? (c = c + 'e') + : R.test(c) + ? ((d = w), (c = c.replace(d, ''))) + : F.test(c) && (c = c + 'e')) + } + if (((d = V), d.test(c))) { + var L = d.exec(c) + ;(g = L[1]), (c = g + 'i') + } + if (((d = q), d.test(c))) { + var L = d.exec(c) + ;(g = L[1]), (O = L[2]), (d = f), d.test(g) && (c = g + e[O]) + } + if (((d = $), d.test(c))) { + var L = d.exec(c) + ;(g = L[1]), (O = L[2]), (d = f), d.test(g) && (c = g + r[O]) + } + if (((d = H), (x = W), d.test(c))) { + var L = d.exec(c) + ;(g = L[1]), (d = p), d.test(g) && (c = g) + } else if (x.test(c)) { + var L = x.exec(c) + ;(g = L[1] + L[2]), (x = p), x.test(g) && (c = g) + } + if (((d = P), d.test(c))) { + var L = d.exec(c) + ;(g = L[1]), + (d = p), + (x = E), + (R = G), + (d.test(g) || (x.test(g) && !R.test(g))) && (c = g) + } + return ( + (d = U), + (x = p), + d.test(c) && x.test(c) && ((d = w), (c = c.replace(d, ''))), + S == 'y' && (c = S.toLowerCase() + c.substr(1)), + c + ) + } + return function (D) { + return D.update(z) + } + })()), + t.Pipeline.registerFunction(t.stemmer, 'stemmer') + ;(t.generateStopWordFilter = function (e) { + var r = e.reduce(function (n, i) { + return (n[i] = i), n + }, {}) + return function (n) { + if (n && r[n.toString()] !== n.toString()) return n + } + }), + (t.stopWordFilter = t.generateStopWordFilter([ + 'a', + 'able', + 'about', + 'across', + 'after', + 'all', + 'almost', + 'also', + 'am', + 'among', + 'an', + 'and', + 'any', + 'are', + 'as', + 'at', + 'be', + 'because', + 'been', + 'but', + 'by', + 'can', + 'cannot', + 'could', + 'dear', + 'did', + 'do', + 'does', + 'either', + 'else', + 'ever', + 'every', + 'for', + 'from', + 'get', + 'got', + 'had', + 'has', + 'have', + 'he', + 'her', + 'hers', + 'him', + 'his', + 'how', + 'however', + 'i', + 'if', + 'in', + 'into', + 'is', + 'it', + 'its', + 'just', + 'least', + 'let', + 'like', + 'likely', + 'may', + 'me', + 'might', + 'most', + 'must', + 'my', + 'neither', + 'no', + 'nor', + 'not', + 'of', + 'off', + 'often', + 'on', + 'only', + 'or', + 'other', + 'our', + 'own', + 'rather', + 'said', + 'say', + 'says', + 'she', + 'should', + 'since', + 'so', + 'some', + 'than', + 'that', + 'the', + 'their', + 'them', + 'then', + 'there', + 'these', + 'they', + 'this', + 'tis', + 'to', + 'too', + 'twas', + 'us', + 'wants', + 'was', + 'we', + 'were', + 'what', + 'when', + 'where', + 'which', + 'while', + 'who', + 'whom', + 'why', + 'will', + 'with', + 'would', + 'yet', + 'you', + 'your', + ])), + t.Pipeline.registerFunction(t.stopWordFilter, 'stopWordFilter') + ;(t.trimmer = function (e) { + return e.update(function (r) { + return r.replace(/^\W+/, '').replace(/\W+$/, '') + }) + }), + t.Pipeline.registerFunction(t.trimmer, 'trimmer') + ;(t.TokenSet = function () { + ;(this.final = !1), + (this.edges = {}), + (this.id = t.TokenSet._nextId), + (t.TokenSet._nextId += 1) + }), + (t.TokenSet._nextId = 1), + (t.TokenSet.fromArray = function (e) { + for (var r = new t.TokenSet.Builder(), n = 0, i = e.length; n < i; n++) r.insert(e[n]) + return r.finish(), r.root + }), + (t.TokenSet.fromClause = function (e) { + return 'editDistance' in e + ? t.TokenSet.fromFuzzyString(e.term, e.editDistance) + : t.TokenSet.fromString(e.term) + }), + (t.TokenSet.fromFuzzyString = function (e, r) { + for (var n = new t.TokenSet(), i = [{ node: n, editsRemaining: r, str: e }]; i.length; ) { + var s = i.pop() + if (s.str.length > 0) { + 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 < s; i++) { + var o = e[i], + a = i == s - 1 + if (o == '*') (r.edges[o] = r), (r.final = a) + else { + var l = new t.TokenSet() + ;(l.final = a), (r.edges[o] = l), (r = l) + } + } + return n + }), + (t.TokenSet.prototype.toArray = function () { + for (var e = [], r = [{ prefix: '', node: this }]; r.length; ) { + var n = r.pop(), + i = Object.keys(n.node.edges), + s = i.length + n.node.final && (n.prefix.charAt(0), e.push(n.prefix)) + for (var o = 0; o < s; o++) { + var a = i[o] + r.push({ prefix: n.prefix.concat(a), node: n.node.edges[a] }) + } + } + return e + }), + (t.TokenSet.prototype.toString = function () { + if (this._str) return this._str + for ( + var e = this.final ? '1' : '0', r = Object.keys(this.edges).sort(), n = r.length, i = 0; + i < n; + i++ + ) { + var s = r[i], + o = this.edges[s] + e = e + s + o.id + } + return e + }), + (t.TokenSet.prototype.intersect = function (e) { + for ( + var r = new t.TokenSet(), n = void 0, i = [{ qNode: e, output: r, node: this }]; + i.length; + + ) { + n = i.pop() + for ( + var s = Object.keys(n.qNode.edges), + o = s.length, + a = Object.keys(n.node.edges), + l = a.length, + u = 0; + u < o; + u++ + ) + for (var h = s[u], f = 0; f < l; f++) { + var p = a[f] + if (p == h || h == '*') { + var E = n.node.edges[p], + y = n.qNode.edges[h], + b = E.final && y.final, + m = void 0 + p in n.output.edges + ? ((m = n.output.edges[p]), (m.final = m.final || b)) + : ((m = new t.TokenSet()), (m.final = b), (n.output.edges[p] = m)), + i.push({ qNode: y, output: m, node: E }) + } + } + } + return r + }), + (t.TokenSet.Builder = function () { + ;(this.previousWord = ''), + (this.root = new t.TokenSet()), + (this.uncheckedNodes = []), + (this.minimizedNodes = {}) + }), + (t.TokenSet.Builder.prototype.insert = function (e) { + var r, + n = 0 + if (e < this.previousWord) throw new Error('Out of order word insertion') + for ( + var i = 0; + i < e.length && i < this.previousWord.length && e[i] == this.previousWord[i]; + i++ + ) + n++ + this.minimize(n), + this.uncheckedNodes.length == 0 + ? (r = this.root) + : (r = this.uncheckedNodes[this.uncheckedNodes.length - 1].child) + for (var i = n; i < e.length; i++) { + var s = new t.TokenSet(), + o = e[i] + ;(r.edges[o] = s), this.uncheckedNodes.push({ parent: r, char: o, child: s }), (r = s) + } + ;(r.final = !0), (this.previousWord = e) + }), + (t.TokenSet.Builder.prototype.finish = function () { + this.minimize(0) + }), + (t.TokenSet.Builder.prototype.minimize = function (e) { + for (var r = this.uncheckedNodes.length - 1; r >= 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; + l < this.fields.length; + l++ + ) + i[this.fields[l]] = new t.Vector() + e.call(r, r) + for (var l = 0; l < r.clauses.length; l++) { + var u = r.clauses[l], + h = null, + f = t.Set.empty + u.usePipeline + ? (h = this.pipeline.runString(u.term, { fields: u.fields })) + : (h = [u.term]) + for (var p = 0; p < h.length; p++) { + var E = h[p] + u.term = E + var y = t.TokenSet.fromClause(u), + b = this.tokenSet.intersect(y).toArray() + if (b.length === 0 && u.presence === t.Query.presence.REQUIRED) { + for (var m = 0; m < u.fields.length; m++) { + var v = u.fields[m] + o[v] = t.Set.empty + } + break + } + for (var T = 0; T < b.length; T++) + for ( + var w = b[T], I = this.invertedIndex[w], M = I._index, m = 0; + m < u.fields.length; + m++ + ) { + var v = u.fields[m], + B = I[v], + V = Object.keys(B), + q = w + '/' + v, + $ = new t.Set(V) + if ( + (u.presence == t.Query.presence.REQUIRED && + ((f = f.union($)), o[v] === void 0 && (o[v] = t.Set.complete)), + u.presence == t.Query.presence.PROHIBITED) + ) { + a[v] === void 0 && (a[v] = t.Set.empty), (a[v] = a[v].union($)) + continue + } + if ( + (i[v].upsert(M, u.boost, function (Qe, Ie) { + return Qe + Ie + }), + !s[q]) + ) { + for (var H = 0; H < V.length; H++) { + var W = V[H], + P = new t.FieldRef(W, v), + U = B[W], + G + ;(G = n[P]) === void 0 ? (n[P] = new t.MatchData(w, v, U)) : G.add(w, v, U) + } + s[q] = !0 + } + } + } + if (u.presence === t.Query.presence.REQUIRED) + for (var m = 0; m < u.fields.length; m++) { + var v = u.fields[m] + o[v] = o[v].intersect(f) + } + } + for (var z = t.Set.complete, D = t.Set.empty, l = 0; l < this.fields.length; l++) { + var v = this.fields[l] + o[v] && (z = z.intersect(o[v])), a[v] && (D = D.union(a[v])) + } + var c = Object.keys(n), + g = [], + O = Object.create(null) + if (r.isNegated()) { + c = Object.keys(this.fieldVectors) + for (var l = 0; l < c.length; l++) { + var P = c[l], + S = t.FieldRef.fromString(P) + n[P] = new t.MatchData() + } + } + for (var l = 0; l < c.length; l++) { + var S = t.FieldRef.fromString(c[l]), + d = S.docRef + if (!!z.contains(d) && !D.contains(d)) { + var x = this.fieldVectors[S], + R = i[S.fieldName].similarity(x), + F + if ((F = O[d]) !== void 0) (F.score += R), F.matchData.combine(n[S]) + else { + var L = { ref: d, score: R, matchData: n[S] } + ;(O[d] = L), g.push(L) + } + } + } + return g.sort(function (Se, ke) { + return ke.score - Se.score + }) + }), + (t.Index.prototype.toJSON = function () { + var e = Object.keys(this.invertedIndex) + .sort() + .map(function (n) { + return [n, this.invertedIndex[n]] + }, this), + r = Object.keys(this.fieldVectors).map(function (n) { + return [n, this.fieldVectors[n].toJSON()] + }, this) + return { + version: t.version, + fields: this.fields, + fieldVectors: r, + invertedIndex: e, + pipeline: this.pipeline.toJSON(), + } + }), + (t.Index.load = function (e) { + var r = {}, + n = {}, + i = e.fieldVectors, + s = Object.create(null), + o = e.invertedIndex, + a = new t.TokenSet.Builder(), + l = t.Pipeline.load(e.pipeline) + e.version != t.version && + t.utils.warn( + "Version mismatch when loading serialised index. Current version of lunr '" + + t.version + + "' does not match serialized index '" + + e.version + + "'" + ) + for (var u = 0; u < i.length; u++) { + var h = i[u], + f = h[0], + p = h[1] + n[f] = new t.Vector(p) + } + for (var u = 0; u < o.length; u++) { + var h = o[u], + E = h[0], + y = h[1] + a.insert(E), (s[E] = y) + } + return ( + a.finish(), + (r.fields = e.fields), + (r.fieldVectors = n), + (r.invertedIndex = s), + (r.tokenSet = a.root), + (r.pipeline = l), + new t.Index(r) + ) + }) + ;(t.Builder = function () { + ;(this._ref = 'id'), + (this._fields = Object.create(null)), + (this._documents = Object.create(null)), + (this.invertedIndex = Object.create(null)), + (this.fieldTermFrequencies = {}), + (this.fieldLengths = {}), + (this.tokenizer = t.tokenizer), + (this.pipeline = new t.Pipeline()), + (this.searchPipeline = new t.Pipeline()), + (this.documentCount = 0), + (this._b = 0.75), + (this._k1 = 1.2), + (this.termIndex = 0), + (this.metadataWhitelist = []) + }), + (t.Builder.prototype.ref = function (e) { + this._ref = e + }), + (t.Builder.prototype.field = function (e, r) { + if (/\//.test(e)) throw new RangeError("Field '" + e + "' contains illegal character '/'") + this._fields[e] = r || {} + }), + (t.Builder.prototype.b = function (e) { + e < 0 ? (this._b = 0) : e > 1 ? (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 < i.length; s++) { + var o = i[s], + a = this._fields[o].extractor, + l = a ? a(e) : e[o], + u = this.tokenizer(l, { fields: [o] }), + h = this.pipeline.run(u), + f = new t.FieldRef(n, o), + p = Object.create(null) + ;(this.fieldTermFrequencies[f] = p), + (this.fieldLengths[f] = 0), + (this.fieldLengths[f] += h.length) + for (var E = 0; E < h.length; E++) { + var y = h[E] + if ((p[y] == null && (p[y] = 0), (p[y] += 1), this.invertedIndex[y] == null)) { + var b = Object.create(null) + ;(b._index = this.termIndex), (this.termIndex += 1) + for (var m = 0; m < i.length; m++) b[i[m]] = Object.create(null) + this.invertedIndex[y] = b + } + this.invertedIndex[y][o][n] == null && + (this.invertedIndex[y][o][n] = Object.create(null)) + for (var v = 0; v < this.metadataWhitelist.length; v++) { + var T = this.metadataWhitelist[v], + w = y.metadata[T] + this.invertedIndex[y][o][n][T] == null && (this.invertedIndex[y][o][n][T] = []), + this.invertedIndex[y][o][n][T].push(w) + } + } + } + }), + (t.Builder.prototype.calculateAverageFieldLengths = function () { + for ( + var e = Object.keys(this.fieldLengths), r = e.length, n = {}, i = {}, s = 0; + s < r; + s++ + ) { + var o = t.FieldRef.fromString(e[s]), + a = o.fieldName + i[a] || (i[a] = 0), (i[a] += 1), n[a] || (n[a] = 0), (n[a] += this.fieldLengths[o]) + } + for (var l = Object.keys(this._fields), s = 0; s < l.length; s++) { + var u = l[s] + n[u] = n[u] / i[u] + } + this.averageFieldLength = n + }), + (t.Builder.prototype.createFieldVectors = function () { + for ( + var e = {}, + r = Object.keys(this.fieldTermFrequencies), + n = r.length, + i = Object.create(null), + s = 0; + s < n; + s++ + ) { + for ( + var o = t.FieldRef.fromString(r[s]), + a = o.fieldName, + l = this.fieldLengths[o], + u = new t.Vector(), + h = this.fieldTermFrequencies[o], + f = Object.keys(h), + p = f.length, + E = this._fields[a].boost || 1, + y = this._documents[o.docRef].boost || 1, + b = 0; + b < p; + b++ + ) { + var m = f[b], + v = h[m], + T = this.invertedIndex[m]._index, + w, + I, + M + i[m] === void 0 + ? ((w = t.idf(this.invertedIndex[m], this.documentCount)), (i[m] = w)) + : (w = i[m]), + (I = + (w * ((this._k1 + 1) * v)) / + (this._k1 * (1 - this._b + this._b * (l / this.averageFieldLength[a])) + v)), + (I *= E), + (I *= y), + (M = Math.round(I * 1e3) / 1e3), + u.insert(T, M) + } + e[o] = u + } + this.fieldVectors = e + }), + (t.Builder.prototype.createTokenSet = function () { + this.tokenSet = t.TokenSet.fromArray(Object.keys(this.invertedIndex).sort()) + }), + (t.Builder.prototype.build = function () { + return ( + this.calculateAverageFieldLengths(), + this.createFieldVectors(), + this.createTokenSet(), + new t.Index({ + invertedIndex: this.invertedIndex, + fieldVectors: this.fieldVectors, + tokenSet: this.tokenSet, + fields: Object.keys(this._fields), + pipeline: this.searchPipeline, + }) + ) + }), + (t.Builder.prototype.use = function (e) { + var r = Array.prototype.slice.call(arguments, 1) + r.unshift(this), e.apply(this, r) + }), + (t.MatchData = function (e, r, n) { + for (var i = Object.create(null), s = Object.keys(n || {}), o = 0; o < s.length; o++) { + var a = s[o] + i[a] = n[a].slice() + } + ;(this.metadata = Object.create(null)), + e !== void 0 && ((this.metadata[e] = Object.create(null)), (this.metadata[e][r] = i)) + }), + (t.MatchData.prototype.combine = function (e) { + for (var r = Object.keys(e.metadata), n = 0; n < r.length; n++) { + var i = r[n], + s = Object.keys(e.metadata[i]) + this.metadata[i] == null && (this.metadata[i] = Object.create(null)) + for (var o = 0; o < s.length; o++) { + var a = s[o], + l = Object.keys(e.metadata[i][a]) + this.metadata[i][a] == null && (this.metadata[i][a] = Object.create(null)) + for (var u = 0; u < l.length; u++) { + var h = l[u] + this.metadata[i][a][h] == null + ? (this.metadata[i][a][h] = e.metadata[i][a][h]) + : (this.metadata[i][a][h] = this.metadata[i][a][h].concat(e.metadata[i][a][h])) + } + } + } + }), + (t.MatchData.prototype.add = function (e, r, n) { + if (!(e in this.metadata)) { + ;(this.metadata[e] = Object.create(null)), (this.metadata[e][r] = n) + return + } + if (!(r in this.metadata[e])) { + this.metadata[e][r] = n + return + } + for (var i = Object.keys(n), s = 0; s < i.length; s++) { + var o = i[s] + o in this.metadata[e][r] + ? (this.metadata[e][r][o] = this.metadata[e][r][o].concat(n[o])) + : (this.metadata[e][r][o] = n[o]) + } + }), + (t.Query = function (e) { + ;(this.clauses = []), (this.allFields = e) + }), + (t.Query.wildcard = new String('*')), + (t.Query.wildcard.NONE = 0), + (t.Query.wildcard.LEADING = 1), + (t.Query.wildcard.TRAILING = 2), + (t.Query.presence = { OPTIONAL: 1, REQUIRED: 2, PROHIBITED: 3 }), + (t.Query.prototype.clause = function (e) { + return ( + 'fields' in e || (e.fields = this.allFields), + 'boost' in e || (e.boost = 1), + 'usePipeline' in e || (e.usePipeline = !0), + 'wildcard' in e || (e.wildcard = t.Query.wildcard.NONE), + e.wildcard & t.Query.wildcard.LEADING && + e.term.charAt(0) != t.Query.wildcard && + (e.term = '*' + e.term), + e.wildcard & t.Query.wildcard.TRAILING && + e.term.slice(-1) != t.Query.wildcard && + (e.term = '' + e.term + '*'), + 'presence' in e || (e.presence = t.Query.presence.OPTIONAL), + this.clauses.push(e), + this + ) + }), + (t.Query.prototype.isNegated = function () { + for (var e = 0; e < this.clauses.length; e++) + if (this.clauses[e].presence != t.Query.presence.PROHIBITED) return !1 + return !0 + }), + (t.Query.prototype.term = function (e, r) { + if (Array.isArray(e)) + return ( + e.forEach(function (i) { + this.term(i, t.utils.clone(r)) + }, this), + this + ) + var n = r || {} + return (n.term = e.toString()), this.clause(n), this + }), + (t.QueryParseError = function (e, r, n) { + ;(this.name = 'QueryParseError'), (this.message = e), (this.start = r), (this.end = n) + }), + (t.QueryParseError.prototype = new Error()), + (t.QueryLexer = function (e) { + ;(this.lexemes = []), + (this.str = e), + (this.length = e.length), + (this.pos = 0), + (this.start = 0), + (this.escapeCharPositions = []) + }), + (t.QueryLexer.prototype.run = function () { + for (var e = t.QueryLexer.lexText; e; ) e = e(this) + }), + (t.QueryLexer.prototype.sliceString = function () { + for ( + var e = [], r = this.start, n = this.pos, i = 0; + i < this.escapeCharPositions.length; + i++ + ) + (n = this.escapeCharPositions[i]), e.push(this.str.slice(r, n)), (r = n + 1) + return ( + e.push(this.str.slice(r, this.pos)), (this.escapeCharPositions.length = 0), e.join('') + ) + }), + (t.QueryLexer.prototype.emit = function (e) { + this.lexemes.push({ type: e, str: this.sliceString(), start: this.start, end: this.pos }), + (this.start = this.pos) + }), + (t.QueryLexer.prototype.escapeCharacter = function () { + this.escapeCharPositions.push(this.pos - 1), (this.pos += 1) + }), + (t.QueryLexer.prototype.next = function () { + if (this.pos >= 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.pos < this.length + }), + (t.QueryLexer.EOS = 'EOS'), + (t.QueryLexer.FIELD = 'FIELD'), + (t.QueryLexer.TERM = 'TERM'), + (t.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'), + (t.QueryLexer.BOOST = 'BOOST'), + (t.QueryLexer.PRESENCE = 'PRESENCE'), + (t.QueryLexer.lexField = function (e) { + return e.backup(), e.emit(t.QueryLexer.FIELD), e.ignore(), t.QueryLexer.lexText + }), + (t.QueryLexer.lexTerm = function (e) { + if ((e.width() > 1 && (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 < s; i++) + if (n[i] === r) { + n.splice(i, 1) + return + } + } + dispatchEvent(e) { + if (!(e.type in this.listeners)) return !0 + let r = this.listeners[e.type].slice() + for (let n = 0, i = r.length; n < i; n++) r[n].call(this, e) + return !e.defaultPrevented + } + } + var ne = (t, e = 100) => { + 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; i < s; i++) { + r = this.anchors[i] + let o = r.anchor.getBoundingClientRect() + r.position = o.top + document.body.scrollTop + } + this.anchors.sort((i, s) => i.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 < s && i[o + 1].position < n; ) o += 1 + this.index != o && + (this.index > -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; l < s.length; l++) { + let u = s[l], + h = n.data.rows[Number(u.ref)], + f = 1 + h.name.toLowerCase().startsWith(i.toLowerCase()) && + (f *= 1 + 1 / (Math.abs(h.name.length - i.length) * 10)), + (f *= (o = h.boost) != null ? o : 1), + (u.score *= f) + } + s.sort((l, u) => u.score - l.score) + for (let l = 0, u = Math.min(10, s.length); l < u; l++) { + let h = n.data.rows[Number(s[l].ref)], + f = ve(h.name, i) + h.parent && (f = `${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 < r.length; i++) this.groups.push(new oe(r[i], n[i])) + } + onClick(r) { + this.groups.forEach((n, 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/v1/assets/search.js b/v1/assets/search.js new file mode 100644 index 00000000..d3a0c105 --- /dev/null +++ b/v1/assets/search.js @@ -0,0 +1,3 @@ +window.searchData = JSON.parse( + '{"kinds":{"2":"Module","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","262144":"Accessor","4194304":"Type alias","16777216":"Reference"},"rows":[{"id":0,"kind":2,"name":"index","url":"modules/index.html","classes":"tsd-kind-module"},{"id":1,"kind":64,"name":"createClient","url":"modules/index.html#createClient","classes":"tsd-kind-function tsd-parent-kind-module","parent":"index"},{"id":2,"kind":2,"name":"lib/SupabaseQueryBuilder","url":"modules/lib_SupabaseQueryBuilder.html","classes":"tsd-kind-module"},{"id":3,"kind":128,"name":"SupabaseQueryBuilder","url":"classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html","classes":"tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter","parent":"lib/SupabaseQueryBuilder"},{"id":4,"kind":512,"name":"constructor","url":"classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite","parent":"lib/SupabaseQueryBuilder.SupabaseQueryBuilder"},{"id":5,"kind":1024,"name":"_subscription","url":"classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html#_subscription","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"lib/SupabaseQueryBuilder.SupabaseQueryBuilder"},{"id":6,"kind":1024,"name":"_realtime","url":"classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html#_realtime","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"lib/SupabaseQueryBuilder.SupabaseQueryBuilder"},{"id":7,"kind":1024,"name":"_headers","url":"classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html#_headers","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"lib/SupabaseQueryBuilder.SupabaseQueryBuilder"},{"id":8,"kind":1024,"name":"_schema","url":"classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html#_schema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"lib/SupabaseQueryBuilder.SupabaseQueryBuilder"},{"id":9,"kind":1024,"name":"_table","url":"classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html#_table","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"lib/SupabaseQueryBuilder.SupabaseQueryBuilder"},{"id":10,"kind":2048,"name":"on","url":"classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html#on","classes":"tsd-kind-method tsd-parent-kind-class","parent":"lib/SupabaseQueryBuilder.SupabaseQueryBuilder"},{"id":11,"kind":65536,"name":"__type","url":"classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html#__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"lib/SupabaseQueryBuilder.SupabaseQueryBuilder"},{"id":12,"kind":65536,"name":"__type","url":"classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"lib/SupabaseQueryBuilder.SupabaseQueryBuilder"},{"id":13,"kind":2,"name":"lib/SupabaseRealtimeClient","url":"modules/lib_SupabaseRealtimeClient.html","classes":"tsd-kind-module"},{"id":14,"kind":128,"name":"SupabaseRealtimeClient","url":"classes/lib_SupabaseRealtimeClient.SupabaseRealtimeClient.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"lib/SupabaseRealtimeClient"},{"id":15,"kind":512,"name":"constructor","url":"classes/lib_SupabaseRealtimeClient.SupabaseRealtimeClient.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"lib/SupabaseRealtimeClient.SupabaseRealtimeClient"},{"id":16,"kind":1024,"name":"subscription","url":"classes/lib_SupabaseRealtimeClient.SupabaseRealtimeClient.html#subscription","classes":"tsd-kind-property tsd-parent-kind-class","parent":"lib/SupabaseRealtimeClient.SupabaseRealtimeClient"},{"id":17,"kind":2048,"name":"getPayloadRecords","url":"classes/lib_SupabaseRealtimeClient.SupabaseRealtimeClient.html#getPayloadRecords","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"lib/SupabaseRealtimeClient.SupabaseRealtimeClient"},{"id":18,"kind":2048,"name":"on","url":"classes/lib_SupabaseRealtimeClient.SupabaseRealtimeClient.html#on","classes":"tsd-kind-method tsd-parent-kind-class","parent":"lib/SupabaseRealtimeClient.SupabaseRealtimeClient"},{"id":19,"kind":2048,"name":"subscribe","url":"classes/lib_SupabaseRealtimeClient.SupabaseRealtimeClient.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"lib/SupabaseRealtimeClient.SupabaseRealtimeClient"},{"id":20,"kind":2,"name":"lib/constants","url":"modules/lib_constants.html","classes":"tsd-kind-module"},{"id":21,"kind":32,"name":"DEFAULT_HEADERS","url":"modules/lib_constants.html#DEFAULT_HEADERS","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"lib/constants"},{"id":22,"kind":65536,"name":"__type","url":"modules/lib_constants.html#DEFAULT_HEADERS.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"lib/constants.DEFAULT_HEADERS"},{"id":23,"kind":1024,"name":"X-Client-Info","url":"modules/lib_constants.html#DEFAULT_HEADERS.__type.X_Client_Info","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/constants.DEFAULT_HEADERS.__type"},{"id":24,"kind":32,"name":"STORAGE_KEY","url":"modules/lib_constants.html#STORAGE_KEY","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"lib/constants"},{"id":25,"kind":2,"name":"lib/helpers","url":"modules/lib_helpers.html","classes":"tsd-kind-module"},{"id":26,"kind":64,"name":"uuid","url":"modules/lib_helpers.html#uuid","classes":"tsd-kind-function tsd-parent-kind-module","parent":"lib/helpers"},{"id":27,"kind":64,"name":"stripTrailingSlash","url":"modules/lib_helpers.html#stripTrailingSlash","classes":"tsd-kind-function tsd-parent-kind-module","parent":"lib/helpers"},{"id":28,"kind":64,"name":"isBrowser","url":"modules/lib_helpers.html#isBrowser","classes":"tsd-kind-function tsd-parent-kind-module","parent":"lib/helpers"},{"id":29,"kind":2,"name":"lib/types","url":"modules/lib_types.html","classes":"tsd-kind-module"},{"id":30,"kind":256,"name":"SupabaseAuthClientOptions","url":"interfaces/lib_types.SupabaseAuthClientOptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"lib/types"},{"id":31,"kind":65536,"name":"__type","url":"interfaces/lib_types.SupabaseAuthClientOptions.html#__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"lib/types.SupabaseAuthClientOptions"},{"id":32,"kind":65536,"name":"__type","url":"interfaces/lib_types.SupabaseAuthClientOptions.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"lib/types.SupabaseAuthClientOptions"},{"id":33,"kind":4194304,"name":"GenericObject","url":"modules/lib_types.html#GenericObject","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"lib/types"},{"id":34,"kind":65536,"name":"__type","url":"modules/lib_types.html#GenericObject.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"lib/types.GenericObject"},{"id":35,"kind":4194304,"name":"Fetch","url":"modules/lib_types.html#Fetch","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"lib/types"},{"id":36,"kind":4194304,"name":"SupabaseClientOptions","url":"modules/lib_types.html#SupabaseClientOptions","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"lib/types"},{"id":37,"kind":65536,"name":"__type","url":"modules/lib_types.html#SupabaseClientOptions.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"lib/types.SupabaseClientOptions"},{"id":38,"kind":1024,"name":"schema","url":"modules/lib_types.html#SupabaseClientOptions.__type-1.schema","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseClientOptions.__type"},{"id":39,"kind":1024,"name":"headers","url":"modules/lib_types.html#SupabaseClientOptions.__type-1.headers","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseClientOptions.__type"},{"id":40,"kind":1024,"name":"autoRefreshToken","url":"modules/lib_types.html#SupabaseClientOptions.__type-1.autoRefreshToken","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseClientOptions.__type"},{"id":41,"kind":1024,"name":"multiTab","url":"modules/lib_types.html#SupabaseClientOptions.__type-1.multiTab","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseClientOptions.__type"},{"id":42,"kind":1024,"name":"persistSession","url":"modules/lib_types.html#SupabaseClientOptions.__type-1.persistSession","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseClientOptions.__type"},{"id":43,"kind":1024,"name":"detectSessionInUrl","url":"modules/lib_types.html#SupabaseClientOptions.__type-1.detectSessionInUrl","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseClientOptions.__type"},{"id":44,"kind":1024,"name":"localStorage","url":"modules/lib_types.html#SupabaseClientOptions.__type-1.localStorage","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseClientOptions.__type"},{"id":45,"kind":1024,"name":"realtime","url":"modules/lib_types.html#SupabaseClientOptions.__type-1.realtime","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseClientOptions.__type"},{"id":46,"kind":1024,"name":"fetch","url":"modules/lib_types.html#SupabaseClientOptions.__type-1.fetch","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseClientOptions.__type"},{"id":47,"kind":1024,"name":"shouldThrowOnError","url":"modules/lib_types.html#SupabaseClientOptions.__type-1.shouldThrowOnError","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseClientOptions.__type"},{"id":48,"kind":1024,"name":"cookieOptions","url":"modules/lib_types.html#SupabaseClientOptions.__type-1.cookieOptions","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseClientOptions.__type"},{"id":49,"kind":4194304,"name":"SupabaseRealtimePayload","url":"modules/lib_types.html#SupabaseRealtimePayload","classes":"tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter","parent":"lib/types"},{"id":50,"kind":65536,"name":"__type","url":"modules/lib_types.html#SupabaseRealtimePayload.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"lib/types.SupabaseRealtimePayload"},{"id":51,"kind":1024,"name":"commit_timestamp","url":"modules/lib_types.html#SupabaseRealtimePayload.__type-2.commit_timestamp","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseRealtimePayload.__type"},{"id":52,"kind":1024,"name":"eventType","url":"modules/lib_types.html#SupabaseRealtimePayload.__type-2.eventType","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseRealtimePayload.__type"},{"id":53,"kind":1024,"name":"schema","url":"modules/lib_types.html#SupabaseRealtimePayload.__type-2.schema-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseRealtimePayload.__type"},{"id":54,"kind":1024,"name":"table","url":"modules/lib_types.html#SupabaseRealtimePayload.__type-2.table","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseRealtimePayload.__type"},{"id":55,"kind":1024,"name":"new","url":"modules/lib_types.html#SupabaseRealtimePayload.__type-2.new","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseRealtimePayload.__type"},{"id":56,"kind":1024,"name":"old","url":"modules/lib_types.html#SupabaseRealtimePayload.__type-2.old","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseRealtimePayload.__type"},{"id":57,"kind":1024,"name":"errors","url":"modules/lib_types.html#SupabaseRealtimePayload.__type-2.errors","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"lib/types.SupabaseRealtimePayload.__type"},{"id":58,"kind":4194304,"name":"SupabaseEventTypes","url":"modules/lib_types.html#SupabaseEventTypes","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"lib/types"},{"id":59,"kind":2,"name":"lib/version","url":"modules/lib_version.html","classes":"tsd-kind-module"},{"id":60,"kind":32,"name":"version","url":"modules/lib_version.html#version","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"lib/version"},{"id":61,"kind":128,"name":"SupabaseClient","url":"classes/index.SupabaseClient.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"index"},{"id":62,"kind":512,"name":"constructor","url":"classes/index.SupabaseClient.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"index.SupabaseClient"},{"id":63,"kind":1024,"name":"auth","url":"classes/index.SupabaseClient.html#auth","classes":"tsd-kind-property tsd-parent-kind-class","parent":"index.SupabaseClient"},{"id":64,"kind":1024,"name":"schema","url":"classes/index.SupabaseClient.html#schema","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":65,"kind":1024,"name":"restUrl","url":"classes/index.SupabaseClient.html#restUrl","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":66,"kind":1024,"name":"realtimeUrl","url":"classes/index.SupabaseClient.html#realtimeUrl","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":67,"kind":1024,"name":"authUrl","url":"classes/index.SupabaseClient.html#authUrl","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":68,"kind":1024,"name":"storageUrl","url":"classes/index.SupabaseClient.html#storageUrl","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":69,"kind":1024,"name":"functionsUrl","url":"classes/index.SupabaseClient.html#functionsUrl","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":70,"kind":1024,"name":"realtime","url":"classes/index.SupabaseClient.html#realtime","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":71,"kind":1024,"name":"multiTab","url":"classes/index.SupabaseClient.html#multiTab","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":72,"kind":1024,"name":"fetch","url":"classes/index.SupabaseClient.html#fetch","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":73,"kind":65536,"name":"__type","url":"classes/index.SupabaseClient.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"index.SupabaseClient"},{"id":74,"kind":1024,"name":"changedAccessToken","url":"classes/index.SupabaseClient.html#changedAccessToken","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":75,"kind":1024,"name":"shouldThrowOnError","url":"classes/index.SupabaseClient.html#shouldThrowOnError","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":76,"kind":1024,"name":"headers","url":"classes/index.SupabaseClient.html#headers","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":77,"kind":65536,"name":"__type","url":"classes/index.SupabaseClient.html#__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"index.SupabaseClient"},{"id":78,"kind":1024,"name":"supabaseUrl","url":"classes/index.SupabaseClient.html#supabaseUrl","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":79,"kind":1024,"name":"supabaseKey","url":"classes/index.SupabaseClient.html#supabaseKey","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-protected","parent":"index.SupabaseClient"},{"id":80,"kind":262144,"name":"functions","url":"classes/index.SupabaseClient.html#functions","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"index.SupabaseClient"},{"id":81,"kind":262144,"name":"storage","url":"classes/index.SupabaseClient.html#storage","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":"index.SupabaseClient"},{"id":82,"kind":2048,"name":"from","url":"classes/index.SupabaseClient.html#from","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"index.SupabaseClient"},{"id":83,"kind":2048,"name":"rpc","url":"classes/index.SupabaseClient.html#rpc","classes":"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter","parent":"index.SupabaseClient"},{"id":84,"kind":2048,"name":"removeAllSubscriptions","url":"classes/index.SupabaseClient.html#removeAllSubscriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"index.SupabaseClient"},{"id":85,"kind":2048,"name":"removeSubscription","url":"classes/index.SupabaseClient.html#removeSubscription","classes":"tsd-kind-method tsd-parent-kind-class","parent":"index.SupabaseClient"},{"id":86,"kind":2048,"name":"_closeSubscription","url":"classes/index.SupabaseClient.html#_closeSubscription","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"index.SupabaseClient"},{"id":87,"kind":2048,"name":"_unsubscribeSubscription","url":"classes/index.SupabaseClient.html#_unsubscribeSubscription","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"index.SupabaseClient"},{"id":88,"kind":2048,"name":"getSubscriptions","url":"classes/index.SupabaseClient.html#getSubscriptions","classes":"tsd-kind-method tsd-parent-kind-class","parent":"index.SupabaseClient"},{"id":89,"kind":2048,"name":"_initSupabaseAuthClient","url":"classes/index.SupabaseClient.html#_initSupabaseAuthClient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"index.SupabaseClient"},{"id":90,"kind":2048,"name":"_initRealtimeClient","url":"classes/index.SupabaseClient.html#_initRealtimeClient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"index.SupabaseClient"},{"id":91,"kind":2048,"name":"_initPostgRESTClient","url":"classes/index.SupabaseClient.html#_initPostgRESTClient","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"index.SupabaseClient"},{"id":92,"kind":2048,"name":"_getAuthHeaders","url":"classes/index.SupabaseClient.html#_getAuthHeaders","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"index.SupabaseClient"},{"id":93,"kind":2048,"name":"_listenForMultiTabEvents","url":"classes/index.SupabaseClient.html#_listenForMultiTabEvents","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"index.SupabaseClient"},{"id":94,"kind":2048,"name":"_listenForAuthEvents","url":"classes/index.SupabaseClient.html#_listenForAuthEvents","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"index.SupabaseClient"},{"id":95,"kind":2048,"name":"_handleTokenChanged","url":"classes/index.SupabaseClient.html#_handleTokenChanged","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"index.SupabaseClient"},{"id":96,"kind":16777216,"name":"SupabaseClientOptions","url":"modules/index.html#SupabaseClientOptions","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":97,"kind":16777216,"name":"SupabaseRealtimePayload","url":"modules/index.html#SupabaseRealtimePayload","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":98,"kind":16777216,"name":"Session","url":"modules/index.html#Session","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"},{"id":99,"kind":16777216,"name":"User","url":"modules/index.html#User","classes":"tsd-kind-reference tsd-parent-kind-module","parent":"index"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,26.212]],["parent/0",[]],["name/1",[1,42.437]],["parent/1",[0,2.523]],["name/2",[2,37.287]],["parent/2",[]],["name/3",[3,42.437]],["parent/3",[2,3.588]],["name/4",[4,33.895]],["parent/4",[5,2.293]],["name/5",[6,42.437]],["parent/5",[5,2.293]],["name/6",[7,42.437]],["parent/6",[5,2.293]],["name/7",[8,42.437]],["parent/7",[5,2.293]],["name/8",[9,42.437]],["parent/8",[5,2.293]],["name/9",[10,42.437]],["parent/9",[5,2.293]],["name/10",[11,37.287]],["parent/10",[5,2.293]],["name/11",[12,22.821]],["parent/11",[5,2.293]],["name/12",[12,22.821]],["parent/12",[5,2.293]],["name/13",[13,37.287]],["parent/13",[]],["name/14",[14,42.437]],["parent/14",[13,3.588]],["name/15",[4,33.895]],["parent/15",[15,2.823]],["name/16",[16,42.437]],["parent/16",[15,2.823]],["name/17",[17,42.437]],["parent/17",[15,2.823]],["name/18",[11,37.287]],["parent/18",[15,2.823]],["name/19",[18,42.437]],["parent/19",[15,2.823]],["name/20",[19,33.895]],["parent/20",[]],["name/21",[20,42.437]],["parent/21",[19,3.262]],["name/22",[12,22.821]],["parent/22",[21,4.084]],["name/23",[22,23.464,23,23.464,24,23.464]],["parent/23",[25,4.084]],["name/24",[26,42.437]],["parent/24",[19,3.262]],["name/25",[27,31.362]],["parent/25",[]],["name/26",[28,42.437]],["parent/26",[27,3.018]],["name/27",[29,42.437]],["parent/27",[27,3.018]],["name/28",[30,42.437]],["parent/28",[27,3.018]],["name/29",[31,26.212]],["parent/29",[]],["name/30",[32,42.437]],["parent/30",[31,2.523]],["name/31",[12,22.821]],["parent/31",[33,3.588]],["name/32",[12,22.821]],["parent/32",[33,3.588]],["name/33",[34,42.437]],["parent/33",[31,2.523]],["name/34",[12,22.821]],["parent/34",[35,4.084]],["name/35",[36,33.895]],["parent/35",[31,2.523]],["name/36",[37,37.287]],["parent/36",[31,2.523]],["name/37",[12,22.821]],["parent/37",[38,4.084]],["name/38",[39,33.895]],["parent/38",[40,2.108]],["name/39",[41,37.287]],["parent/39",[40,2.108]],["name/40",[42,42.437]],["parent/40",[40,2.108]],["name/41",[43,37.287]],["parent/41",[40,2.108]],["name/42",[44,42.437]],["parent/42",[40,2.108]],["name/43",[45,42.437]],["parent/43",[40,2.108]],["name/44",[46,42.437]],["parent/44",[40,2.108]],["name/45",[47,37.287]],["parent/45",[40,2.108]],["name/46",[36,33.895]],["parent/46",[40,2.108]],["name/47",[48,37.287]],["parent/47",[40,2.108]],["name/48",[49,42.437]],["parent/48",[40,2.108]],["name/49",[50,37.287]],["parent/49",[31,2.523]],["name/50",[12,22.821]],["parent/50",[51,4.084]],["name/51",[52,42.437]],["parent/51",[53,2.523]],["name/52",[54,42.437]],["parent/52",[53,2.523]],["name/53",[39,33.895]],["parent/53",[53,2.523]],["name/54",[55,42.437]],["parent/54",[53,2.523]],["name/55",[56,42.437]],["parent/55",[53,2.523]],["name/56",[57,42.437]],["parent/56",[53,2.523]],["name/57",[58,42.437]],["parent/57",[53,2.523]],["name/58",[59,42.437]],["parent/58",[31,2.523]],["name/59",[60,37.287]],["parent/59",[]],["name/60",[61,42.437]],["parent/60",[60,3.588]],["name/61",[62,42.437]],["parent/61",[0,2.523]],["name/62",[4,33.895]],["parent/62",[63,1.042]],["name/63",[64,42.437]],["parent/63",[63,1.042]],["name/64",[39,33.895]],["parent/64",[63,1.042]],["name/65",[65,42.437]],["parent/65",[63,1.042]],["name/66",[66,42.437]],["parent/66",[63,1.042]],["name/67",[67,42.437]],["parent/67",[63,1.042]],["name/68",[68,42.437]],["parent/68",[63,1.042]],["name/69",[69,42.437]],["parent/69",[63,1.042]],["name/70",[47,37.287]],["parent/70",[63,1.042]],["name/71",[43,37.287]],["parent/71",[63,1.042]],["name/72",[36,33.895]],["parent/72",[63,1.042]],["name/73",[12,22.821]],["parent/73",[63,1.042]],["name/74",[70,42.437]],["parent/74",[63,1.042]],["name/75",[48,37.287]],["parent/75",[63,1.042]],["name/76",[41,37.287]],["parent/76",[63,1.042]],["name/77",[12,22.821]],["parent/77",[63,1.042]],["name/78",[71,42.437]],["parent/78",[63,1.042]],["name/79",[72,42.437]],["parent/79",[63,1.042]],["name/80",[73,42.437]],["parent/80",[63,1.042]],["name/81",[74,42.437]],["parent/81",[63,1.042]],["name/82",[75,42.437]],["parent/82",[63,1.042]],["name/83",[76,42.437]],["parent/83",[63,1.042]],["name/84",[77,42.437]],["parent/84",[63,1.042]],["name/85",[78,42.437]],["parent/85",[63,1.042]],["name/86",[79,42.437]],["parent/86",[63,1.042]],["name/87",[80,42.437]],["parent/87",[63,1.042]],["name/88",[81,42.437]],["parent/88",[63,1.042]],["name/89",[82,42.437]],["parent/89",[63,1.042]],["name/90",[83,42.437]],["parent/90",[63,1.042]],["name/91",[84,42.437]],["parent/91",[63,1.042]],["name/92",[85,42.437]],["parent/92",[63,1.042]],["name/93",[86,42.437]],["parent/93",[63,1.042]],["name/94",[87,42.437]],["parent/94",[63,1.042]],["name/95",[88,42.437]],["parent/95",[63,1.042]],["name/96",[37,37.287]],["parent/96",[0,2.523]],["name/97",[50,37.287]],["parent/97",[0,2.523]],["name/98",[89,42.437]],["parent/98",[0,2.523]],["name/99",[90,42.437]],["parent/99",[0,2.523]]],"invertedIndex":[["__type",{"_index":12,"name":{"11":{},"12":{},"22":{},"31":{},"32":{},"34":{},"37":{},"50":{},"73":{},"77":{}},"parent":{}}],["_closesubscription",{"_index":79,"name":{"86":{}},"parent":{}}],["_getauthheaders",{"_index":85,"name":{"92":{}},"parent":{}}],["_handletokenchanged",{"_index":88,"name":{"95":{}},"parent":{}}],["_headers",{"_index":8,"name":{"7":{}},"parent":{}}],["_initpostgrestclient",{"_index":84,"name":{"91":{}},"parent":{}}],["_initrealtimeclient",{"_index":83,"name":{"90":{}},"parent":{}}],["_initsupabaseauthclient",{"_index":82,"name":{"89":{}},"parent":{}}],["_listenforauthevents",{"_index":87,"name":{"94":{}},"parent":{}}],["_listenformultitabevents",{"_index":86,"name":{"93":{}},"parent":{}}],["_realtime",{"_index":7,"name":{"6":{}},"parent":{}}],["_schema",{"_index":9,"name":{"8":{}},"parent":{}}],["_subscription",{"_index":6,"name":{"5":{}},"parent":{}}],["_table",{"_index":10,"name":{"9":{}},"parent":{}}],["_unsubscribesubscription",{"_index":80,"name":{"87":{}},"parent":{}}],["auth",{"_index":64,"name":{"63":{}},"parent":{}}],["authurl",{"_index":67,"name":{"67":{}},"parent":{}}],["autorefreshtoken",{"_index":42,"name":{"40":{}},"parent":{}}],["changedaccesstoken",{"_index":70,"name":{"74":{}},"parent":{}}],["client",{"_index":23,"name":{"23":{}},"parent":{}}],["commit_timestamp",{"_index":52,"name":{"51":{}},"parent":{}}],["constructor",{"_index":4,"name":{"4":{},"15":{},"62":{}},"parent":{}}],["cookieoptions",{"_index":49,"name":{"48":{}},"parent":{}}],["createclient",{"_index":1,"name":{"1":{}},"parent":{}}],["default_headers",{"_index":20,"name":{"21":{}},"parent":{}}],["detectsessioninurl",{"_index":45,"name":{"43":{}},"parent":{}}],["errors",{"_index":58,"name":{"57":{}},"parent":{}}],["eventtype",{"_index":54,"name":{"52":{}},"parent":{}}],["fetch",{"_index":36,"name":{"35":{},"46":{},"72":{}},"parent":{}}],["from",{"_index":75,"name":{"82":{}},"parent":{}}],["functions",{"_index":73,"name":{"80":{}},"parent":{}}],["functionsurl",{"_index":69,"name":{"69":{}},"parent":{}}],["genericobject",{"_index":34,"name":{"33":{}},"parent":{}}],["getpayloadrecords",{"_index":17,"name":{"17":{}},"parent":{}}],["getsubscriptions",{"_index":81,"name":{"88":{}},"parent":{}}],["headers",{"_index":41,"name":{"39":{},"76":{}},"parent":{}}],["index",{"_index":0,"name":{"0":{}},"parent":{"1":{},"61":{},"96":{},"97":{},"98":{},"99":{}}}],["index.supabaseclient",{"_index":63,"name":{},"parent":{"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{}}}],["info",{"_index":24,"name":{"23":{}},"parent":{}}],["isbrowser",{"_index":30,"name":{"28":{}},"parent":{}}],["lib/constants",{"_index":19,"name":{"20":{}},"parent":{"21":{},"24":{}}}],["lib/constants.default_headers",{"_index":21,"name":{},"parent":{"22":{}}}],["lib/constants.default_headers.__type",{"_index":25,"name":{},"parent":{"23":{}}}],["lib/helpers",{"_index":27,"name":{"25":{}},"parent":{"26":{},"27":{},"28":{}}}],["lib/supabasequerybuilder",{"_index":2,"name":{"2":{}},"parent":{"3":{}}}],["lib/supabasequerybuilder.supabasequerybuilder",{"_index":5,"name":{},"parent":{"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{}}}],["lib/supabaserealtimeclient",{"_index":13,"name":{"13":{}},"parent":{"14":{}}}],["lib/supabaserealtimeclient.supabaserealtimeclient",{"_index":15,"name":{},"parent":{"15":{},"16":{},"17":{},"18":{},"19":{}}}],["lib/types",{"_index":31,"name":{"29":{}},"parent":{"30":{},"33":{},"35":{},"36":{},"49":{},"58":{}}}],["lib/types.genericobject",{"_index":35,"name":{},"parent":{"34":{}}}],["lib/types.supabaseauthclientoptions",{"_index":33,"name":{},"parent":{"31":{},"32":{}}}],["lib/types.supabaseclientoptions",{"_index":38,"name":{},"parent":{"37":{}}}],["lib/types.supabaseclientoptions.__type",{"_index":40,"name":{},"parent":{"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{}}}],["lib/types.supabaserealtimepayload",{"_index":51,"name":{},"parent":{"50":{}}}],["lib/types.supabaserealtimepayload.__type",{"_index":53,"name":{},"parent":{"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{}}}],["lib/version",{"_index":60,"name":{"59":{}},"parent":{"60":{}}}],["localstorage",{"_index":46,"name":{"44":{}},"parent":{}}],["multitab",{"_index":43,"name":{"41":{},"71":{}},"parent":{}}],["new",{"_index":56,"name":{"55":{}},"parent":{}}],["old",{"_index":57,"name":{"56":{}},"parent":{}}],["on",{"_index":11,"name":{"10":{},"18":{}},"parent":{}}],["persistsession",{"_index":44,"name":{"42":{}},"parent":{}}],["realtime",{"_index":47,"name":{"45":{},"70":{}},"parent":{}}],["realtimeurl",{"_index":66,"name":{"66":{}},"parent":{}}],["removeallsubscriptions",{"_index":77,"name":{"84":{}},"parent":{}}],["removesubscription",{"_index":78,"name":{"85":{}},"parent":{}}],["resturl",{"_index":65,"name":{"65":{}},"parent":{}}],["rpc",{"_index":76,"name":{"83":{}},"parent":{}}],["schema",{"_index":39,"name":{"38":{},"53":{},"64":{}},"parent":{}}],["session",{"_index":89,"name":{"98":{}},"parent":{}}],["shouldthrowonerror",{"_index":48,"name":{"47":{},"75":{}},"parent":{}}],["storage",{"_index":74,"name":{"81":{}},"parent":{}}],["storage_key",{"_index":26,"name":{"24":{}},"parent":{}}],["storageurl",{"_index":68,"name":{"68":{}},"parent":{}}],["striptrailingslash",{"_index":29,"name":{"27":{}},"parent":{}}],["subscribe",{"_index":18,"name":{"19":{}},"parent":{}}],["subscription",{"_index":16,"name":{"16":{}},"parent":{}}],["supabaseauthclientoptions",{"_index":32,"name":{"30":{}},"parent":{}}],["supabaseclient",{"_index":62,"name":{"61":{}},"parent":{}}],["supabaseclientoptions",{"_index":37,"name":{"36":{},"96":{}},"parent":{}}],["supabaseeventtypes",{"_index":59,"name":{"58":{}},"parent":{}}],["supabasekey",{"_index":72,"name":{"79":{}},"parent":{}}],["supabasequerybuilder",{"_index":3,"name":{"3":{}},"parent":{}}],["supabaserealtimeclient",{"_index":14,"name":{"14":{}},"parent":{}}],["supabaserealtimepayload",{"_index":50,"name":{"49":{},"97":{}},"parent":{}}],["supabaseurl",{"_index":71,"name":{"78":{}},"parent":{}}],["table",{"_index":55,"name":{"54":{}},"parent":{}}],["user",{"_index":90,"name":{"99":{}},"parent":{}}],["uuid",{"_index":28,"name":{"26":{}},"parent":{}}],["version",{"_index":61,"name":{"60":{}},"parent":{}}],["x",{"_index":22,"name":{"23":{}},"parent":{}}]],"pipeline":[]}}' +) diff --git a/v1/assets/style.css b/v1/assets/style.css new file mode 100644 index 00000000..08b63fa0 --- /dev/null +++ b/v1/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/v1/assets/widgets.png b/v1/assets/widgets.png new file mode 100644 index 00000000..c7380532 Binary files /dev/null and b/v1/assets/widgets.png differ diff --git a/v1/assets/widgets@2x.png b/v1/assets/widgets@2x.png new file mode 100644 index 00000000..4bbbd572 Binary files /dev/null and b/v1/assets/widgets@2x.png differ diff --git a/v1/classes/index.GoTrueApi.html b/v1/classes/index.GoTrueApi.html new file mode 100644 index 00000000..8f8a1f78 --- /dev/null +++ b/v1/classes/index.GoTrueApi.html @@ -0,0 +1,4773 @@ + + + + + + GoTrueApi | @supabase/supabase-js + + + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ +
+
+ Menu +
+
+
+
+
+
+ +

Class GoTrueApi

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • GoTrueApi
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ + +
    +
  • + new GoTrueApi(__namedParameters: { cookieOptions?: CookieOptions; fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers?: {}; url: string }): GoTrueApi +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      + __namedParameters: + { cookieOptions?: CookieOptions; fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers?: {}; url: string } +
      +
        +
      • +
        + Optional + cookieOptions?: CookieOptions +
        +
      • +
      • +
        + Optional fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) +
        +
          +
        • +
            +
          • + (input: RequestInfo | URL, init?: RequestInit): Promise<Response> +
          • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              + input: RequestInfo | URL +
              +
            • +
            • +
              + Optional init: + RequestInit +
              +
            • +
            +

            + Returns Promise<Response> +

            +
          • +
          +
        • +
        +
      • +
      • +
        + Optional headers?: {} +
        +
          +
        • +
          + [key: + string]: string +
          +
        • +
        +
      • +
      • +
        + url: string +
        +
      • +
      +
    • +
    +

    + Returns + GoTrueApi +

    +
  • +
+
+
+
+

Properties

+
+ + +
+ _createRequestHeaders: + any +
+ +
+
+

+ Create a temporary object with all configured headers and adds the Authorization + token to be used on request methods +

+
+
+
param jwt
+

A valid, logged-in JWT.

+
+
+
+
+ + +
+ cookieName: + any +
+ +
+
+ + +
+ cookieOptions: + CookieOptions +
+ +
+
+ + +
+ fetch: + ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) +
+ +
+

Type declaration

+
    +
  • +
      +
    • + (input: RequestInfo | URL, init?: RequestInit): Promise<Response> +
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        + input: RequestInfo | URL +
        +
      • +
      • +
        + Optional init: + RequestInit +
        +
      • +
      +

      + Returns Promise<Response> +

      +
    • +
    +
  • +
+
+
+
+ + +
+ headers: + {} +
+ +
+

Type declaration

+
    +
  • +
    + [key: + string]: string +
    +
  • +
+
+
+
+ + +
+ url: + string +
+ +
+
+
+

Methods

+
+ + + +
    +
  • + +
    +
    +

    Creates a new user.

    +
    +
    +

    + This function should only be called on a server. Never expose your + service_role key in the browser. +

    +
    +
    +

    Parameters

    +
      +
    • +
      + attributes: + AdminUserAttributes +
      +
      +
      +

      The data you want to create the user with.

      +
      +
      +
    • +
    +

    + Returns Promise<{ data: null; error: ApiError; user: null } | { data: AuthUser; error: null; user: AuthUser }> +

    +
  • +
+
+
+ + +
    +
  • + deleteAuthCookie(req: any, res: any, options: { redirectTo?: string }): any +
  • +
+
    +
  • + +
    +
    +

    Deletes the Auth Cookies and redirects to the

    +
    +
    +

    Parameters

    +
      +
    • +
      req: any
      +
      +
      +

      The request object.

      +
      +
      +
    • +
    • +
      res: any
      +
      +
      +

      The response object.

      +
      +
      +
    • +
    • +
      + options: { redirectTo?: string } +
      +
      +
      +

      Optionally specify a redirectTo URL in the options.

      +
      +
      +
        +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      +
    • +
    +

    + Returns any +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    Delete a user. Requires a service_role key.

    +
    +
    +

    + This function should only be called on a server. Never expose your + service_role key in the browser. +

    +
    +
    +

    Parameters

    +
      +
    • +
      uid: string
      +
      +
      +

      The user uid you want to remove.

      +
      +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthUser; error: null | ApiError; user: null | AuthUser }> +

    +
  • +
+
+
+ + +
    +
  • + generateLink(type: "signup" | "invite" | "magiclink" | "recovery" | "email_change_current" | "email_change_new", email: string, options?: { data?: object; password?: string; redirectTo?: string }): Promise<{ data: null | AuthSession | AuthUser; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    Generates links to be sent via email or other.

    +
    +
    +

    Parameters

    +
      +
    • +
      + type: "signup" | "invite" | "magiclink" | "recovery" | "email_change_current" | "email_change_new" +
      +
      +
      +

      + The link type ("signup" or "magiclink" or + "recovery" or "invite"). +

      +
      +
      +
    • +
    • +
      email: string
      +
      +
      +

      The user's email.

      +
      +
      +
    • +
    • +
      + Optional options: + { data?: object; password?: string; redirectTo?: string } +
      +
        +
      • +
        + Optional data?: object +
        +
      • +
      • +
        + Optional password?: string +
        +
      • +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthSession | AuthUser; error: null | ApiError }> +

    +
  • +
+
+
+ + +
    +
  • + getAuthCookieString(req: any, res: any): string[] +
  • +
+
    +
  • + +
    +
    +

    + Helper method to generate the Auth Cookie string for you in case you + can't use setAuthCookie. +

    +
    +
    +

    Parameters

    +
      +
    • +
      req: any
      +
      +
      +

      The request object.

      +
      +
      +
    • +
    • +
      res: any
      +
      +
      +

      The response object.

      +
      +
      +
    • +
    +

    + Returns string[] +

    +
    +

    + The Cookie string that needs to be set as the value for the + Set-Cookie header. +

    +
    +
  • +
+
+
+ + +
    +
  • + getUrlForProvider(provider: Provider, options: { queryParams?: {}; redirectTo?: string; scopes?: string }): string +
  • +
+
    +
  • + +
    +
    +

    Generates the relevant login URL for a third-party provider.

    +
    +
    +

    Parameters

    +
      +
    • +
      + provider: + Provider +
      +
      +
      +

      One of the providers supported by GoTrue.

      +
      +
      +
    • +
    • +
      + options: { queryParams?: {}; redirectTo?: string; scopes?: string } +
      +
        +
      • +
        + Optional + queryParams?: {} +
        +
          +
        • +
          + [key: + string]: string +
          +
        • +
        +
      • +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      • +
        + Optional scopes?: string +
        +
      • +
      +
    • +
    +

    + Returns string +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    Gets the current user details.

    +
    +
    +

    + This method is called by the GoTrueClient update where the jwt + is set to this.currentSession.access_token and therefore, acts like getting + the currently authenticated user +

    +
    +
    +

    Parameters

    +
      +
    • +
      jwt: string
      +
      +
      +

      + A valid, logged-in JWT. Typically, the access_token for the + currentSession +

      +
      +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthUser; error: null | ApiError; user: null | AuthUser }> +

    +
  • +
+
+
+ + +
    +
  • + getUserByCookie(req: any, res?: any): Promise<{ data: null | AuthUser; error: null | ApiError; token: null | string; user: null | AuthUser }> +
  • +
+
    +
  • + +
    +
    +

    + Get user by reading the cookie from the request. Works for Next.js & + Express (requires cookie-parser middleware). +

    +
    +
    +

    Parameters

    +
      +
    • +
      req: any
      +
    • +
    • +
      + Optional res: + any +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthUser; error: null | ApiError; token: null | string; user: null | AuthUser }> +

    +
  • +
+
+
+ + +
    +
  • + getUserById(uid: string): Promise<{ data: null; error: ApiError } | { data: AuthUser; error: null }> +
  • +
+
    +
  • + +
    +
    +

    Get user by id.

    +
    +
    +

    Parameters

    +
      +
    • +
      uid: string
      +
      +
      +

      The user's unique identifier

      +

      + This function should only be called on a server. Never expose your + service_role key in the browser. +

      +
      +
      +
    • +
    +

    + Returns Promise<{ data: null; error: ApiError } | { data: AuthUser; error: null }> +

    +
  • +
+
+
+ + +
    +
  • + inviteUserByEmail(email: string, options?: { data?: object; redirectTo?: string }): Promise<{ data: null | AuthUser; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    Sends an invite link to an email address.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: string
      +
      +
      +

      The email address of the user.

      +
      +
      +
    • +
    • +
      + Optional options: + { data?: object; redirectTo?: string } +
      +
        +
      • +
        + Optional data?: object +
        +
      • +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthUser; error: null | ApiError }> +

    +
  • +
+
+
+ + +
    +
  • + listUsers(): Promise<{ data: null; error: ApiError } | { data: AuthUser[]; error: null }> +
  • +
+
    +
  • + +
    +
    +

    Get a list of users.

    +
    +
    +

    + This function should only be called on a server. Never expose your + service_role key in the browser. +

    +
    +
    +

    + Returns Promise<{ data: null; error: ApiError } | { data: AuthUser[]; error: null }> +

    +
  • +
+
+
+ + +
    +
  • + refreshAccessToken(refreshToken: string): Promise<{ data: null | AuthSession; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    Generates a new JWT.

    +
    +
    +

    Parameters

    +
      +
    • +
      refreshToken: string
      +
      +
      +

      A valid refresh token that was returned on login.

      +
      +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthSession; error: null | ApiError }> +

    +
  • +
+
+
+ + +
    +
  • + resetPasswordForEmail(email: string, options?: { captchaToken?: string; redirectTo?: string }): Promise<{ data: null | {}; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    Sends a reset request to an email address.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: string
      +
      +
      +

      The email address of the user.

      +
      +
      +
    • +
    • +
      + Optional options: + { captchaToken?: string; redirectTo?: string } +
      +
        +
      • +
        + Optional + captchaToken?: string +
        +
      • +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | {}; error: null | ApiError }> +

    +
  • +
+
+
+ + +
    +
  • + sendMagicLinkEmail(email: string, options?: { captchaToken?: string; redirectTo?: string; shouldCreateUser?: boolean }): Promise<{ data: null | {}; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    Sends a magic login link to an email address.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: string
      +
      +
      +

      The email address of the user.

      +
      +
      +
    • +
    • +
      + Optional options: + { captchaToken?: string; redirectTo?: string; shouldCreateUser?: boolean } +
      +
        +
      • +
        + Optional + captchaToken?: string +
        +
      • +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      • +
        + Optional + shouldCreateUser?: boolean +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | {}; error: null | ApiError }> +

    +
  • +
+
+
+ + +
    +
  • + sendMobileOTP(phone: string, options?: { captchaToken?: string; shouldCreateUser?: boolean }): Promise<{ data: null | {}; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    + Sends a mobile OTP via SMS. Will register the account if it doesn't + already exist +

    +
    +
    +

    Parameters

    +
      +
    • +
      phone: string
      +
      +
      +

      The user's phone number WITH international prefix

      +
      +
      +
    • +
    • +
      + Optional options: + { captchaToken?: string; shouldCreateUser?: boolean } +
      +
        +
      • +
        + Optional + captchaToken?: string +
        +
      • +
      • +
        + Optional + shouldCreateUser?: boolean +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | {}; error: null | ApiError }> +

    +
  • +
+
+
+ + +
    +
  • + setAuthCookie(req: any, res: any): void +
  • +
+
    +
  • + +
    +
    +

    + Set/delete the auth cookie based on the AuthChangeEvent. Works for Next.js + & Express (requires cookie-parser middleware). +

    +
    +
    +

    Parameters

    +
      +
    • +
      req: any
      +
      +
      +

      The request object.

      +
      +
      +
    • +
    • +
      res: any
      +
      +
      +

      The response object.

      +
      +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + signInWithEmail(email: string, password: string, options?: { captchaToken?: string; redirectTo?: string }): Promise<{ data: null | AuthSession; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    Logs in an existing user using their email address.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: string
      +
      +
      +

      The email address of the user.

      +
      +
      +
    • +
    • +
      password: string
      +
      +
      +

      The password of the user.

      +
      +
      +
    • +
    • +
      + Optional options: + { captchaToken?: string; redirectTo?: string } +
      +
        +
      • +
        + Optional + captchaToken?: string +
        +
      • +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthSession; error: null | ApiError }> +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    Logs in an OpenID Connect user using their id_token.

    +
    +
    +

    Parameters

    + +

    + Returns Promise<{ data: null | AuthSession; error: null | ApiError }> +

    +
  • +
+
+
+ + +
    +
  • + signInWithPhone(phone: string, password: string, options?: { captchaToken?: string }): Promise<{ data: null | AuthSession; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    Logs in an existing user using their phone number and password.

    +
    +
    +

    Parameters

    +
      +
    • +
      phone: string
      +
      +
      +

      The phone number of the user.

      +
      +
      +
    • +
    • +
      password: string
      +
      +
      +

      The password of the user.

      +
      +
      +
    • +
    • +
      + Optional options: + { captchaToken?: string } +
      +
        +
      • +
        + Optional + captchaToken?: string +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthSession; error: null | ApiError }> +

    +
  • +
+
+
+ + +
    +
  • + signOut(jwt: string): Promise<{ error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    Removes a logged-in session.

    +
    +
    +

    Parameters

    +
      +
    • +
      jwt: string
      +
      +
      +

      A valid, logged-in JWT.

      +
      +
      +
    • +
    +

    + Returns Promise<{ error: null | ApiError }> +

    +
  • +
+
+
+ + +
    +
  • + signUpWithEmail(email: string, password: string, options?: { captchaToken?: string; data?: object; redirectTo?: string }): Promise<{ data: null | AuthSession | AuthUser; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    Creates a new user using their email address.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: string
      +
      +
      +

      The email address of the user.

      +
      +
      +
    • +
    • +
      password: string
      +
      +
      +

      The password of the user.

      +
      +
      +
    • +
    • +
      + Optional options: + { captchaToken?: string; data?: object; redirectTo?: string } +
      +
        +
      • +
        + Optional + captchaToken?: string +
        +
      • +
      • +
        + Optional data?: object +
        +
      • +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthSession | AuthUser; error: null | ApiError }> +

    +

    A logged-in session if the server has "autoconfirm" ON

    +
  • +
+
+
+ + +
    +
  • + signUpWithPhone(phone: string, password: string, options?: { captchaToken?: string; data?: object }): Promise<{ data: null | AuthSession | AuthUser; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    Signs up a new user using their phone number and a password.

    +
    +
    +

    Parameters

    +
      +
    • +
      phone: string
      +
      +
      +

      The phone number of the user.

      +
      +
      +
    • +
    • +
      password: string
      +
      +
      +

      The password of the user.

      +
      +
      +
    • +
    • +
      + Optional options: + { captchaToken?: string; data?: object } +
      +
        +
      • +
        + Optional + captchaToken?: string +
        +
      • +
      • +
        + Optional data?: object +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthSession | AuthUser; error: null | ApiError }> +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    Updates the user data.

    +
    +
    +

    Parameters

    +
      +
    • +
      jwt: string
      +
      +
      +

      A valid, logged-in JWT.

      +
      +
      +
    • +
    • +
      + attributes: + UserAttributes +
      +
      +
      +

      The data you want to update.

      +
      +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthUser; error: null | ApiError; user: null | AuthUser }> +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    Updates the user data.

    +
    +
    +

    Parameters

    +
      +
    • +
      uid: string
      +
    • +
    • +
      + attributes: + AdminUserAttributes +
      +
      +
      +

      The data you want to update.

      +

      + This function should only be called on a server. Never expose your + service_role key in the browser. +

      +
      +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthUser; error: null | ApiError; user: null | AuthUser }> +

    +
  • +
+
+
+ + +
    +
  • + verifyMobileOTP(phone: string, token: string, options?: { redirectTo?: string }): Promise<{ data: null | AuthSession | AuthUser; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +
    deprecated
    +
    +

    Use verifyOTP instead!

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      phone: string
      +
      +
      +

      The user's phone number WITH international prefix

      +
      +
      +
    • +
    • +
      token: string
      +
      +
      +

      token that user was sent to their mobile phone

      +
      +
      +
    • +
    • +
      + Optional options: + { redirectTo?: string } +
      +
        +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthSession | AuthUser; error: null | ApiError }> +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    Send User supplied Email / Mobile OTP to be verified

    +
    +
    +

    Parameters

    +
      +
    • +
      + __namedParameters: + VerifyOTPParams +
      +
    • +
    • +
      + Optional options: + { redirectTo?: string } +
      +
        +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthSession | AuthUser; error: null | ApiError }> +

    +
  • +
+
+
+
+ +
+
+ +
+

Generated using TypeDoc

+
+
+ + + diff --git a/v1/classes/index.GoTrueClient.html b/v1/classes/index.GoTrueClient.html new file mode 100644 index 00000000..be39da77 --- /dev/null +++ b/v1/classes/index.GoTrueClient.html @@ -0,0 +1,3700 @@ + + + + + + GoTrueClient | @supabase/supabase-js + + + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ +
+
+ Menu +
+
+
+
+
+
+ +

Class GoTrueClient

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • GoTrueClient
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ + +
    +
  • + new GoTrueClient(options: { autoRefreshToken?: boolean; cookieOptions?: CookieOptions; detectSessionInUrl?: boolean; fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers?: {}; localStorage?: PromisifyMethods<Pick<Storage, "getItem" | "removeItem" | "setItem">>; multiTab?: boolean; persistSession?: boolean; url?: string }): GoTrueClient +
  • +
+
    +
  • + +
    +
    +

    Create a new client for use in the browser.

    +
    +
    +

    Parameters

    +
      +
    • +
      + options: { autoRefreshToken?: boolean; cookieOptions?: CookieOptions; detectSessionInUrl?: boolean; fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers?: {}; localStorage?: PromisifyMethods<Pick<Storage, "getItem" | "removeItem" | "setItem">>; multiTab?: boolean; persistSession?: boolean; url?: string } +
      +
        +
      • +
        + Optional + autoRefreshToken?: boolean +
        +
        +
        +

        + Set to "true" if you want to automatically refresh the + token before expiring. +

        +
        +
        +
      • +
      • +
        + Optional + cookieOptions?: CookieOptions +
        +
      • +
      • +
        + Optional + detectSessionInUrl?: boolean +
        +
        +
        +

        + Set to "true" if you want to automatically detects OAuth + grants in the URL and signs in the user. +

        +
        +
        +
      • +
      • +
        + Optional fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) +
        +
          +
        • +
            +
          • + (input: RequestInfo | URL, init?: RequestInit): Promise<Response> +
          • +
          +
            +
          • +
            +
            +

            A custom fetch implementation.

            +
            +
            +

            Parameters

            +
              +
            • +
              + input: RequestInfo | URL +
              +
            • +
            • +
              + Optional init: + RequestInit +
              +
            • +
            +

            + Returns Promise<Response> +

            +
          • +
          +
        • +
        +
      • +
      • +
        + Optional headers?: {} +
        +
        +
        +

        Any additional headers to send to the GoTrue server.

        +
        +
        +
          +
        • +
          + [key: + string]: string +
          +
        • +
        +
      • +
      • +
        + Optional + localStorage?: PromisifyMethods<Pick<Storage, "getItem" | "removeItem" | "setItem">> +
        +
        +
        +

        + Provide your own local storage implementation to use instead of the + browser's local storage. +

        +
        +
        +
      • +
      • +
        + Optional + multiTab?: boolean +
        +
        +
        +

        + Set to "false" if you want to disable multi-tab/window + events. +

        +
        +
        +
      • +
      • +
        + Optional + persistSession?: boolean +
        +
        +
        +

        + Set to "true" if you want to automatically save the user + session into local storage. +

        +
        +
        +
      • +
      • +
        + Optional url?: string +
        +
        +
        +

        The URL of the GoTrue server.

        +
        +
        +
      • +
      +
    • +
    +

    + Returns + GoTrueClient +

    +
  • +
+
+
+
+

Properties

+
+ + +
+ _callRefreshToken: + any +
+ +
+
+ + +
+ _handleEmailSignIn: + any +
+ +
+
+ + +
+ _handleOpenIDConnectSignIn: + any +
+ +
+
+ + +
+ _handlePhoneSignIn: + any +
+ +
+
+ + +
+ _handleProviderSignIn: + any +
+ +
+
+ + +
+ _handleVisibilityChange: + any +
+ +
+
+ + +
+ _listenForMultiTabEvents: + any +
+ +
+
+

Listens for changes to LocalStorage and updates the current session.

+
+
+
+
+ + +
+ _notifyAllSubscribers: + any +
+ +
+
+ + +
+ _persistSession: + any +
+ +
+
+ + +
+ _recoverAndRefresh: + any +
+ +
+
+

+ Recovers the session from LocalStorage and refreshes Note: this method is async + to accommodate for AsyncStorage e.g. in React native. +

+
+
+
+
+ + +
+ _recoverSession: + any +
+ +
+
+

+ Attempts to get the session from LocalStorage Note: this should never be async + (even for React Native), as we need it to return immediately in the constructor. +

+
+
+
+
+ + +
+ _removeSession: + any +
+ +
+
+ + +
+ _saveSession: + any +
+ +
+
+

+ set currentSession and currentUser process to _startAutoRefreshToken if possible +

+
+
+
+
+ + +
+ _startAutoRefreshToken: + any +
+ +
+
+

Clear and re-create refresh token timer

+
+
+
param value
+

time intervals in milliseconds

+
+
+
+
+ + +
+ api: + GoTrueApi +
+ +
+
+

+ Namespace for the GoTrue API methods. These can be used for example to get a + user from a JWT in a server environment or reset a user's password. +

+
+
+
+
+ + +
+ autoRefreshToken: + boolean +
+ +
+
+ + +
+ currentSession: + null | AuthSession +
+ +
+
+

The session object for the currently logged in user or null.

+
+
+
+
+ + +
+ currentUser: + null | AuthUser +
+ +
+
+

The currently logged in user or null.

+
+
+
+
+ + +
+ localStorage: + PromisifyMethods<Pick<Storage, "getItem" | "removeItem" | "setItem">> +
+ +
+
+ + +
+ multiTab: + boolean +
+ +
+
+ + +
+ networkRetries: + number +
+ +
+
+ + +
+ persistSession: + boolean +
+ +
+
+ + +
+ refreshTokenTimer?: + Timeout +
+ +
+
+ + +
+ stateChangeEmitters: + Map<string, Subscription> +
+ +
+
+
+

Methods

+
+ + +
    +
  • + getSessionFromUrl(options?: { storeSession?: boolean }): Promise<{ data: null | AuthSession; error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    Gets the session data from a URL string

    +
    +
    +

    Parameters

    +
      +
    • +
      + Optional options: + { storeSession?: boolean } +
      +
        +
      • +
        + Optional + storeSession?: boolean +
        +
        +
        +

        Optionally store the session in the browser

        +
        +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ data: null | AuthSession; error: null | ApiError }> +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    Receive a notification every time an auth event happens.

    +
    +
    +

    Parameters

    + +

    + Returns { data: null | Subscription; error: null | ApiError } +

    +

    A subscription object which can be used to unsubscribe itself.

    + +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    + Force refreshes the session including the user data in case it was updated + in a different session. +

    +
    +
    +

    + Returns Promise<{ data: null | AuthSession; error: null | ApiError; user: null | AuthUser }> +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    Returns the session data, if there is an active session.

    +
    +
    +

    + Returns null | AuthSession +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    + Overrides the JWT on the current client. The JWT will then be sent in all + subsequent network requests. +

    +
    +
    +

    Parameters

    +
      +
    • +
      access_token: string
      +
      +
      +

      a jwt access token

      +
      +
      +
    • +
    +

    + Returns + AuthSession +

    +
  • +
+
+
+ + +
    +
  • + setSession(refresh_token: string): Promise<{ error: null | ApiError; session: null | AuthSession }> +
  • +
+
    +
  • + +
    +
    +

    + Sets the session data from refresh_token and returns current Session and + Error +

    +
    +
    +

    Parameters

    +
      +
    • +
      refresh_token: string
      +
      +
      +

      a JWT token

      +
      +
      +
    • +
    +

    + Returns Promise<{ error: null | ApiError; session: null | AuthSession }> +

    +
  • +
+
+
+ + +
    +
  • + signIn(__namedParameters: UserCredentials, options?: { captchaToken?: string; queryParams?: {}; redirectTo?: string; scopes?: string; shouldCreateUser?: boolean }): Promise<{ error: null | ApiError; provider?: Provider; session: null | AuthSession; url?: null | string; user: null | AuthUser }> +
  • +
+
    +
  • + +
    +
    +

    Log in an existing user, or login via a third-party provider.

    +
    +
    +

    Parameters

    +
      +
    • +
      + __namedParameters: + UserCredentials +
      +
    • +
    • +
      + Optional options: + { captchaToken?: string; queryParams?: {}; redirectTo?: string; scopes?: string; shouldCreateUser?: boolean } +
      +
        +
      • +
        + Optional + captchaToken?: string +
        +
      • +
      • +
        + Optional + queryParams?: {} +
        +
          +
        • +
          + [key: + string]: string +
          +
        • +
        +
      • +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      • +
        + Optional scopes?: string +
        +
      • +
      • +
        + Optional + shouldCreateUser?: boolean +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ error: null | ApiError; provider?: Provider; session: null | AuthSession; url?: null | string; user: null | AuthUser }> +

    +
  • +
+
+
+ + +
    +
  • + signOut(): Promise<{ error: null | ApiError }> +
  • +
+
    +
  • + +
    +
    +

    + Inside a browser context, signOut() will remove the logged in + user from the browser session and log them out - removing all items from + localstorage and then trigger a "SIGNED_OUT" event. +

    +
    +
    +

    + For server-side management, you can revoke all refresh tokens for a user by + passing a user's JWT through to + auth.api.signOut(JWT: string). There is no way to revoke a + user's session JWT before it automatically expires +

    +
    +
    +

    + Returns Promise<{ error: null | ApiError }> +

    +
  • +
+
+
+ + +
    +
  • + signUp(__namedParameters: UserCredentials, options?: { captchaToken?: string; data?: object; redirectTo?: string }): Promise<{ error: null | ApiError; session: null | AuthSession; user: null | AuthUser }> +
  • +
+
    +
  • + +
    +
    +

    Creates a new user.

    +
    +
    +

    Parameters

    +
      +
    • +
      + __namedParameters: + UserCredentials +
      +
    • +
    • +
      + Optional options: + { captchaToken?: string; data?: object; redirectTo?: string } +
      +
        +
      • +
        + Optional + captchaToken?: string +
        +
      • +
      • +
        + Optional data?: object +
        +
      • +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ error: null | ApiError; session: null | AuthSession; user: null | AuthUser }> +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    Updates user data, if there is a logged in user.

    +
    +
    +

    Parameters

    + +

    + Returns Promise<{ data: null | AuthUser; error: null | ApiError; user: null | AuthUser }> +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    + Inside a browser context, user() will return the user data, if + there is a logged in user. +

    +
    +
    +

    + For server-side management, you can get a user through + auth.api.getUserByCookie() +

    +
    +
    +

    + Returns null | AuthUser +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    Log in a user given a User supplied OTP received via mobile.

    +
    +
    +

    Parameters

    +
      +
    • +
      + params: + VerifyOTPParams +
      +
    • +
    • +
      + Optional options: + { redirectTo?: string } +
      +
        +
      • +
        + Optional + redirectTo?: string +
        +
      • +
      +
    • +
    +

    + Returns Promise<{ error: null | ApiError; session: null | AuthSession; user: null | AuthUser }> +

    +
  • +
+
+
+
+ +
+
+ +
+

Generated using TypeDoc

+
+
+ + + diff --git a/v1/classes/index.RealtimeClient.html b/v1/classes/index.RealtimeClient.html new file mode 100644 index 00000000..a945126f --- /dev/null +++ b/v1/classes/index.RealtimeClient.html @@ -0,0 +1,2947 @@ + + + + + + RealtimeClient | @supabase/supabase-js + + + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ +
+
+ Menu +
+
+
+
+
+
+ +

Class RealtimeClient

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • RealtimeClient
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ + + +
    +
  • + +
    +
    +

    Initializes the Socket.

    +
    +
    +

    Parameters

    +
      +
    • +
      endPoint: string
      +
      +
      +

      + The string WebSocket endpoint, ie, "ws://example.com/socket", + "wss://example.com", "/socket" (inherited host & + protocol) +

      +
      +
      +
    • +
    • +
      + Optional options: + RealtimeClientOptions +
      +
    • +
    +

    + Returns + RealtimeClient +

    +
  • +
+
+
+
+

Properties

+
+ + +
+ _appendParams: + any +
+ +
+
+ + +
+ _flushSendBuffer: + any +
+ +
+
+ + +
+ _onConnClose: + any +
+ +
+
+ + +
+ _onConnError: + any +
+ +
+
+ + +
+ _onConnOpen: + any +
+ +
+
+ + +
+ _sendHeartbeat: + any +
+ +
+
+ + +
+ _triggerChanError: + any +
+ +
+
+ + +
+ accessToken: + null | string +
+ +
+
+ + +
+ channels: + RealtimeSubscription[] +
+ +
+
+ + +
+ conn: + null | WebSocket +
+ +
+
+ + +
+ decode: + Function +
+ +
+
+ + +
+ encode: + Function +
+ +
+
+ + +
+ endPoint: + string +
+ +
+
+ + +
+ headers?: + {} +
+ +
+

Type declaration

+
    +
  • +
    + [key: + string]: string +
    +
  • +
+
+
+
+ + +
+ heartbeatIntervalMs: + number +
+ +
+
+ + +
+ heartbeatTimer: + undefined | Timer +
+ +
+
+ + +
+ logger: + Function +
+ +
+
+ + +
+ longpollerTimeout: + number +
+ +
+
+ + +
+ params?: + {} +
+ +
+

Type declaration

+
    +
  • +
    + [key: + string]: string +
    +
  • +
+
+
+
+ + +
+ pendingHeartbeatRef: + null | string +
+ +
+
+ + +
+ reconnectAfterMs: + Function +
+ +
+
+ + +
+ reconnectTimer: + default +
+ +
+
+ + +
+ ref: + number +
+ +
+
+ + +
+ sendBuffer: + Function[] +
+ +
+
+ + +
+ serializer: + default +
+ +
+
+ + +
+ stateChangeCallbacks: + { close: Function[]; error: Function[]; message: Function[]; open: Function[] } +
+ +
+

Type declaration

+
    +
  • +
    + close: Function[] +
    +
  • +
  • +
    + error: Function[] +
    +
  • +
  • +
    + message: Function[] +
    +
  • +
  • +
    + open: Function[] +
    +
  • +
+
+
+
+ + +
+ timeout: + number +
+ +
+
+ + +
+ transport: + any +
+ +
+
+
+

Methods

+
+ + + +
    +
  • + +

    Parameters

    +
      +
    • +
      topic: string
      +
    • +
    • +
      + Optional chanParams: + ChannelParams +
      +
    • +
    +

    + Returns + RealtimeSubscription +

    +
  • +
+
+
+ + +
    +
  • + connect(): void +
  • +
+
    +
  • + +
    +
    +

    Connects the socket, unless already connected.

    +
    +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + connectionState(): CONNECTION_STATE +
  • +
+
    +
  • + +
    +
    +

    Returns the current state of the socket.

    +
    +
    +

    + Returns CONNECTION_STATE +

    +
  • +
+
+
+ + +
    +
  • + disconnect(code?: number, reason?: string): Promise<{ data: boolean; error: null | Error }> +
  • +
+
    +
  • + +
    +
    +

    Disconnects the socket.

    +
    +
    +

    Parameters

    +
      +
    • +
      + Optional code: + number +
      +
      +
      +

      A numeric status code to send on disconnect.

      +
      +
      +
    • +
    • +
      + Optional reason: + string +
      +
      +
      +

      A custom reason for the disconnect.

      +
      +
      +
    • +
    +

    + Returns Promise<{ data: boolean; error: null | Error }> +

    +
  • +
+
+
+ + +
    +
  • + endPointURL(): string +
  • +
+
    +
  • + +
    +
    +

    Returns the URL of the websocket.

    +
    +
    +

    + Returns string +

    +
  • +
+
+
+ + +
    +
  • + isConnected(): boolean +
  • +
+
    +
  • + +
    +
    +

    Retuns true is the connection is open.

    +
    +
    +

    + Returns boolean +

    +
  • +
+
+
+ + +
    +
  • + leaveOpenTopic(topic: string): void +
  • +
+
    +
  • + +
    +
    +

    Unsubscribe from channels with the specified topic.

    +
    +
    +

    Parameters

    +
      +
    • +
      topic: string
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + log(kind: string, msg: string, data?: any): void +
  • +
+
    +
  • + +
    +
    +

    Logs the message.

    +
    +
    +

    For customized logging, this.logger can be overriden.

    +
    +
    +

    Parameters

    +
      +
    • +
      kind: string
      +
    • +
    • +
      msg: string
      +
    • +
    • +
      + Optional data: + any +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + makeRef(): string +
  • +
+
    +
  • + +
    +
    +

    Return the next message ref, accounting for overflows

    +
    +
    +

    + Returns string +

    +
  • +
+
+
+ + +
    +
  • + onClose(callback: Function): void +
  • +
+
    +
  • + +
    +
    +

    Registers a callback for connection state change events.

    +
    +
    +
    example
    +
    +

    socket.onOpen(() => console.log("Socket closed."))

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      callback: Function
      +
      +
      +

      A function to be called when the event occurs.

      +
      +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + onConnMessage(rawMessage: { data: any }): void +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      + rawMessage: { data: any } +
      +
        +
      • +
        + data: any +
        +
      • +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + onError(callback: Function): void +
  • +
+
    +
  • + +
    +
    +

    Registers a callback for connection state change events.

    +
    +
    +
    example
    +
    +

    + socket.onOpen((error) => console.log("An error occurred")) +

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      callback: Function
      +
      +
      +

      A function to be called when the event occurs.

      +
      +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + onMessage(callback: Function): void +
  • +
+
    +
  • + +
    +
    +

    Calls a function any time a message is received.

    +
    +
    +
    example
    +

    socket.onMessage((message) => console.log(message))

    +
    +
    +

    Parameters

    +
      +
    • +
      callback: Function
      +
      +
      +

      A function to be called when the event occurs.

      +
      +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + onOpen(callback: Function): void +
  • +
+
    +
  • + +
    +
    +

    Registers a callback for connection state change event.

    +
    +
    +
    example
    +
    +

    socket.onOpen(() => console.log("Socket opened."))

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      callback: Function
      +
      +
      +

      A function to be called when the event occurs.

      +
      +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + push(data: Message): void +
  • +
+
    +
  • + +
    +
    +

    Push out a message if the socket is connected.

    +
    +
    +

    + If the socket is not connected, the message gets enqueued within a local + buffer, and sent out when a connection is next established. +

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Message
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    Removes a subscription from the socket.

    +
    +
    +

    Parameters

    + +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + setAuth(token: null | string): void +
  • +
+
    +
  • + +
    +
    +

    + Sets the JWT access token used for channel subscription authorization and + Realtime RLS. +

    +
    +
    +

    Parameters

    +
      +
    • +
      + token: null | string +
      +
      +
      +

      A JWT string.

      +
      +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+
+ +
+
+ +
+

Generated using TypeDoc

+
+
+ + + diff --git a/v1/classes/index.RealtimeSubscription.html b/v1/classes/index.RealtimeSubscription.html new file mode 100644 index 00000000..99a668c5 --- /dev/null +++ b/v1/classes/index.RealtimeSubscription.html @@ -0,0 +1,2141 @@ + + + + + + RealtimeSubscription | @supabase/supabase-js + + + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ +
+
+ Menu +
+
+
+
+
+
+ +

Class RealtimeSubscription

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • RealtimeSubscription
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ + + +
    +
  • + +

    Parameters

    +
      +
    • +
      topic: string
      +
    • +
    • +
      params: {}
      +
        +
      • +
        + [key: + string]: unknown +
        +
      • +
      +
    • +
    • +
      + socket: + RealtimeClient +
      +
    • +
    +

    + Returns + RealtimeSubscription +

    +
  • +
+
+
+
+

Properties

+
+ + +
+ bindings: + any[] +
+ +
+
+ + +
+ joinPush: + default +
+ +
+
+ + +
+ joinedOnce: + boolean +
+ +
+
+ + +
+ params: + {} +
+ +
+

Type declaration

+
    +
  • +
    + [key: + string]: unknown +
    +
  • +
+
+
+
+ + +
+ pushBuffer: + default[] +
+ +
+
+ + +
+ rejoinTimer: + default +
+ +
+
+ + +
+ socket: + RealtimeClient +
+ +
+
+ + +
+ state: + CHANNEL_STATES +
+ +
+
+ + +
+ timeout: + number +
+ +
+
+ + +
+ topic: + string +
+ +
+
+
+

Methods

+
+ + +
    +
  • + canPush(): boolean +
  • +
+
    +
  • + +

    + Returns boolean +

    +
  • +
+
+
+ + +
    +
  • + isClosed(): boolean +
  • +
+
    +
  • + +

    + Returns boolean +

    +
  • +
+
+
+ + +
    +
  • + isErrored(): boolean +
  • +
+
    +
  • + +

    + Returns boolean +

    +
  • +
+
+
+ + +
    +
  • + isJoined(): boolean +
  • +
+
    +
  • + +

    + Returns boolean +

    +
  • +
+
+
+ + +
    +
  • + isJoining(): boolean +
  • +
+
    +
  • + +

    + Returns boolean +

    +
  • +
+
+
+ + +
    +
  • + isLeaving(): boolean +
  • +
+
    +
  • + +

    + Returns boolean +

    +
  • +
+
+
+ + +
    +
  • + isMember(topic: string): boolean +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      topic: string
      +
    • +
    +

    + Returns boolean +

    +
  • +
+
+
+ + +
    +
  • + joinRef(): string +
  • +
+
    +
  • + +

    + Returns string +

    +
  • +
+
+
+ + +
    +
  • + off(event: string): void +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      event: string
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + on(event: string, callback: Function): void +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      event: string
      +
    • +
    • +
      callback: Function
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + onClose(callback: Function): void +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      callback: Function
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + onError(callback: Function): void +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      callback: Function
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + onMessage(event: string, payload: any, ref?: string): any +
  • +
+
    +
  • + +
    +
    +

    Overridable message hook

    +
    +
    +

    + Receives all events for specialized message handling before dispatching to + the channel callbacks. Must return the payload, modified or unmodified. +

    +
    +
    +

    Parameters

    +
      +
    • +
      event: string
      +
    • +
    • +
      payload: any
      +
    • +
    • +
      + Optional ref: + string +
      +
    • +
    +

    + Returns any +

    +
  • +
+
+
+ + +
    +
  • + push(event: CHANNEL_EVENTS, payload: any, timeout?: number): default +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      event: CHANNEL_EVENTS
      +
    • +
    • +
      payload: any
      +
    • +
    • +
      + Optional timeout: + number +
      +
    • +
    +

    + Returns default +

    +
  • +
+
+
+ + +
    +
  • + rejoin(timeout?: number): void +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      + Optional timeout: + number +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + rejoinUntilConnected(): void +
  • +
+
    +
  • + +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + replyEventName(ref: string): string +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      ref: string
      +
    • +
    +

    + Returns string +

    +
  • +
+
+
+ + +
    +
  • + subscribe(timeout?: number): default +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      + Optional timeout: + number +
      +
    • +
    +

    + Returns default +

    +
  • +
+
+
+ + +
    +
  • + trigger(event: string, payload?: any, ref?: string): void +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      event: string
      +
    • +
    • +
      + Optional payload: + any +
      +
    • +
    • +
      + Optional ref: + string +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + unsubscribe(timeout?: number): default +
  • +
+
    +
  • + +
    +
    +

    Leaves the channel

    +
    +
    +

    + Unsubscribes from server events, and instructs channel to terminate on + server. Triggers onClose() hooks. +

    +

    + To receive leave acknowledgements, use the a receive hook to + bind to the server ack, ie: channel.unsubscribe().receive("ok", () + => alert("left!") ) +

    +
    +
    +

    Parameters

    +
      +
    • +
      + Optional timeout: + number +
      +
    • +
    +

    + Returns default +

    +
  • +
+
+
+ + +
    +
  • + updateJoinPayload(payload: {}): void +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      payload: {}
      +
        +
      • +
        + [key: + string]: unknown +
        +
      • +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+
+ +
+
+ +
+

Generated using TypeDoc

+
+
+ + + diff --git a/v1/classes/index.SupabaseClient.html b/v1/classes/index.SupabaseClient.html new file mode 100644 index 00000000..6f236dd6 --- /dev/null +++ b/v1/classes/index.SupabaseClient.html @@ -0,0 +1,2619 @@ + + + + + + SupabaseClient | @supabase/supabase-js + + + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ +
+
+ Menu +
+
+
+
+
+
+ +

Class SupabaseClient

+
+
+
+
+
+
+
+
+
+

Supabase Client.

+
+

An isomorphic Javascript client for interacting with Postgres.

+
+
+
+

Hierarchy

+
    +
  • SupabaseClient
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ + + +
    +
  • + +
    +
    +

    Create a new client for use in the browser.

    +
    +
    +

    Parameters

    +
      +
    • +
      supabaseUrl: string
      +
      +
      +

      + The unique Supabase URL which is supplied when you create a new project + in your project dashboard. +

      +
      +
      +
    • +
    • +
      supabaseKey: string
      +
      +
      +

      + The unique Supabase Key which is supplied when you create a new project + in your project dashboard. +

      +
      +
      +
    • +
    • +
      + Optional options: + SupabaseClientOptions +
      +
    • +
    +

    + Returns + SupabaseClient +

    +
  • +
+
+
+
+

Properties

+
+ + +
+ auth: + SupabaseAuthClient +
+ +
+
+

+ Supabase Auth allows you to create and manage user sessions for access to data + that is secured by access policies. +

+
+
+
+
+ + +
+ authUrl: + string +
+ +
+
+ + +
+ changedAccessToken: + undefined | string +
+ +
+
+ + +
+ fetch?: + ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) +
+ +
+

Type declaration

+
    +
  • +
      +
    • + (input: RequestInfo | URL, init?: RequestInit): Promise<Response> +
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        + input: RequestInfo | URL +
        +
      • +
      • +
        + Optional init: + RequestInit +
        +
      • +
      +

      + Returns Promise<Response> +

      +
    • +
    +
  • +
+
+
+
+ + +
+ functionsUrl: + string +
+ +
+
+ + +
+ headers: + {} +
+ +
+

Type declaration

+
    +
  • +
    + [key: + string]: string +
    +
  • +
+
+
+
+ + +
+ multiTab: + boolean +
+ +
+
+ + +
+ realtime: + RealtimeClient +
+ +
+
+ + +
+ realtimeUrl: + string +
+ +
+
+ + +
+ restUrl: + string +
+ +
+
+ + +
+ schema: + string +
+ +
+
+ + +
+ shouldThrowOnError: + boolean +
+ +
+
+ + +
+ storageUrl: + string +
+ +
+
+ + +
+ supabaseKey: + string +
+
+
+ + +
+ supabaseUrl: + string +
+
+
+
+

Accessors

+
+ + +
    +
  • + get functions(): FunctionsClient +
  • +
+
    +
  • + +
    +
    +

    Supabase Functions allows you to deploy and invoke edge functions.

    +
    +
    +

    + Returns FunctionsClient +

    +
  • +
+
+
+ + +
    +
  • + get storage(): StorageClient +
  • +
+
    +
  • + +
    +
    +

    + Supabase Storage allows you to manage user-generated content, such as photos + or videos. +

    +
    +
    +

    + Returns StorageClient +

    +
  • +
+
+
+
+

Methods

+
+ + + + +
+
+ + + + +
+
+ + +
    +
  • + _handleTokenChanged(event: AuthChangeEvent, token: undefined | string, source: "CLIENT" | "STORAGE"): void +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      + event: + AuthChangeEvent +
      +
    • +
    • +
      + token: undefined | string +
      +
    • +
    • +
      + source: "CLIENT" | "STORAGE" +
      +
    • +
    +

    + Returns void +

    +
  • +
+
+
+ + +
    +
  • + _initPostgRESTClient(): default +
  • +
+ +
+
+ + + + +
+
+ + + + +
+
+ + + + +
+
+ + +
    +
  • + _listenForMultiTabEvents(): null | void +
  • +
+ +
+
+ + +
    +
  • + _unsubscribeSubscription(subscription: RealtimeSubscription): Promise<{ error: null | Error }> +
  • +
+ +
+
+ + + +
    +
  • + +
    +
    +

    Perform a table operation.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = any

      +
    • +
    +

    Parameters

    +
      +
    • +
      table: string
      +
      +
      +

      The table name to operate on.

      +
      +
      +
    • +
    +

    + Returns + SupabaseQueryBuilder<T> +

    +
  • +
+
+
+ + + + +
+
+ + +
    +
  • + removeAllSubscriptions(): Promise<{ data: { subscription: RealtimeSubscription }; error: null | Error }[]> +
  • +
+
    +
  • + +
    +
    +

    + Closes and removes all subscriptions and returns a list of removed + subscriptions and their errors. +

    +
    +
    +

    + Returns Promise<{ data: { subscription: RealtimeSubscription }; error: null | Error }[]> +

    +
  • +
+
+
+ + +
    +
  • + removeSubscription(subscription: RealtimeSubscription): Promise<{ data: { openSubscriptions: number }; error: null | Error }> +
  • +
+
    +
  • + +
    +
    +

    + Closes and removes a subscription and returns the number of open + subscriptions. +

    +
    +
    +

    Parameters

    +
      +
    • +
      + subscription: + RealtimeSubscription +
      +
      +
      +

      The subscription you want to close and remove.

      +
      +
      +
    • +
    +

    + Returns Promise<{ data: { openSubscriptions: number }; error: null | Error }> +

    +
  • +
+
+
+ + +
    +
  • + rpc<T>(fn: string, params?: object, __namedParameters?: { count?: null | "exact" | "planned" | "estimated"; head?: boolean }): default<T> +
  • +
+
    +
  • + +
    +
    +

    Perform a function call.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = any

      +
    • +
    +

    Parameters

    +
      +
    • +
      fn: string
      +
      +
      +

      The function name to call.

      +
      +
      +
    • +
    • +
      + Optional params: + object +
      +
      +
      +

      The parameters to pass to the function call.

      +
      +
      +
    • +
    • +
      + __namedParameters: { count?: null | "exact" | "planned" | "estimated"; head?: boolean } = {} +
      +
        +
      • +
        + Optional count?: null | "exact" | "planned" | "estimated" +
        +
      • +
      • +
        + Optional head?: boolean +
        +
      • +
      +
    • +
    +

    + Returns default<T> +

    +
  • +
+
+
+
+ +
+
+ +
+

Generated using TypeDoc

+
+
+ + + diff --git a/v1/classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html b/v1/classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html new file mode 100644 index 00000000..55a3d826 --- /dev/null +++ b/v1/classes/lib_SupabaseQueryBuilder.SupabaseQueryBuilder.html @@ -0,0 +1,2937 @@ + + + + + + SupabaseQueryBuilder | @supabase/supabase-js + + + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ +
+
+ Menu +
+
+
+
+
+
+ +

Class SupabaseQueryBuilder<T>

+
+
+
+
+
+
+
+

Type Parameters

+
    +
  • T

  • +
+
+
+

Hierarchy

+
    +
  • + default<T> +
      +
    • SupabaseQueryBuilder
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ + +
    +
  • + new SupabaseQueryBuilder<T>(url: string, __namedParameters: { fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers?: GenericObject; realtime: RealtimeClient; schema: string; shouldThrowOnError?: boolean; table: string }): SupabaseQueryBuilder<T> +
  • +
+
    +
  • + +

    Type Parameters

    +
      +
    • T

    • +
    +

    Parameters

    +
      +
    • +
      url: string
      +
    • +
    • +
      + __namedParameters: { fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers?: GenericObject; realtime: RealtimeClient; schema: string; shouldThrowOnError?: boolean; table: string } +
      +
        +
      • +
        + Optional fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) +
        +
          +
        • +
            +
          • + (input: RequestInfo | URL, init?: RequestInit): Promise<Response> +
          • +
          +
            +
          • +

            Parameters

            +
              +
            • +
              + input: RequestInfo | URL +
              +
            • +
            • +
              + Optional init: + RequestInit +
              +
            • +
            +

            + Returns Promise<Response> +

            +
          • +
          +
        • +
        +
      • +
      • +
        + Optional headers?: GenericObject +
        +
      • +
      • +
        + realtime: RealtimeClient +
        +
      • +
      • +
        + schema: string +
        +
      • +
      • +
        + Optional + shouldThrowOnError?: boolean +
        +
      • +
      • +
        + table: string +
        +
      • +
      +
    • +
    +

    + Returns + SupabaseQueryBuilder<T> +

    +
  • +
+
+
+
+

Properties

+
+ + +
+ _headers: + GenericObject +
+ +
+
+ + +
+ _realtime: + RealtimeClient +
+ +
+
+ + +
+ _schema: + string +
+ +
+
+ + +
+ _subscription: + null | SupabaseRealtimeClient = null +
+ +
+
+ + +
+ _table: + string +
+ +
+
+ + +
+ allowEmpty: + boolean +
+ +
+
+ + +
+ body?: + Partial<T> | Partial<T>[] +
+ +
+
+ + +
+ fetch: + ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) +
+ +
+

Type declaration

+
    +
  • +
      +
    • + (input: RequestInfo | URL, init?: RequestInit): Promise<Response> +
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        + input: RequestInfo | URL +
        +
      • +
      • +
        + Optional init: + RequestInit +
        +
      • +
      +

      + Returns Promise<Response> +

      +
    • +
    +
  • +
+
+
+
+ + +
+ headers: + {} +
+ +
+

Type declaration

+
    +
  • +
    + [key: + string]: string +
    +
  • +
+
+
+
+ + +
+ method: + "GET" | "POST" | "PATCH" | "DELETE" | "HEAD" +
+ +
+
+ + +
+ schema?: + string +
+ +
+
+ + +
+ shouldThrowOnError: + boolean +
+ +
+
+ + +
+ signal?: + AbortSignal +
+ +
+
+ + +
+ url: + URL +
+ +
+
+
+

Methods

+
+ + +
    +
  • + delete(__namedParameters?: { count?: null | "exact" | "planned" | "estimated"; returning?: "minimal" | "representation" }): default<T> +
  • +
+
    +
  • + +
    +
    +

    Performs a DELETE on the table.

    +
    +
    +

    Parameters

    +
      +
    • +
      + Optional __namedParameters: + { count?: null | "exact" | "planned" | "estimated"; returning?: "minimal" | "representation" } +
      +
        +
      • +
        + Optional count?: null | "exact" | "planned" | "estimated" +
        +
      • +
      • +
        + Optional returning?: "minimal" | "representation" +
        +
      • +
      +
    • +
    +

    + Returns default<T> +

    +
  • +
+
+
+ + +
    +
  • + insert(values: Partial<T> | Partial<T>[], options?: { count?: null | "exact" | "planned" | "estimated"; returning?: "minimal" | "representation" }): default<T> +
  • +
  • + insert(values: Partial<T> | Partial<T>[], options?: { count?: null | "exact" | "planned" | "estimated"; onConflict?: string; returning?: "minimal" | "representation"; upsert?: boolean }): default<T> +
  • +
+
    +
  • + +
    +
    +

    Performs an INSERT into the table.

    +
    +
    +

    Parameters

    +
      +
    • +
      + values: Partial<T> | Partial<T>[] +
      +
      +
      +

      The values to insert.

      +
      +
      +
    • +
    • +
      + Optional options: + { count?: null | "exact" | "planned" | "estimated"; returning?: "minimal" | "representation" } +
      +
        +
      • +
        + Optional count?: null | "exact" | "planned" | "estimated" +
        +
      • +
      • +
        + Optional returning?: "minimal" | "representation" +
        +
      • +
      +
    • +
    +

    + Returns default<T> +

    +
  • +
  • + +
    +
    +
    deprecated
    +
    +

    Use upsert() instead.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      + values: Partial<T> | Partial<T>[] +
      +
    • +
    • +
      + Optional options: + { count?: null | "exact" | "planned" | "estimated"; onConflict?: string; returning?: "minimal" | "representation"; upsert?: boolean } +
      +
        +
      • +
        + Optional count?: null | "exact" | "planned" | "estimated" +
        +
      • +
      • +
        + Optional + onConflict?: string +
        +
      • +
      • +
        + Optional returning?: "minimal" | "representation" +
        +
      • +
      • +
        + Optional upsert?: boolean +
        +
      • +
      +
    • +
    +

    + Returns default<T> +

    +
  • +
+
+
+ + + + +
+
+ + +
    +
  • + select(columns?: string, __namedParameters?: { count?: null | "exact" | "planned" | "estimated"; head?: boolean }): default<T> +
  • +
+
    +
  • + +
    +
    +

    Performs vertical filtering with SELECT.

    +
    +
    +

    Parameters

    +
      +
    • +
      + Optional columns: + string +
      +
      +
      +

      The columns to retrieve, separated by commas.

      +
      +
      +
    • +
    • +
      + Optional __namedParameters: + { count?: null | "exact" | "planned" | "estimated"; head?: boolean } +
      +
        +
      • +
        + Optional count?: null | "exact" | "planned" | "estimated" +
        +
      • +
      • +
        + Optional head?: boolean +
        +
      • +
      +
    • +
    +

    + Returns default<T> +

    +
  • +
+
+
+ + +
    +
  • + then<TResult1, TResult2>(onfulfilled?: null | ((value: PostgrestResponse<T>) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): PromiseLike<TResult1 | TResult2> +
  • +
+
    +
  • + +

    Type Parameters

    + +

    Parameters

    +
      +
    • +
      + Optional onfulfilled: + null | ((value: PostgrestResponse<T>) => TResult1 | PromiseLike<TResult1>) +
      +
    • +
    • +
      + Optional onrejected: + null | ((reason: any) => TResult2 | PromiseLike<TResult2>) +
      +
    • +
    +

    + Returns PromiseLike<TResult1 | TResult2> +

    +
  • +
+
+
+ + + +
    +
  • + +
    +
    +

    + If there's an error with the query, throwOnError will reject the promise + by throwing the error instead of returning it as part of a successful + response. +

    +
    + +
    +

    Parameters

    +
      +
    • +
      + Optional throwOnError: + boolean +
      +
    • +
    +

    + Returns + SupabaseQueryBuilder<T> +

    +
  • +
+
+
+ + +
    +
  • + update(values: Partial<T>, __namedParameters?: { count?: null | "exact" | "planned" | "estimated"; returning?: "minimal" | "representation" }): default<T> +
  • +
+
    +
  • + +
    +
    +

    Performs an UPDATE on the table.

    +
    +
    +

    Parameters

    +
      +
    • +
      + values: Partial<T> +
      +
      +
      +

      The values to update.

      +
      +
      +
    • +
    • +
      + Optional __namedParameters: + { count?: null | "exact" | "planned" | "estimated"; returning?: "minimal" | "representation" } +
      +
        +
      • +
        + Optional count?: null | "exact" | "planned" | "estimated" +
        +
      • +
      • +
        + Optional returning?: "minimal" | "representation" +
        +
      • +
      +
    • +
    +

    + Returns default<T> +

    +
  • +
+
+
+ + +
    +
  • + upsert(values: Partial<T> | Partial<T>[], __namedParameters?: { count?: null | "exact" | "planned" | "estimated"; ignoreDuplicates?: boolean; onConflict?: string; returning?: "minimal" | "representation" }): default<T> +
  • +
+
    +
  • + +
    +
    +

    Performs an UPSERT into the table.

    +
    +
    +

    Parameters

    +
      +
    • +
      + values: Partial<T> | Partial<T>[] +
      +
      +
      +

      The values to insert.

      +
      +
      +
    • +
    • +
      + Optional __namedParameters: + { count?: null | "exact" | "planned" | "estimated"; ignoreDuplicates?: boolean; onConflict?: string; returning?: "minimal" | "representation" } +
      +
        +
      • +
        + Optional count?: null | "exact" | "planned" | "estimated" +
        +
      • +
      • +
        + Optional + ignoreDuplicates?: boolean +
        +
      • +
      • +
        + Optional + onConflict?: string +
        +
      • +
      • +
        + Optional returning?: "minimal" | "representation" +
        +
      • +
      +
    • +
    +

    + Returns default<T> +

    +
  • +
+
+
+
+ +
+
+ +
+

Generated using TypeDoc

+
+
+ + + diff --git a/v1/classes/lib_SupabaseRealtimeClient.SupabaseRealtimeClient.html b/v1/classes/lib_SupabaseRealtimeClient.SupabaseRealtimeClient.html new file mode 100644 index 00000000..37f195a4 --- /dev/null +++ b/v1/classes/lib_SupabaseRealtimeClient.SupabaseRealtimeClient.html @@ -0,0 +1,765 @@ + + + + + + SupabaseRealtimeClient | @supabase/supabase-js + + + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ +
+
+ Menu +
+
+
+
+
+
+ +

Class SupabaseRealtimeClient

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • SupabaseRealtimeClient
  • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ + + + +
+
+
+

Properties

+
+ + +
+ subscription: + RealtimeSubscription +
+ +
+
+
+

Methods

+
+ + +
    +
  • + getPayloadRecords(payload: any): { new: {}; old: {} } +
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      payload: any
      +
    • +
    +

    + Returns { new: {}; old: {} } +

    +
      +
    • +
      + new: {} +
      +
        +
      • +
      • +
        + old: {} +
        +
          +
        • +
        +
      • +
      +
      +
      + + + + +
      +
      + + + + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/enums/index.Transformers.PostgresTypes.html b/v1/enums/index.Transformers.PostgresTypes.html new file mode 100644 index 00000000..f4550cab --- /dev/null +++ b/v1/enums/index.Transformers.PostgresTypes.html @@ -0,0 +1,1251 @@ + + + + + + PostgresTypes | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Enumeration PostgresTypes

      +
      +
      +
      +
      +
      +
      +
      +
      +
      +

      Helpers to convert the change Payload into native JS types.

      +
      +
      +
      +
      +

      Index

      +
      +
      +
      +

      Enumeration Members

      + +
      +
      +
      +
      +
      +

      Enumeration Members

      +
      + + +
      + abstime: + "abstime" +
      + +
      +
      + + +
      + bool: + "bool" +
      + +
      +
      + + +
      + date: + "date" +
      + +
      +
      + + +
      + daterange: + "daterange" +
      + +
      +
      + + +
      + float4: + "float4" +
      + +
      +
      + + +
      + float8: + "float8" +
      + +
      +
      + + +
      + int2: + "int2" +
      + +
      +
      + + +
      + int4: + "int4" +
      + +
      +
      + + +
      + int4range: + "int4range" +
      + +
      +
      + + +
      + int8: + "int8" +
      + +
      +
      + + +
      + int8range: + "int8range" +
      + +
      +
      + + +
      + json: + "json" +
      + +
      +
      + + +
      + jsonb: + "jsonb" +
      + +
      +
      + + +
      + money: + "money" +
      + +
      +
      + + +
      + numeric: + "numeric" +
      + +
      +
      + + +
      + oid: + "oid" +
      + +
      +
      + + +
      + reltime: + "reltime" +
      + +
      +
      + + +
      + text: + "text" +
      + +
      +
      + + +
      + time: + "time" +
      + +
      +
      + + +
      + timestamp: + "timestamp" +
      + +
      +
      + + +
      + timestamptz: + "timestamptz" +
      + +
      +
      + + +
      + timetz: + "timetz" +
      + +
      +
      + + +
      + tsrange: + "tsrange" +
      + +
      +
      + + +
      + tstzrange: + "tstzrange" +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/index.html b/v1/index.html new file mode 100644 index 00000000..53eb84f4 --- /dev/null +++ b/v1/index.html @@ -0,0 +1,226 @@ + + + + + + @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +

      @supabase/supabase-js

      +
      +
      +
      +
      +
      +
      + +

      supabase-js

      +
      +

      An isomorphic JavaScript client for Supabase.

      + + + +

      Usage

      +
      +

      First of all, you need to install the library:

      +
      npm install @supabase/supabase-js
      +
      +

      + Then you're able to import the library and establish the connection with the + database: +

      +
      import { createClient } from '@supabase/supabase-js'

      // Create a single supabase client for interacting with your database
      const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key') +
      + + +

      UMD

      +
      +

      + You can now use plain <script>s to import supabase-js from CDNs, + like: +

      +
      <script src="https://cdn.jsdelivr.net/npm/@supabase/supabase-js"></script>
      +
      +

      or even:

      +
      <script src="https://unpkg.com/@supabase/supabase-js"></script>
      +
      +

      Then you can use it from a global supabase variable:

      +
      <script>
      const { createClient } = supabase
      const _supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')

      console.log('Supabase Instance: ', _supabase)
      // ...
      </script> +
      + + +

      ESM

      +
      +

      + You can now use type="module" <script>s to import + supabase-js from CDNs, like: +

      +
      <script type="module">
      import { createClient } from 'https://cdn.jsdelivr.net/npm/@supabase/supabase-js/+esm'
      const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')

      console.log('Supabase Instance: ', supabase)
      // ...
      </script> +
      + + +

      Custom fetch implementation

      +
      +

      + supabase-js uses the + cross-fetch + library to make HTTP requests, but an alternative fetch implementation + can be provided as an option. This is most useful in environments where + cross-fetch is not compatible, for instance Cloudflare Workers: +

      +
      import { createClient } from '@supabase/supabase-js'

      // Provide a custom `fetch` implementation as an option
      const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key', {
      fetch: (...args) => fetch(...args),
      }) +
      + + +

      Sponsors

      +
      +

      + We are building the features of Firebase using enterprise-grade, open source products. + We support existing communities wherever possible, and if the products don’t exist we + build them and open source them ourselves. Thanks to these sponsors who are making the + OSS ecosystem better for everyone. +

      +

      + New Sponsor +

      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.AdminUserAttributes.html b/v1/interfaces/index.AdminUserAttributes.html new file mode 100644 index 00000000..dbe53a8e --- /dev/null +++ b/v1/interfaces/index.AdminUserAttributes.html @@ -0,0 +1,698 @@ + + + + + + AdminUserAttributes | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface AdminUserAttributes

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      + +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + app_metadata?: + object +
      + +
      +
      +

      A custom data object for app_metadata that.

      +
      +
      +

      Only a service role can modify.

      +

      + Can be any JSON that includes app-specific info, such as identity providers, + roles, and other access control information. +

      +
      +
      +
      +
      + + +
      + data?: + object +
      + +
      +
      +

      + A custom data object for user_metadata that a user can modify. Can be any JSON. +

      +
      +
      +
      +
      + + +
      + email?: + string +
      + +
      +
      +

      The user's email.

      +
      +
      +
      +
      + + +
      + email_change_token?: + string +
      + +
      +
      +

      An email change token.

      +
      +
      +
      +
      + + +
      + email_confirm?: + boolean +
      + +
      +
      +

      Sets if a user has confirmed their email address.

      +
      +

      Only a service role can modify.

      +
      +
      +
      + + +
      + password?: + string +
      + +
      +
      +

      The user's password.

      +
      +
      +
      +
      + + +
      + phone?: + string +
      + +
      +
      +

      The user's phone.

      +
      +
      +
      +
      + + +
      + phone_confirm?: + boolean +
      + +
      +
      +

      Sets if a user has confirmed their phone number.

      +
      +

      Only a service role can modify.

      +
      +
      +
      + + +
      + user_metadata?: + object +
      + +
      +
      +

      A custom data object for user_metadata.

      +
      +
      +

      Can be any JSON.

      +

      Only a service role can modify.

      +

      + Note: When using the GoTrueAdminApi and wanting to modify a user's + user_metadata, this attribute is used instead of UserAttributes data. +

      +
      +
      +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.ApiError.html b/v1/interfaces/index.ApiError.html new file mode 100644 index 00000000..a210557f --- /dev/null +++ b/v1/interfaces/index.ApiError.html @@ -0,0 +1,251 @@ + + + + + + ApiError | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface ApiError

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • ApiError
      • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + message: + string +
      + +
      +
      + + +
      + status: + number +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.AuthSession.html b/v1/interfaces/index.AuthSession.html new file mode 100644 index 00000000..3afe88f4 --- /dev/null +++ b/v1/interfaces/index.AuthSession.html @@ -0,0 +1,499 @@ + + + + + + AuthSession | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface AuthSession

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • AuthSession
      • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + access_token: + string +
      + +
      +
      + + +
      + expires_at?: + number +
      + +
      +
      +

      + A timestamp of when the token will expire. Returned when a login is confirmed. +

      +
      +
      +
      +
      + + +
      + expires_in?: + number +
      + +
      +
      +

      + The number of seconds until the token expires (since it was issued). Returned + when a login is confirmed. +

      +
      +
      +
      +
      + + +
      + provider_token?: + null | string +
      + +
      +
      + + +
      + refresh_token?: + string +
      + +
      +
      + + +
      + token_type: + string +
      + +
      +
      + + +
      + user: + null | AuthUser +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.AuthUser.html b/v1/interfaces/index.AuthUser.html new file mode 100644 index 00000000..73899888 --- /dev/null +++ b/v1/interfaces/index.AuthUser.html @@ -0,0 +1,1078 @@ + + + + + + AuthUser | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface AuthUser

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • AuthUser
      • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + action_link?: + string +
      + +
      +
      + + +
      + app_metadata: + { provider?: string } +
      + +
      +

      Type declaration

      +
        +
      • +
        + [key: + string]: any +
        +
      • +
      • +
        + Optional provider?: string +
        +
      • +
      +
      +
      +
      + + +
      + aud: + string +
      + +
      +
      + + +
      + confirmation_sent_at?: + string +
      + +
      +
      + + +
      + confirmed_at?: + string +
      + +
      +
      + + +
      + created_at: + string +
      + +
      +
      + + +
      + email?: + string +
      + +
      +
      + + +
      + email_change_sent_at?: + string +
      + +
      +
      + + +
      + email_confirmed_at?: + string +
      + +
      +
      + + +
      + id: + string +
      + +
      +
      + + +
      + identities?: + UserIdentity[] +
      + +
      +
      + + +
      + invited_at?: + string +
      + +
      +
      + + +
      + last_sign_in_at?: + string +
      + +
      +
      + + +
      + new_email?: + string +
      + +
      +
      + + +
      + phone?: + string +
      + +
      +
      + + +
      + phone_confirmed_at?: + string +
      + +
      +
      + + +
      + recovery_sent_at?: + string +
      + +
      +
      + + +
      + role?: + string +
      + +
      +
      + + +
      + updated_at?: + string +
      + +
      +
      + + +
      + user_metadata: + {} +
      + +
      +

      Type declaration

      +
        +
      • +
        + [key: + string]: any +
        +
      • +
      +
      +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.CookieOptions.html b/v1/interfaces/index.CookieOptions.html new file mode 100644 index 00000000..3d3b7478 --- /dev/null +++ b/v1/interfaces/index.CookieOptions.html @@ -0,0 +1,391 @@ + + + + + + CookieOptions | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface CookieOptions

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • CookieOptions
      • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + domain?: + string +
      + +
      +
      + + +
      + lifetime?: + number +
      + +
      +
      + + +
      + name?: + string +
      + +
      +
      + + +
      + path?: + string +
      + +
      +
      + + +
      + sameSite?: + string +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.OpenIDConnectCredentials.html b/v1/interfaces/index.OpenIDConnectCredentials.html new file mode 100644 index 00000000..a4c36846 --- /dev/null +++ b/v1/interfaces/index.OpenIDConnectCredentials.html @@ -0,0 +1,408 @@ + + + + + + OpenIDConnectCredentials | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface OpenIDConnectCredentials

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • OpenIDConnectCredentials
      • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + client_id?: + string +
      + +
      +
      + + +
      + id_token: + string +
      + +
      +
      + + +
      + issuer?: + string +
      + +
      +
      + + +
      + nonce: + string +
      + +
      +
      + + +
      + provider?: + Provider +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.Subscription.html b/v1/interfaces/index.Subscription.html new file mode 100644 index 00000000..8523af2e --- /dev/null +++ b/v1/interfaces/index.Subscription.html @@ -0,0 +1,386 @@ + + + + + + Subscription | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface Subscription

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • Subscription
      • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      +
        +
      • + id +
      • +
      +
      +
      +

      Methods

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + id: + string +
      + +
      +
      +

      The subscriber UUID. This will be set by the client.

      +
      +
      +
      +
      +
      +

      Methods

      +
      + + + +
        +
      • + +
        +
        +

        + The function to call every time there is an event. eg: (eventName) => {} +

        +
        +
        +

        Parameters

        + +

        + Returns void +

        +
      • +
      +
      +
      + + +
        +
      • + unsubscribe(): void +
      • +
      +
        +
      • + +
        +
        +

        Call this to remove the listener.

        +
        +
        +

        + Returns void +

        +
      • +
      +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.UserAttributes.html b/v1/interfaces/index.UserAttributes.html new file mode 100644 index 00000000..2a4b26c0 --- /dev/null +++ b/v1/interfaces/index.UserAttributes.html @@ -0,0 +1,423 @@ + + + + + + UserAttributes | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface UserAttributes

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      + +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + data?: + object +
      + +
      +
      +

      + A custom data object for user_metadata that a user can modify. Can be any JSON. +

      +
      +
      +
      +
      + + +
      + email?: + string +
      + +
      +
      +

      The user's email.

      +
      +
      +
      +
      + + +
      + email_change_token?: + string +
      + +
      +
      +

      An email change token.

      +
      +
      +
      +
      + + +
      + password?: + string +
      + +
      +
      +

      The user's password.

      +
      +
      +
      +
      + + +
      + phone?: + string +
      + +
      +
      +

      The user's phone.

      +
      +
      +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.UserCredentials.html b/v1/interfaces/index.UserCredentials.html new file mode 100644 index 00000000..4359abc3 --- /dev/null +++ b/v1/interfaces/index.UserCredentials.html @@ -0,0 +1,449 @@ + + + + + + UserCredentials | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface UserCredentials

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • UserCredentials
      • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + email?: + string +
      + +
      +
      + + + + +
      +
      + + +
      + password?: + string +
      + +
      +
      + + +
      + phone?: + string +
      + +
      +
      + + +
      + provider?: + Provider +
      + +
      +
      + + +
      + refreshToken?: + string +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.UserIdentity.html b/v1/interfaces/index.UserIdentity.html new file mode 100644 index 00000000..fa45f93e --- /dev/null +++ b/v1/interfaces/index.UserIdentity.html @@ -0,0 +1,481 @@ + + + + + + UserIdentity | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface UserIdentity

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • UserIdentity
      • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + created_at: + string +
      + +
      +
      + + +
      + id: + string +
      + +
      +
      + + +
      + identity_data: + {} +
      + +
      +

      Type declaration

      +
        +
      • +
        + [key: + string]: any +
        +
      • +
      +
      +
      +
      + + +
      + last_sign_in_at: + string +
      + +
      +
      + + +
      + provider: + string +
      + +
      +
      + + +
      + updated_at?: + string +
      + +
      +
      + + +
      + user_id: + string +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.VerifyEmailOTPParams.html b/v1/interfaces/index.VerifyEmailOTPParams.html new file mode 100644 index 00000000..87aed561 --- /dev/null +++ b/v1/interfaces/index.VerifyEmailOTPParams.html @@ -0,0 +1,349 @@ + + + + + + VerifyEmailOTPParams | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface VerifyEmailOTPParams

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • VerifyEmailOTPParams
      • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + email: + string +
      + +
      +
      + + +
      + phone?: + undefined +
      + +
      +
      + + +
      + token: + string +
      + +
      +
      + + +
      + type: + EmailOTPType +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/index.VerifyMobileOTPParams.html b/v1/interfaces/index.VerifyMobileOTPParams.html new file mode 100644 index 00000000..5caf2d89 --- /dev/null +++ b/v1/interfaces/index.VerifyMobileOTPParams.html @@ -0,0 +1,352 @@ + + + + + + VerifyMobileOTPParams | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface VerifyMobileOTPParams

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • VerifyMobileOTPParams
      • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + email?: + undefined +
      + +
      +
      + + +
      + phone: + string +
      + +
      +
      + + +
      + token: + string +
      + +
      +
      + + +
      + type?: + MobileOTPType +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/interfaces/lib_types.SupabaseAuthClientOptions.html b/v1/interfaces/lib_types.SupabaseAuthClientOptions.html new file mode 100644 index 00000000..0c46ef2a --- /dev/null +++ b/v1/interfaces/lib_types.SupabaseAuthClientOptions.html @@ -0,0 +1,764 @@ + + + + + + SupabaseAuthClientOptions | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Interface SupabaseAuthClientOptions

      +
      +
      +
      +
      +
      +
      +
      +

      Hierarchy

      +
        +
      • + GoTrueClientOptions +
          +
        • SupabaseAuthClientOptions
        • +
        +
      • +
      +
      +
      +

      Index

      +
      +
      +
      +

      Properties

      + +
      +
      +
      +
      +
      +

      Properties

      +
      + + +
      + autoRefreshToken?: + boolean +
      + +
      +
      + + +
      + cookieOptions?: + CookieOptions +
      + +
      +
      + + +
      + detectSessionInUrl?: + boolean +
      + +
      +
      + + +
      + fetch?: + ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) +
      + +
      +

      Type declaration

      +
        +
      • +
          +
        • + (input: RequestInfo | URL, init?: RequestInit): Promise<Response> +
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            + input: RequestInfo | URL +
            +
          • +
          • +
            + Optional init: + RequestInit +
            +
          • +
          +

          + Returns Promise<Response> +

          +
        • +
        +
      • +
      +
      +
      +
      + + +
      + headers?: + {} +
      + +
      +

      Type declaration

      +
        +
      • +
        + [key: + string]: string +
        +
      • +
      +
      +
      +
      + + +
      + localStorage?: + PromisifyMethods<Pick<Storage, "getItem" | "removeItem" | "setItem">> +
      + +
      +
      + + +
      + multiTab?: + boolean +
      + +
      +
      + + +
      + persistSession?: + boolean +
      + +
      +
      + + +
      + url?: + string +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/modules.html b/v1/modules.html new file mode 100644 index 00000000..99620004 --- /dev/null +++ b/v1/modules.html @@ -0,0 +1,170 @@ + + + + + + @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +

      @supabase/supabase-js

      +
      +
      +
      +
      +
      +
      +

      Index

      +
      +
      +
      +

      Modules

      + +
      +
      +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/modules/index.Transformers.html b/v1/modules/index.Transformers.html new file mode 100644 index 00000000..68031d12 --- /dev/null +++ b/v1/modules/index.Transformers.html @@ -0,0 +1,910 @@ + + + + + + Transformers | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Namespace Transformers

      +
      +
      +
      +
      +
      +
      +
      +

      Index

      +
      +
      +
      +

      Enumerations

      + +
      +
      +

      Functions

      + +
      +
      +
      +
      +
      +

      Functions

      +
      + + +
        +
      • + convertCell(type: string, value: RecordValue): RecordValue +
      • +
      +
        +
      • + +
        +
        +

        + If the value of the cell is null, returns null. Otherwise + converts the string value to the correct type. +

        +
        +
        +
        example
        +

        convertCell('bool', 't') //=> true

        +
        example
        +

        convertCell('int8', '10') //=> 10

        +
        example
        +
        +

        convertCell('_int4', '{1,2,3,4}') //=> [1,2,3,4]

        +
        +
        +
        +

        Parameters

        +
          +
        • +
          type: string
          +
          +
          +

          A postgres column type

          +
          +
          +
        • +
        • +
          value: RecordValue
          +
        • +
        +

        + Returns RecordValue +

        +
      • +
      +
      +
      + + +
        +
      • + convertChangeData(columns: Columns, record: Record, options?: { skipTypes?: string[] }): Record +
      • +
      +
        +
      • + +
        +
        +

        + Takes an array of columns and an object of string values then converts each + string value to its mapped type. +

        +
        +
        +
        example
        +
        +

        + convertChangeData([{name: 'first_name', type: 'text'}, + {name: 'age', type: 'int4'}], {first_name: 'Paul', + age:'33'}, {}) //=>{ first_name: 'Paul', age: 33 } +

        +
        +
        +
        +

        Parameters

        +
          +
        • +
          columns: Columns
          +
        • +
        • +
          record: Record
          +
        • +
        • +
          + Optional options: + { skipTypes?: string[] } +
          +
          +
          +

          The map of various options that can be applied to the mapper

          +
          +
          +
            +
          • +
            + Optional + skipTypes?: string[] +
            +
            +
            +

            The array of types that should not be converted

            +
            +
            +
          • +
          +
        • +
        +

        + Returns Record +

        +
      • +
      +
      +
      + + +
        +
      • + convertColumn(columnName: string, columns: Columns, record: Record, skipTypes: string[]): RecordValue +
      • +
      +
        +
      • + +
        +
        +

        Converts the value of an individual column.

        +
        +
        +
        example
        +
        +

        + convertColumn('age', [{name: 'first_name', type: + 'text'}, {name: 'age', type: 'int4'}], + {first_name: 'Paul', age: '33'}, []) //=> 33 +

        +
        +
        example
        +
        +

        + convertColumn('age', [{name: 'first_name', type: + 'text'}, {name: 'age', type: 'int4'}], + {first_name: 'Paul', age: '33'}, ['int4']) //=> + "33" +

        +
        +
        +
        +

        Parameters

        +
          +
        • +
          columnName: string
          +
          +
          +

          The column that you want to convert

          +
          +
          +
        • +
        • +
          columns: Columns
          +
        • +
        • +
          record: Record
          +
          +
          +

          The map of string values

          +
          +
          +
        • +
        • +
          + skipTypes: string[] +
          +
          +
          +

          An array of types that should not be converted

          +
          +
          +
        • +
        +

        + Returns RecordValue +

        +

        Useless information

        +
      • +
      +
      +
      + + +
        +
      • + toArray(value: RecordValue, type: string): RecordValue +
      • +
      +
        +
      • + +
        +
        +

        Converts a Postgres Array into a native JS array

        +
        +
        +
        example
        +

        toArray('{}', 'int4') //=> []

        +
        example
        +
        +

        + toArray('{"[2021-01-01,2021-12-31)","(2021-01-01,2021-12-32]"}', + 'daterange') //=> ['[2021-01-01,2021-12-31)', + '(2021-01-01,2021-12-32]'] +

        +
        +
        example
        +

        toArray([1,2,3,4], 'int4') //=> [1,2,3,4]

        +
        +
        +

        Parameters

        +
          +
        • +
          value: RecordValue
          +
        • +
        • +
          type: string
          +
        • +
        +

        + Returns RecordValue +

        +
      • +
      +
      +
      + + +
        +
      • + toBoolean(value: RecordValue): RecordValue +
      • +
      +
        +
      • + +

        Parameters

        +
          +
        • +
          value: RecordValue
          +
        • +
        +

        + Returns RecordValue +

        +
      • +
      +
      +
      + + +
        +
      • + toJson(value: RecordValue): RecordValue +
      • +
      +
        +
      • + +

        Parameters

        +
          +
        • +
          value: RecordValue
          +
        • +
        +

        + Returns RecordValue +

        +
      • +
      +
      +
      + + +
        +
      • + toNumber(value: RecordValue): RecordValue +
      • +
      +
        +
      • + +

        Parameters

        +
          +
        • +
          value: RecordValue
          +
        • +
        +

        + Returns RecordValue +

        +
      • +
      +
      +
      + + +
        +
      • + toTimestampString(value: RecordValue): RecordValue +
      • +
      +
        +
      • + +
        +
        +

        + Fixes timestamp to be ISO-8601. Swaps the space between the date and time + for a 'T' See + https://github.com/supabase/supabase/issues/18 +

        +
        +
        +
        example
        +
        +

        + toTimestampString('2019-09-10 00:00:00') //=> + '2019-09-10T00:00:00' +

        +
        +
        +
        +

        Parameters

        +
          +
        • +
          value: RecordValue
          +
        • +
        +

        + Returns RecordValue +

        +
      • +
      +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/modules/index.html b/v1/modules/index.html new file mode 100644 index 00000000..f887f42b --- /dev/null +++ b/v1/modules/index.html @@ -0,0 +1,1397 @@ + + + + + + index | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Module index

      +
      +
      +
      +
      +
      +
      +
      +

      Index

      +
      +
      +
      +

      References

      + +
      +
      +

      Namespaces

      + +
      +
      +

      Classes

      + +
      +
      +

      Interfaces

      + +
      +
      +

      Type Aliases

      + +
      +
      +

      Functions

      + +
      +
      +
      +
      +
      +

      References

      +
      + + + Renames and re-exports AuthSession +
      +
      + + + Re-exports SupabaseClientOptions +
      +
      + + + Re-exports + SupabaseRealtimePayload +
      +
      + + + Renames and re-exports AuthUser +
      +
      +
      +

      Type Aliases

      +
      + + +
      + AuthChangeEvent: + "PASSWORD_RECOVERY" | "SIGNED_IN" | "SIGNED_OUT" | "TOKEN_REFRESHED" | "USER_UPDATED" | "USER_DELETED" +
      + +
      +
      + + +
      + EmailOTPType: + "signup" | "invite" | "magiclink" | "recovery" | "email_change" +
      + +
      +
      + + +
      + MobileOTPType: + "sms" | "phone_change" +
      + +
      +
      + + +
      + PostgrestError: + { code: string; details: string; hint: string; message: string } +
      + + +
      +

      Type declaration

      +
        +
      • +
        + code: string +
        +
      • +
      • +
        + details: string +
        +
      • +
      • +
        + hint: string +
        +
      • +
      • +
        + message: string +
        +
      • +
      +
      +
      +
      + + +
      + PostgrestMaybeSingleResponse<T>: + PostgrestSingleResponse<T | null> +
      + +

      Type Parameters

      +
        +
      • T

      • +
      +
      +
      + + +
      + PostgrestResponse<T>: + PostgrestResponseSuccess<T> | PostgrestResponseFailure +
      + +

      Type Parameters

      +
        +
      • T

      • +
      +
      +
      + + +
      + PostgrestSingleResponse<T>: + PostgrestSingleResponseSuccess<T> | PostgrestResponseFailure +
      + +

      Type Parameters

      +
        +
      • T

      • +
      +
      +
      + + +
      + Provider: + "apple" | "azure" | "bitbucket" | "discord" | "facebook" | "github" | "gitlab" | "google" | "keycloak" | "linkedin" | "notion" | "slack" | "spotify" | "twitch" | "twitter" | "workos" +
      + +
      +
      + + +
      + RealtimeClientOptions: + { decode?: Function; encode?: Function; headers?: {}; heartbeatIntervalMs?: number; logger?: Function; longpollerTimeout?: number; params?: {}; reconnectAfterMs?: Function; timeout?: number; transport?: WebSocket } +
      + +
      +

      Type declaration

      +
        +
      • +
        + Optional decode?: Function +
        +
      • +
      • +
        + Optional encode?: Function +
        +
      • +
      • +
        + Optional headers?: {} +
        +
          +
        • +
          + [key: + string]: string +
          +
        • +
        +
      • +
      • +
        + Optional + heartbeatIntervalMs?: number +
        +
      • +
      • +
        + Optional logger?: Function +
        +
      • +
      • +
        + Optional + longpollerTimeout?: number +
        +
      • +
      • +
        + Optional params?: {} +
        +
          +
        • +
          + [key: + string]: string +
          +
        • +
        +
      • +
      • +
        + Optional + reconnectAfterMs?: Function +
        +
      • +
      • +
        + Optional timeout?: number +
        +
      • +
      • +
        + Optional transport?: WebSocket +
        +
      • +
      +
      +
      +
      + + +
      + SupportedStorage: + PromisifyMethods<Pick<Storage, "getItem" | "setItem" | "removeItem">> +
      + +
      +
      + + +
      + VerifyOTPParams: + VerifyMobileOTPParams | VerifyEmailOTPParams +
      + +
      +
      +
      +

      Functions

      +
      + + + + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/modules/lib_SupabaseQueryBuilder.html b/v1/modules/lib_SupabaseQueryBuilder.html new file mode 100644 index 00000000..8281a45c --- /dev/null +++ b/v1/modules/lib_SupabaseQueryBuilder.html @@ -0,0 +1,167 @@ + + + + + + lib/SupabaseQueryBuilder | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Module lib/SupabaseQueryBuilder

      +
      +
      +
      +
      +
      +
      +
      +

      Index

      +
      +
      +
      +

      Classes

      + +
      +
      +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/modules/lib_SupabaseRealtimeClient.html b/v1/modules/lib_SupabaseRealtimeClient.html new file mode 100644 index 00000000..8856ff74 --- /dev/null +++ b/v1/modules/lib_SupabaseRealtimeClient.html @@ -0,0 +1,167 @@ + + + + + + lib/SupabaseRealtimeClient | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Module lib/SupabaseRealtimeClient

      +
      +
      +
      +
      +
      +
      +
      +

      Index

      +
      +
      +
      +

      Classes

      + +
      +
      +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/modules/lib_constants.html b/v1/modules/lib_constants.html new file mode 100644 index 00000000..622bc55a --- /dev/null +++ b/v1/modules/lib_constants.html @@ -0,0 +1,271 @@ + + + + + + lib/constants | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Module lib/constants

      +
      +
      +
      +
      +
      +
      +
      +

      Index

      +
      +
      +
      +

      Variables

      + +
      +
      +
      +
      +
      +

      Variables

      +
      + + +
      + DEFAULT_HEADERS: + { X-Client-Info: string } = ... +
      + +
      +

      Type declaration

      +
        +
      • +
        + X-Client-Info: string +
        +
      • +
      +
      +
      +
      + + +
      + STORAGE_KEY: + "supabase.auth.token" = 'supabase.auth.token' +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/modules/lib_helpers.html b/v1/modules/lib_helpers.html new file mode 100644 index 00000000..b9be2d50 --- /dev/null +++ b/v1/modules/lib_helpers.html @@ -0,0 +1,329 @@ + + + + + + lib/helpers | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Module lib/helpers

      +
      +
      +
      +
      +
      +
      +
      +

      Index

      +
      +
      +
      +

      Functions

      + +
      +
      +
      +
      +
      +

      Functions

      +
      + + +
        +
      • + isBrowser(): boolean +
      • +
      + +
      +
      + + +
        +
      • + stripTrailingSlash(url: string): string +
      • +
      +
        +
      • + +

        Parameters

        +
          +
        • +
          url: string
          +
        • +
        +

        + Returns string +

        +
      • +
      +
      +
      + + +
        +
      • + uuid(): string +
      • +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/modules/lib_types.html b/v1/modules/lib_types.html new file mode 100644 index 00000000..57dc91f9 --- /dev/null +++ b/v1/modules/lib_types.html @@ -0,0 +1,788 @@ + + + + + + lib/types | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Module lib/types

      +
      +
      +
      +
      +
      +
      +
      +

      Index

      +
      +
      +
      +

      Interfaces

      + +
      +
      +

      Type Aliases

      + +
      +
      +
      +
      +
      +

      Type Aliases

      +
      + + +
      + Fetch: + typeof __type +
      + +
      +
      + + +
      + GenericObject: + {} +
      + +
      +

      Type declaration

      +
        +
      • +
        + [key: + string]: string +
        +
      • +
      +
      +
      +
      + + +
      + SupabaseClientOptions: + { autoRefreshToken?: boolean; cookieOptions?: SupabaseAuthClientOptions["cookieOptions"]; detectSessionInUrl?: boolean; fetch?: Fetch; headers?: GenericObject; localStorage?: SupabaseAuthClientOptions["localStorage"]; multiTab?: boolean; persistSession?: boolean; realtime?: RealtimeClientOptions; schema?: string; shouldThrowOnError?: boolean } +
      + +
      +

      Type declaration

      +
        +
      • +
        + Optional + autoRefreshToken?: boolean +
        +
        +
        +

        Automatically refreshes the token for logged in users. Defaults to true.

        +
        +
        +
      • +
      • +
        + Optional + cookieOptions?: SupabaseAuthClientOptions["cookieOptions"] +
        +
        +
        +

        Options passed to the gotrue-js instance

        +
        +
        +
      • +
      • +
        + Optional + detectSessionInUrl?: boolean +
        +
        +
        +

        Detect a session from the URL. Used for OAuth login callbacks. Defaults to true.

        +
        +
        +
      • +
      • +
        + Optional fetch?: Fetch +
        +
        +
        +

        A custom fetch implementation.

        +
        +
        +
      • +
      • +
        + Optional headers?: GenericObject +
        +
        +
        +

        Optional headers for initializing the client.

        +
        +
        +
      • +
      • +
        + Optional + localStorage?: SupabaseAuthClientOptions["localStorage"] +
        +
        +
        +

        A storage provider. Used to store the logged in session.

        +
        +
        +
      • +
      • +
        + Optional multiTab?: boolean +
        +
        +
        +

        Allows to enable/disable multi-tab/window events

        +
        +
        +
      • +
      • +
        + Optional + persistSession?: boolean +
        +
        +
        +

        Whether to persist a logged in session to storage. Defaults to true.

        +
        +
        +
      • +
      • +
        + Optional realtime?: RealtimeClientOptions +
        +
        +
        +

        Options passed to the realtime-js instance

        +
        +
        +
      • +
      • +
        + Optional schema?: string +
        +
        +
        +

        + The Postgres schema which your tables belong to. Must be on the list of + exposed schemas in Supabase. Defaults to public. +

        +
        +
        +
      • +
      • +
        + Optional + shouldThrowOnError?: boolean +
        +
        +
        +

        Throw errors, instead of returning them.

        +
        +
        +
      • +
      +
      +
      +
      + + +
      + SupabaseEventTypes: + "INSERT" | "UPDATE" | "DELETE" | "*" +
      + +
      +
      + + +
      + SupabaseRealtimePayload<T>: + { commit_timestamp: string; errors: string[] | null; eventType: "INSERT" | "UPDATE" | "DELETE"; new: T; old: T; schema: string; table: string } +
      + +

      Type Parameters

      +
        +
      • T

      • +
      +
      +

      Type declaration

      +
        +
      • +
        + commit_timestamp: string +
        +
      • +
      • +
        + errors: string[] | null +
        +
      • +
      • +
        + eventType: "INSERT" | "UPDATE" | "DELETE" +
        +
      • +
      • +
        + new: T +
        +
        +
        +

        + The new record. Present for 'INSERT' and 'UPDATE' events. +

        +
        +
        +
      • +
      • +
        + old: T +
        +
        +
        +

        + The previous record. Present for 'UPDATE' and 'DELETE' + events. +

        +
        +
        +
      • +
      • +
        + schema: string +
        +
      • +
      • +
        + table: string +
        +
      • +
      +
      +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/modules/lib_version.html b/v1/modules/lib_version.html new file mode 100644 index 00000000..2a6500b0 --- /dev/null +++ b/v1/modules/lib_version.html @@ -0,0 +1,201 @@ + + + + + + lib/version | @supabase/supabase-js + + + + + + + + +
      +
      +
      +
      + +
      +
      + Options +
      +
      + All +
        +
      • Public
      • +
      • Public/Protected
      • +
      • All
      • +
      +
      + +
      +
      + Menu +
      +
      +
      +
      +
      +
      + +

      Module lib/version

      +
      +
      +
      +
      +
      +
      +
      +

      Index

      +
      +
      +
      +

      Variables

      + +
      +
      +
      +
      +
      +

      Variables

      +
      + + +
      + version: + "0.0.0-automated" = '0.0.0-automated' +
      + +
      +
      +
      + +
      +
      + +
      +

      Generated using TypeDoc

      +
      +
      + + + diff --git a/v1/spec.json b/v1/spec.json new file mode 100644 index 00000000..eefe0fda --- /dev/null +++ b/v1/spec.json @@ -0,0 +1,3719 @@ +{ + "id": 0, + "name": "@supabase/supabase-js", + "kind": 1, + "flags": {}, + "originalName": "", + "children": [ + { + "id": 105, + "name": "index", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 202, + "name": "SupabaseClientOptions", + "kind": 16777216, + "kindString": "Reference", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 27, + "character": 2 + } + ], + "target": 79 + }, + { + "id": 203, + "name": "SupabaseRealtimePayload", + "kind": 16777216, + "kindString": "Reference", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 28, + "character": 2 + } + ], + "target": 92 + }, + { + "id": 111, + "name": "SupabaseClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Supabase Client.", + "text": "An isomorphic Javascript client for interacting with Postgres.\n" + }, + "children": [ + { + "id": 112, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 61, + "character": 2 + } + ], + "signatures": [ + { + "id": 113, + "name": "new SupabaseClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Create a new client for use in the browser." + }, + "parameters": [ + { + "id": 114, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 115, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 116, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 79, + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 111, + "name": "default" + } + } + ] + }, + { + "id": 117, + "name": "auth", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 30, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "SupabaseAuthClient" + } + }, + { + "id": 121, + "name": "authUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 35, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 131, + "name": "changedAccessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 41, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 126, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 40, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 127, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 128, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 129, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 130, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + }, + { + "id": 123, + "name": "functionsUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 37, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 133, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 44, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 134, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 135, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 136, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 125, + "name": "multiTab", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 39, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 124, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClient", + "package": "@supabase/realtime-js", + "name": "default" + } + }, + { + "id": 120, + "name": "realtimeUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 34, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 119, + "name": "restUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 33, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 118, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 32, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 132, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 42, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 122, + "name": "storageUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 36, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 138, + "name": "supabaseKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 137, + "name": "supabaseUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 139, + "name": "functions", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 106, + "character": 6 + } + ], + "getSignature": [ + { + "id": 140, + "name": "functions", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "comment": { + "shortText": "Supabase Functions allows you to deploy and invoke edge functions." + }, + "type": { + "type": "reference", + "qualifiedName": "FunctionsClient", + "package": "@supabase/functions-js", + "name": "FunctionsClient" + } + } + ] + }, + { + "id": 141, + "name": "storage", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 116, + "character": 6 + } + ], + "getSignature": [ + { + "id": 142, + "name": "storage", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "comment": { + "shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos." + }, + "type": { + "type": "reference", + "qualifiedName": "StorageClient", + "package": "@supabase/storage-js", + "name": "StorageClient" + } + } + ] + }, + { + "id": 171, + "name": "_closeSubscription", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 194, + "character": 16 + } + ], + "signatures": [ + { + "id": 172, + "name": "_closeSubscription", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 173, + "name": "subscription", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RealtimeSubscription", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 174, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 175, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 196, + "character": 15 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [175] + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 191, + "name": "_getAuthHeaders", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 271, + "character": 10 + } + ], + "signatures": [ + { + "id": 192, + "name": "_getAuthHeaders", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "id": 74, + "name": "GenericObject" + } + } + ] + }, + { + "id": 197, + "name": "_handleTokenChanged", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 313, + "character": 10 + } + ], + "signatures": [ + { + "id": 198, + "name": "_handleTokenChanged", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 199, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "AuthChangeEvent", + "package": "@supabase/gotrue-js", + "name": "AuthChangeEvent" + } + }, + { + "id": 200, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 201, + "name": "source", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "CLIENT" + }, + { + "type": "literal", + "value": "STORAGE" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 189, + "name": "_initPostgRESTClient", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 262, + "character": 10 + } + ], + "signatures": [ + { + "id": 190, + "name": "_initPostgRESTClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "PostgrestClient", + "package": "@supabase/postgrest-js", + "name": "default" + } + } + ] + }, + { + "id": 186, + "name": "_initRealtimeClient", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 255, + "character": 10 + } + ], + "signatures": [ + { + "id": 187, + "name": "_initRealtimeClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 188, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "Options", + "package": "@supabase/realtime-js", + "name": "Options" + } + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClient", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ] + }, + { + "id": 183, + "name": "_initSupabaseAuthClient", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 228, + "character": 10 + } + ], + "signatures": [ + { + "id": 184, + "name": "_initSupabaseAuthClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 185, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 79, + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "name": "SupabaseAuthClient" + } + } + ] + }, + { + "id": 195, + "name": "_listenForAuthEvents", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 306, + "character": 10 + } + ], + "signatures": [ + { + "id": 196, + "name": "_listenForAuthEvents", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "qualifiedName": "Subscription", + "package": "@supabase/gotrue-js", + "name": "Subscription" + } + ] + } + } + ] + }, + { + "id": 193, + "name": "_listenForMultiTabEvents", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 279, + "character": 10 + } + ], + "signatures": [ + { + "id": 194, + "name": "_listenForMultiTabEvents", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "void" + } + ] + } + } + ] + }, + { + "id": 176, + "name": "_unsubscribeSubscription", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 209, + "character": 10 + } + ], + "signatures": [ + { + "id": 177, + "name": "_unsubscribeSubscription", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 178, + "name": "subscription", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RealtimeSubscription", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 179, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 180, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 211, + "character": 15 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [180] + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 143, + "name": "from", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 125, + "character": 2 + } + ], + "signatures": [ + { + "id": 144, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a table operation." + }, + "typeParameter": [ + { + "id": 145, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + } + ], + "parameters": [ + { + "id": 146, + "name": "table", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The table name to operate on.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 2, + "typeArguments": [ + { + "type": "reference", + "id": 145, + "name": "T" + } + ], + "name": "SupabaseQueryBuilder" + } + } + ] + }, + { + "id": 181, + "name": "getSubscriptions", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 224, + "character": 2 + } + ], + "signatures": [ + { + "id": 182, + "name": "getSubscriptions", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns an array of all your subscriptions." + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "RealtimeSubscription", + "package": "@supabase/realtime-js", + "name": "default" + } + } + } + ] + }, + { + "id": 156, + "name": "removeAllSubscriptions", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 162, + "character": 8 + } + ], + "signatures": [ + { + "id": 157, + "name": "removeAllSubscriptions", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Closes and removes all subscriptions and returns a list of removed\nsubscriptions and their errors." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 158, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 159, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 163, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 160, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 161, + "name": "subscription", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 163, + "character": 14 + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeSubscription", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [161] + } + ] + } + } + }, + { + "id": 162, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 163, + "character": 52 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [159, 162] + } + ] + } + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 163, + "name": "removeSubscription", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 182, + "character": 8 + } + ], + "signatures": [ + { + "id": 164, + "name": "removeSubscription", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Closes and removes a subscription and returns the number of open subscriptions." + }, + "parameters": [ + { + "id": 165, + "name": "subscription", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The subscription you want to close and remove.\n" + }, + "type": { + "type": "reference", + "qualifiedName": "RealtimeSubscription", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 166, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 167, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 184, + "character": 15 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 168, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 169, + "name": "openSubscriptions", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 184, + "character": 23 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [169] + } + ] + } + } + }, + { + "id": 170, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 184, + "character": 52 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [167, 170] + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 147, + "name": "rpc", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 146, + "character": 2 + } + ], + "signatures": [ + { + "id": 148, + "name": "rpc", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a function call." + }, + "typeParameter": [ + { + "id": 149, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + } + ], + "parameters": [ + { + "id": 150, + "name": "fn", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The function name to call." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 151, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The parameters to pass to the function call." + }, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 152, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 153, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 155, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 152, + "character": 25 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 154, + "name": "head", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 152, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [155, 154] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "T" + } + ], + "qualifiedName": "PostgrestFilterBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [112] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 117, 121, 131, 126, 123, 133, 125, 124, 120, 119, 118, 132, 122, 138, 137 + ] + }, + { + "title": "Accessors", + "kind": 262144, + "children": [139, 141] + }, + { + "title": "Methods", + "kind": 2048, + "children": [171, 191, 197, 189, 186, 183, 195, 193, 176, 143, 181, 156, 163, 147] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 26, + "character": 21 + } + ] + }, + { + "id": 106, + "name": "createClient", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 16, + "character": 6 + } + ], + "signatures": [ + { + "id": 107, + "name": "createClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new Supabase Client." + }, + "parameters": [ + { + "id": 108, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 109, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 110, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 79, + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 111, + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "References", + "kind": 16777216, + "children": [202, 203] + }, + { + "title": "Classes", + "kind": 128, + "children": [111] + }, + { + "title": "Functions", + "kind": 64, + "children": [106] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 1, + "name": "lib/SupabaseQueryBuilder", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 2, + "name": "SupabaseQueryBuilder", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 3, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 13, + "character": 2 + } + ], + "signatures": [ + { + "id": 4, + "name": "new SupabaseQueryBuilder", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "typeParameter": [ + { + "id": 5, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "parameters": [ + { + "id": 6, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 7, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 8, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 13, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 27, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 14, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 15, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 16, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 17, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + }, + { + "id": 9, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 23, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 74, + "name": "GenericObject" + } + }, + { + "id": 11, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 25, + "character": 6 + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClient", + "package": "@supabase/realtime-js", + "name": "default" + } + }, + { + "id": 10, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 24, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 18, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 28, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 12, + "name": "table", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 26, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [13, 9, 11, 10, 18, 12] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 2, + "typeArguments": [ + { + "type": "reference", + "id": 5, + "name": "T" + } + ], + "name": "SupabaseQueryBuilder" + }, + "overwrites": { + "type": "reference", + "name": "PostgrestQueryBuilder.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "PostgrestQueryBuilder.constructor" + } + }, + { + "id": 21, + "name": "_headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 9, + "character": 10 + } + ], + "type": { + "type": "reference", + "id": 74, + "name": "GenericObject" + } + }, + { + "id": 20, + "name": "_realtime", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 8, + "character": 10 + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClient", + "package": "@supabase/realtime-js", + "name": "default" + } + }, + { + "id": 22, + "name": "_schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 10, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 19, + "name": "_subscription", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 7, + "character": 10 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 33, + "name": "SupabaseRealtimeClient" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 23, + "name": "_table", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 11, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 24, + "name": "on", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 44, + "character": 2 + } + ], + "signatures": [ + { + "id": 25, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Subscribe to realtime changes in your database." + }, + "parameters": [ + { + "id": 26, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The database event which you would like to receive updates for, or you can use the special wildcard `*` to listen to all changes." + }, + "type": { + "type": "reference", + "id": 102, + "name": "SupabaseEventTypes" + } + }, + { + "id": 27, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A callback that will handle the payload that is sent whenever your database changes.\n" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 28, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 29, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 30, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 92, + "typeArguments": [ + { + "type": "reference", + "id": 5, + "name": "T" + } + ], + "name": "SupabaseRealtimePayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 33, + "name": "SupabaseRealtimeClient" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [3] + }, + { + "title": "Properties", + "kind": 1024, + "children": [21, 20, 22, 19, 23] + }, + { + "title": "Methods", + "kind": 2048, + "children": [24] + } + ], + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 6, + "character": 13 + } + ], + "typeParameter": [ + { + "id": 31, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "extendedTypes": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 5, + "name": "T" + } + ], + "qualifiedName": "PostgrestQueryBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [2] + } + ], + "sources": [ + { + "fileName": "src/lib/SupabaseQueryBuilder.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 32, + "name": "lib/SupabaseRealtimeClient", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 33, + "name": "SupabaseRealtimeClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 34, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/SupabaseRealtimeClient.ts", + "line": 7, + "character": 2 + } + ], + "signatures": [ + { + "id": 35, + "name": "new SupabaseRealtimeClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 36, + "name": "socket", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RealtimeClient", + "package": "@supabase/realtime-js", + "name": "default" + } + }, + { + "id": 37, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 74, + "name": "GenericObject" + } + }, + { + "id": 38, + "name": "schema", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 39, + "name": "tableName", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 33, + "name": "SupabaseRealtimeClient" + } + } + ] + }, + { + "id": 40, + "name": "subscription", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/SupabaseRealtimeClient.ts", + "line": 5, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeSubscription", + "package": "@supabase/realtime-js", + "name": "default" + } + }, + { + "id": 41, + "name": "getPayloadRecords", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/lib/SupabaseRealtimeClient.ts", + "line": 19, + "character": 10 + } + ], + "signatures": [ + { + "id": 42, + "name": "getPayloadRecords", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 43, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 44, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 45, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/SupabaseRealtimeClient.ts", + "line": 21, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 46, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + }, + "defaultValue": "{}" + }, + { + "id": 47, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/SupabaseRealtimeClient.ts", + "line": 22, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 48, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + }, + "defaultValue": "{}" + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [45, 47] + } + ] + } + } + } + ] + }, + { + "id": 49, + "name": "on", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/SupabaseRealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "signatures": [ + { + "id": 50, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "The event you want to listen to." + }, + "parameters": [ + { + "id": 51, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The event" + }, + "type": { + "type": "reference", + "id": 102, + "name": "SupabaseEventTypes" + } + }, + { + "id": 52, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A callback function that is called whenever the event occurs.\n" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 53, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 54, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 55, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 92, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "SupabaseRealtimePayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 33, + "name": "SupabaseRealtimeClient" + } + } + ] + }, + { + "id": 56, + "name": "subscribe", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/SupabaseRealtimeClient.ts", + "line": 64, + "character": 2 + } + ], + "signatures": [ + { + "id": 57, + "name": "subscribe", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Enables the subscription." + }, + "parameters": [ + { + "id": 58, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeSubscription", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [34] + }, + { + "title": "Properties", + "kind": 1024, + "children": [40] + }, + { + "title": "Methods", + "kind": 2048, + "children": [41, 49, 56] + } + ], + "sources": [ + { + "fileName": "src/lib/SupabaseRealtimeClient.ts", + "line": 4, + "character": 13 + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [33] + } + ], + "sources": [ + { + "fileName": "src/lib/SupabaseRealtimeClient.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 59, + "name": "lib/constants", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 60, + "name": "DEFAULT_HEADERS", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 3, + "character": 13 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 61, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 62, + "name": "X-Client-Info", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 3, + "character": 33 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [62] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 63, + "name": "STORAGE_KEY", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 4, + "character": 13 + } + ], + "type": { + "type": "literal", + "value": "supabase.auth.token" + }, + "defaultValue": "'supabase.auth.token'" + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [60, 63] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 2, + "character": 0 + } + ] + }, + { + "id": 64, + "name": "lib/helpers", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 70, + "name": "isBrowser", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 15, + "character": 13 + } + ], + "signatures": [ + { + "id": 71, + "name": "isBrowser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 67, + "name": "stripTrailingSlash", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 11, + "character": 16 + } + ], + "signatures": [ + { + "id": 68, + "name": "stripTrailingSlash", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 69, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 65, + "name": "uuid", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 3, + "character": 16 + } + ], + "signatures": [ + { + "id": 66, + "name": "uuid", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "kind": 64, + "children": [70, 67, 65] + } + ], + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 3, + "character": 0 + } + ] + }, + { + "id": 72, + "name": "lib/types", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 73, + "name": "SupabaseAuthClientOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 6, + "character": 17 + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "GoTrueClientOptions" + } + ] + }, + { + "id": 78, + "name": "Fetch", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 12 + } + ], + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 14, + "qualifiedName": "fetch", + "package": "typescript", + "name": "fetch" + } + } + }, + { + "id": 74, + "name": "GenericObject", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 75, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 8, + "character": 28 + } + ], + "indexSignature": { + "id": 76, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 77, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 79, + "name": "SupabaseClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 12, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 80, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 83, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Automatically refreshes the token for logged in users. Defaults to `true`." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 91, + "name": "cookieOptions", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Options passed to the gotrue-js instance" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 60, + "character": 2 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "cookieOptions" + }, + "objectType": { + "type": "reference", + "id": 73, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 86, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to `true`." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 36, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 89, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom `fetch` implementation." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 50, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 78, + "name": "Fetch" + } + }, + { + "id": 82, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optional headers for initializing the client." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 20, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 74, + "name": "GenericObject" + } + }, + { + "id": 87, + "name": "localStorage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A storage provider. Used to store the logged in session." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 40, + "character": 2 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "localStorage" + }, + "objectType": { + "type": "reference", + "id": 73, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 84, + "name": "multiTab", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Allows to enable/disable multi-tab/window events" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 28, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 85, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Whether to persist a logged in session to storage. Defaults to `true`." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 32, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 88, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Options passed to the realtime-js instance" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Options", + "package": "@supabase/realtime-js", + "name": "RealtimeClientOptions" + } + }, + { + "id": 81, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 16, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 90, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Throw errors, instead of returning them." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 55, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [83, 91, 86, 89, 82, 87, 84, 85, 88, 81, 90] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 12, + "character": 36 + } + ] + } + } + }, + { + "id": 102, + "name": "SupabaseEventTypes", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "INSERT" + }, + { + "type": "literal", + "value": "UPDATE" + }, + { + "type": "literal", + "value": "DELETE" + }, + { + "type": "literal", + "value": "*" + } + ] + } + }, + { + "id": 92, + "name": "SupabaseRealtimePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 63, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 101, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 93, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 94, + "name": "commit_timestamp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 64, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 100, + "name": "errors", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 72, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 95, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 65, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "INSERT" + }, + { + "type": "literal", + "value": "UPDATE" + }, + { + "type": "literal", + "value": "DELETE" + } + ] + } + }, + { + "id": 98, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The new record. Present for 'INSERT' and 'UPDATE' events." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 101, + "name": "T" + } + }, + { + "id": 99, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The previous record. Present for 'UPDATE' and 'DELETE' events." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 101, + "name": "T" + } + }, + { + "id": 96, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 97, + "name": "table", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 67, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [94, 100, 95, 98, 99, 96, 97] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 63, + "character": 41 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Interfaces", + "kind": 256, + "children": [73] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [78, 74, 79, 102, 92] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 103, + "name": "lib/version", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 104, + "name": "version", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, + "sources": [ + { + "fileName": "src/lib/version.ts", + "line": 1, + "character": 13 + } + ], + "type": { + "type": "literal", + "value": "0.0.0-automated" + }, + "defaultValue": "'0.0.0-automated'" + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [104] + } + ], + "sources": [ + { + "fileName": "src/lib/version.ts", + "line": 1, + "character": 0 + } + ] + } + ], + "groups": [ + { + "title": "Modules", + "kind": 2, + "children": [105, 1, 32, 59, 64, 72, 103] + } + ] +} diff --git a/v2/.nojekyll b/v2/.nojekyll new file mode 100644 index 00000000..e2ac6616 --- /dev/null +++ b/v2/.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/v2/assets/highlight.css b/v2/assets/highlight.css new file mode 100644 index 00000000..e0a86ada --- /dev/null +++ b/v2/assets/highlight.css @@ -0,0 +1,113 @@ +:root { + --light-hl-0: #000000; + --dark-hl-0: #D4D4D4; + --light-hl-1: #AF00DB; + --dark-hl-1: #C586C0; + --light-hl-2: #001080; + --dark-hl-2: #9CDCFE; + --light-hl-3: #A31515; + --dark-hl-3: #CE9178; + --light-hl-4: #008000; + --dark-hl-4: #6A9955; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; + --light-hl-7: #795E26; + --dark-hl-7: #DCDCAA; + --light-hl-8: #800000; + --dark-hl-8: #808080; + --light-hl-9: #800000; + --dark-hl-9: #569CD6; + --light-hl-10: #000000FF; + --dark-hl-10: #D4D4D4; + --light-hl-11: #FF0000; + --dark-hl-11: #9CDCFE; + --light-hl-12: #0000FF; + --dark-hl-12: #CE9178; + --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); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --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); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --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); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --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); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --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); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +pre, code { background: var(--code-background); } diff --git a/v2/assets/icons.css b/v2/assets/icons.css new file mode 100644 index 00000000..776a3562 --- /dev/null +++ b/v2/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/v2/assets/icons.png b/v2/assets/icons.png new file mode 100644 index 00000000..3836d5fe Binary files /dev/null and b/v2/assets/icons.png differ diff --git a/v2/assets/icons@2x.png b/v2/assets/icons@2x.png new file mode 100644 index 00000000..5a209e2f Binary files /dev/null and b/v2/assets/icons@2x.png differ diff --git a/v2/assets/main.js b/v2/assets/main.js new file mode 100644 index 00000000..bd45452d --- /dev/null +++ b/v2/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/v2/assets/search.js b/v2/assets/search.js new file mode 100644 index 00000000..792762bf --- /dev/null +++ b/v2/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"32\":\"Variable\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\",\"16777216\":\"Reference\"},\"rows\":[{\"id\":0,\"kind\":2,\"name\":\"index\",\"url\":\"modules/index.html\",\"classes\":\"tsd-kind-module\"},{\"id\":1,\"kind\":64,\"name\":\"createClient\",\"url\":\"modules/index.html#createClient\",\"classes\":\"tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter\",\"parent\":\"index\"},{\"id\":2,\"kind\":2,\"name\":\"lib/constants\",\"url\":\"modules/lib_constants.html\",\"classes\":\"tsd-kind-module\"},{\"id\":3,\"kind\":32,\"name\":\"DEFAULT_HEADERS\",\"url\":\"modules/lib_constants.html#DEFAULT_HEADERS\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"lib/constants\"},{\"id\":4,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_constants.html#DEFAULT_HEADERS.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"lib/constants.DEFAULT_HEADERS\"},{\"id\":5,\"kind\":1024,\"name\":\"X-Client-Info\",\"url\":\"modules/lib_constants.html#DEFAULT_HEADERS.__type.X_Client_Info\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/constants.DEFAULT_HEADERS.__type\"},{\"id\":6,\"kind\":2,\"name\":\"lib/fetch\",\"url\":\"modules/lib_fetch.html\",\"classes\":\"tsd-kind-module\"},{\"id\":7,\"kind\":64,\"name\":\"resolveFetch\",\"url\":\"modules/lib_fetch.html#resolveFetch\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"lib/fetch\"},{\"id\":8,\"kind\":64,\"name\":\"resolveHeadersConstructor\",\"url\":\"modules/lib_fetch.html#resolveHeadersConstructor\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"lib/fetch\"},{\"id\":9,\"kind\":64,\"name\":\"fetchWithAuth\",\"url\":\"modules/lib_fetch.html#fetchWithAuth\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"lib/fetch\"},{\"id\":10,\"kind\":2,\"name\":\"lib/helpers\",\"url\":\"modules/lib_helpers.html\",\"classes\":\"tsd-kind-module\"},{\"id\":11,\"kind\":64,\"name\":\"uuid\",\"url\":\"modules/lib_helpers.html#uuid\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"lib/helpers\"},{\"id\":12,\"kind\":64,\"name\":\"stripTrailingSlash\",\"url\":\"modules/lib_helpers.html#stripTrailingSlash\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"lib/helpers\"},{\"id\":13,\"kind\":64,\"name\":\"applySettingDefaults\",\"url\":\"modules/lib_helpers.html#applySettingDefaults\",\"classes\":\"tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter\",\"parent\":\"lib/helpers\"},{\"id\":14,\"kind\":64,\"name\":\"isBrowser\",\"url\":\"modules/lib_helpers.html#isBrowser\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"lib/helpers\"},{\"id\":15,\"kind\":2,\"name\":\"lib/types\",\"url\":\"modules/lib_types.html\",\"classes\":\"tsd-kind-module\"},{\"id\":16,\"kind\":256,\"name\":\"SupabaseAuthClientOptions\",\"url\":\"interfaces/lib_types.SupabaseAuthClientOptions.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"lib/types\"},{\"id\":17,\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/lib_types.SupabaseAuthClientOptions.html#__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"lib/types.SupabaseAuthClientOptions\"},{\"id\":18,\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/lib_types.SupabaseAuthClientOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"lib/types.SupabaseAuthClientOptions\"},{\"id\":19,\"kind\":4194304,\"name\":\"Fetch\",\"url\":\"modules/lib_types.html#Fetch\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"lib/types\"},{\"id\":20,\"kind\":4194304,\"name\":\"SupabaseClientOptions\",\"url\":\"modules/lib_types.html#SupabaseClientOptions\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter\",\"parent\":\"lib/types\"},{\"id\":21,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"lib/types.SupabaseClientOptions\"},{\"id\":22,\"kind\":1024,\"name\":\"db\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.db\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type\"},{\"id\":23,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-7\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type\"},{\"id\":24,\"kind\":1024,\"name\":\"schema\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-7.schema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type.__type\"},{\"id\":25,\"kind\":1024,\"name\":\"auth\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.auth\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type\"},{\"id\":26,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-6\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type\"},{\"id\":27,\"kind\":1024,\"name\":\"autoRefreshToken\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-6.autoRefreshToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type.__type\"},{\"id\":28,\"kind\":1024,\"name\":\"storageKey\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-6.storageKey\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type.__type\"},{\"id\":29,\"kind\":1024,\"name\":\"persistSession\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-6.persistSession\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type.__type\"},{\"id\":30,\"kind\":1024,\"name\":\"detectSessionInUrl\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-6.detectSessionInUrl\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type.__type\"},{\"id\":31,\"kind\":1024,\"name\":\"storage\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-6.storage\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type.__type\"},{\"id\":32,\"kind\":1024,\"name\":\"flowType\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-6.flowType\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type.__type\"},{\"id\":33,\"kind\":1024,\"name\":\"debug\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-6.debug\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type.__type\"},{\"id\":34,\"kind\":1024,\"name\":\"lock\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-6.lock\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type.__type\"},{\"id\":35,\"kind\":1024,\"name\":\"realtime\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.realtime\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type\"},{\"id\":36,\"kind\":1024,\"name\":\"global\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.global\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type\"},{\"id\":37,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-8\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type\"},{\"id\":38,\"kind\":1024,\"name\":\"fetch\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-8.fetch\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type.__type\"},{\"id\":39,\"kind\":1024,\"name\":\"headers\",\"url\":\"modules/lib_types.html#SupabaseClientOptions.__type-5.__type-8.headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.SupabaseClientOptions.__type.__type\"},{\"id\":40,\"kind\":4194304,\"name\":\"GenericTable\",\"url\":\"modules/lib_types.html#GenericTable\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"lib/types\"},{\"id\":41,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_types.html#GenericTable.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"lib/types.GenericTable\"},{\"id\":42,\"kind\":1024,\"name\":\"Row\",\"url\":\"modules/lib_types.html#GenericTable.__type-3.Row-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericTable.__type\"},{\"id\":43,\"kind\":1024,\"name\":\"Insert\",\"url\":\"modules/lib_types.html#GenericTable.__type-3.Insert\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericTable.__type\"},{\"id\":44,\"kind\":1024,\"name\":\"Update\",\"url\":\"modules/lib_types.html#GenericTable.__type-3.Update\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericTable.__type\"},{\"id\":45,\"kind\":4194304,\"name\":\"GenericUpdatableView\",\"url\":\"modules/lib_types.html#GenericUpdatableView\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"lib/types\"},{\"id\":46,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_types.html#GenericUpdatableView.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"lib/types.GenericUpdatableView\"},{\"id\":47,\"kind\":1024,\"name\":\"Row\",\"url\":\"modules/lib_types.html#GenericUpdatableView.__type-4.Row-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericUpdatableView.__type\"},{\"id\":48,\"kind\":1024,\"name\":\"Insert\",\"url\":\"modules/lib_types.html#GenericUpdatableView.__type-4.Insert-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericUpdatableView.__type\"},{\"id\":49,\"kind\":1024,\"name\":\"Update\",\"url\":\"modules/lib_types.html#GenericUpdatableView.__type-4.Update-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericUpdatableView.__type\"},{\"id\":50,\"kind\":4194304,\"name\":\"GenericNonUpdatableView\",\"url\":\"modules/lib_types.html#GenericNonUpdatableView\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"lib/types\"},{\"id\":51,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_types.html#GenericNonUpdatableView.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"lib/types.GenericNonUpdatableView\"},{\"id\":52,\"kind\":1024,\"name\":\"Row\",\"url\":\"modules/lib_types.html#GenericNonUpdatableView.__type-1.Row\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericNonUpdatableView.__type\"},{\"id\":53,\"kind\":4194304,\"name\":\"GenericView\",\"url\":\"modules/lib_types.html#GenericView\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"lib/types\"},{\"id\":54,\"kind\":4194304,\"name\":\"GenericFunction\",\"url\":\"modules/lib_types.html#GenericFunction\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"lib/types\"},{\"id\":55,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_types.html#GenericFunction.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"lib/types.GenericFunction\"},{\"id\":56,\"kind\":1024,\"name\":\"Args\",\"url\":\"modules/lib_types.html#GenericFunction.__type.Args\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericFunction.__type\"},{\"id\":57,\"kind\":1024,\"name\":\"Returns\",\"url\":\"modules/lib_types.html#GenericFunction.__type.Returns\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericFunction.__type\"},{\"id\":58,\"kind\":4194304,\"name\":\"GenericSchema\",\"url\":\"modules/lib_types.html#GenericSchema\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"lib/types\"},{\"id\":59,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_types.html#GenericSchema.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"lib/types.GenericSchema\"},{\"id\":60,\"kind\":1024,\"name\":\"Tables\",\"url\":\"modules/lib_types.html#GenericSchema.__type-2.Tables\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericSchema.__type\"},{\"id\":61,\"kind\":1024,\"name\":\"Views\",\"url\":\"modules/lib_types.html#GenericSchema.__type-2.Views\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericSchema.__type\"},{\"id\":62,\"kind\":1024,\"name\":\"Functions\",\"url\":\"modules/lib_types.html#GenericSchema.__type-2.Functions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"lib/types.GenericSchema.__type\"},{\"id\":63,\"kind\":2,\"name\":\"lib/version\",\"url\":\"modules/lib_version.html\",\"classes\":\"tsd-kind-module\"},{\"id\":64,\"kind\":32,\"name\":\"version\",\"url\":\"modules/lib_version.html#version\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"lib/version\"},{\"id\":65,\"kind\":128,\"name\":\"SupabaseClient\",\"url\":\"classes/index.SupabaseClient.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter\",\"parent\":\"index\"},{\"id\":66,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/index.SupabaseClient.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"index.SupabaseClient\"},{\"id\":67,\"kind\":1024,\"name\":\"auth\",\"url\":\"classes/index.SupabaseClient.html#auth\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"index.SupabaseClient\"},{\"id\":68,\"kind\":1024,\"name\":\"realtime\",\"url\":\"classes/index.SupabaseClient.html#realtime\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"index.SupabaseClient\"},{\"id\":69,\"kind\":1024,\"name\":\"realtimeUrl\",\"url\":\"classes/index.SupabaseClient.html#realtimeUrl\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"index.SupabaseClient\"},{\"id\":70,\"kind\":1024,\"name\":\"authUrl\",\"url\":\"classes/index.SupabaseClient.html#authUrl\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"index.SupabaseClient\"},{\"id\":71,\"kind\":1024,\"name\":\"storageUrl\",\"url\":\"classes/index.SupabaseClient.html#storageUrl\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"index.SupabaseClient\"},{\"id\":72,\"kind\":1024,\"name\":\"functionsUrl\",\"url\":\"classes/index.SupabaseClient.html#functionsUrl\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"index.SupabaseClient\"},{\"id\":73,\"kind\":1024,\"name\":\"rest\",\"url\":\"classes/index.SupabaseClient.html#rest\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"index.SupabaseClient\"},{\"id\":74,\"kind\":1024,\"name\":\"storageKey\",\"url\":\"classes/index.SupabaseClient.html#storageKey\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"index.SupabaseClient\"},{\"id\":75,\"kind\":1024,\"name\":\"fetch\",\"url\":\"classes/index.SupabaseClient.html#fetch\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"index.SupabaseClient\"},{\"id\":76,\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/index.SupabaseClient.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-class\",\"parent\":\"index.SupabaseClient\"},{\"id\":77,\"kind\":1024,\"name\":\"changedAccessToken\",\"url\":\"classes/index.SupabaseClient.html#changedAccessToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"index.SupabaseClient\"},{\"id\":78,\"kind\":1024,\"name\":\"headers\",\"url\":\"classes/index.SupabaseClient.html#headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"index.SupabaseClient\"},{\"id\":79,\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/index.SupabaseClient.html#__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-class\",\"parent\":\"index.SupabaseClient\"},{\"id\":80,\"kind\":1024,\"name\":\"supabaseUrl\",\"url\":\"classes/index.SupabaseClient.html#supabaseUrl\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"index.SupabaseClient\"},{\"id\":81,\"kind\":1024,\"name\":\"supabaseKey\",\"url\":\"classes/index.SupabaseClient.html#supabaseKey\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"index.SupabaseClient\"},{\"id\":82,\"kind\":262144,\"name\":\"functions\",\"url\":\"classes/index.SupabaseClient.html#functions\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"index.SupabaseClient\"},{\"id\":83,\"kind\":262144,\"name\":\"storage\",\"url\":\"classes/index.SupabaseClient.html#storage\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"index.SupabaseClient\"},{\"id\":84,\"kind\":2048,\"name\":\"from\",\"url\":\"classes/index.SupabaseClient.html#from\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"index.SupabaseClient\"},{\"id\":85,\"kind\":2048,\"name\":\"schema\",\"url\":\"classes/index.SupabaseClient.html#schema\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"index.SupabaseClient\"},{\"id\":86,\"kind\":2048,\"name\":\"rpc\",\"url\":\"classes/index.SupabaseClient.html#rpc\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"index.SupabaseClient\"},{\"id\":87,\"kind\":2048,\"name\":\"channel\",\"url\":\"classes/index.SupabaseClient.html#channel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"index.SupabaseClient\"},{\"id\":88,\"kind\":2048,\"name\":\"getChannels\",\"url\":\"classes/index.SupabaseClient.html#getChannels\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"index.SupabaseClient\"},{\"id\":89,\"kind\":2048,\"name\":\"removeChannel\",\"url\":\"classes/index.SupabaseClient.html#removeChannel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"index.SupabaseClient\"},{\"id\":90,\"kind\":2048,\"name\":\"removeAllChannels\",\"url\":\"classes/index.SupabaseClient.html#removeAllChannels\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"index.SupabaseClient\"},{\"id\":91,\"kind\":2048,\"name\":\"_getAccessToken\",\"url\":\"classes/index.SupabaseClient.html#_getAccessToken\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-private\",\"parent\":\"index.SupabaseClient\"},{\"id\":92,\"kind\":2048,\"name\":\"_initSupabaseAuthClient\",\"url\":\"classes/index.SupabaseClient.html#_initSupabaseAuthClient\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-private\",\"parent\":\"index.SupabaseClient\"},{\"id\":93,\"kind\":2048,\"name\":\"_initRealtimeClient\",\"url\":\"classes/index.SupabaseClient.html#_initRealtimeClient\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-private\",\"parent\":\"index.SupabaseClient\"},{\"id\":94,\"kind\":2048,\"name\":\"_listenForAuthEvents\",\"url\":\"classes/index.SupabaseClient.html#_listenForAuthEvents\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-private\",\"parent\":\"index.SupabaseClient\"},{\"id\":95,\"kind\":2048,\"name\":\"_handleTokenChanged\",\"url\":\"classes/index.SupabaseClient.html#_handleTokenChanged\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-private\",\"parent\":\"index.SupabaseClient\"},{\"id\":96,\"kind\":16777216,\"name\":\"SupabaseClientOptions\",\"url\":\"modules/index.html#SupabaseClientOptions\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":97,\"kind\":16777216,\"name\":\"Session\",\"url\":\"modules/index.html#Session\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":98,\"kind\":16777216,\"name\":\"User\",\"url\":\"modules/index.html#User\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,27.557]],[\"parent/0\",[]],[\"name/1\",[1,42.34]],[\"parent/1\",[0,2.663]],[\"name/2\",[2,37.19]],[\"parent/2\",[]],[\"name/3\",[3,42.34]],[\"parent/3\",[2,3.594]],[\"name/4\",[4,19.468]],[\"parent/4\",[5,4.092]],[\"name/5\",[6,23.411,7,23.411,8,23.411]],[\"parent/5\",[9,4.092]],[\"name/6\",[10,31.264]],[\"parent/6\",[]],[\"name/7\",[11,42.34]],[\"parent/7\",[10,3.021]],[\"name/8\",[12,42.34]],[\"parent/8\",[10,3.021]],[\"name/9\",[13,42.34]],[\"parent/9\",[10,3.021]],[\"name/10\",[14,29.241]],[\"parent/10\",[]],[\"name/11\",[15,42.34]],[\"parent/11\",[14,2.826]],[\"name/12\",[16,42.34]],[\"parent/12\",[14,2.826]],[\"name/13\",[17,42.34]],[\"parent/13\",[14,2.826]],[\"name/14\",[18,42.34]],[\"parent/14\",[14,2.826]],[\"name/15\",[19,22.722]],[\"parent/15\",[]],[\"name/16\",[20,42.34]],[\"parent/16\",[19,2.196]],[\"name/17\",[4,19.468]],[\"parent/17\",[21,3.594]],[\"name/18\",[4,19.468]],[\"parent/18\",[21,3.594]],[\"name/19\",[22,33.798]],[\"parent/19\",[19,2.196]],[\"name/20\",[23,37.19]],[\"parent/20\",[19,2.196]],[\"name/21\",[4,19.468]],[\"parent/21\",[24,4.092]],[\"name/22\",[25,42.34]],[\"parent/22\",[26,2.524]],[\"name/23\",[4,19.468]],[\"parent/23\",[26,2.524]],[\"name/24\",[27,37.19]],[\"parent/24\",[28,2.107]],[\"name/25\",[29,37.19]],[\"parent/25\",[26,2.524]],[\"name/26\",[4,19.468]],[\"parent/26\",[26,2.524]],[\"name/27\",[30,42.34]],[\"parent/27\",[28,2.107]],[\"name/28\",[31,37.19]],[\"parent/28\",[28,2.107]],[\"name/29\",[32,42.34]],[\"parent/29\",[28,2.107]],[\"name/30\",[33,42.34]],[\"parent/30\",[28,2.107]],[\"name/31\",[34,37.19]],[\"parent/31\",[28,2.107]],[\"name/32\",[35,42.34]],[\"parent/32\",[28,2.107]],[\"name/33\",[36,42.34]],[\"parent/33\",[28,2.107]],[\"name/34\",[37,42.34]],[\"parent/34\",[28,2.107]],[\"name/35\",[38,37.19]],[\"parent/35\",[26,2.524]],[\"name/36\",[39,42.34]],[\"parent/36\",[26,2.524]],[\"name/37\",[4,19.468]],[\"parent/37\",[26,2.524]],[\"name/38\",[22,33.798]],[\"parent/38\",[28,2.107]],[\"name/39\",[40,37.19]],[\"parent/39\",[28,2.107]],[\"name/40\",[41,42.34]],[\"parent/40\",[19,2.196]],[\"name/41\",[4,19.468]],[\"parent/41\",[42,4.092]],[\"name/42\",[43,33.798]],[\"parent/42\",[44,3.266]],[\"name/43\",[45,37.19]],[\"parent/43\",[44,3.266]],[\"name/44\",[46,37.19]],[\"parent/44\",[44,3.266]],[\"name/45\",[47,42.34]],[\"parent/45\",[19,2.196]],[\"name/46\",[4,19.468]],[\"parent/46\",[48,4.092]],[\"name/47\",[43,33.798]],[\"parent/47\",[49,3.266]],[\"name/48\",[45,37.19]],[\"parent/48\",[49,3.266]],[\"name/49\",[46,37.19]],[\"parent/49\",[49,3.266]],[\"name/50\",[50,42.34]],[\"parent/50\",[19,2.196]],[\"name/51\",[4,19.468]],[\"parent/51\",[51,4.092]],[\"name/52\",[43,33.798]],[\"parent/52\",[52,4.092]],[\"name/53\",[53,42.34]],[\"parent/53\",[19,2.196]],[\"name/54\",[54,42.34]],[\"parent/54\",[19,2.196]],[\"name/55\",[4,19.468]],[\"parent/55\",[55,4.092]],[\"name/56\",[56,42.34]],[\"parent/56\",[57,3.594]],[\"name/57\",[58,42.34]],[\"parent/57\",[57,3.594]],[\"name/58\",[59,42.34]],[\"parent/58\",[19,2.196]],[\"name/59\",[4,19.468]],[\"parent/59\",[60,4.092]],[\"name/60\",[61,42.34]],[\"parent/60\",[62,3.266]],[\"name/61\",[63,42.34]],[\"parent/61\",[62,3.266]],[\"name/62\",[64,37.19]],[\"parent/62\",[62,3.266]],[\"name/63\",[65,37.19]],[\"parent/63\",[]],[\"name/64\",[66,42.34]],[\"parent/64\",[65,3.594]],[\"name/65\",[67,42.34]],[\"parent/65\",[0,2.663]],[\"name/66\",[68,42.34]],[\"parent/66\",[69,1.157]],[\"name/67\",[29,37.19]],[\"parent/67\",[69,1.157]],[\"name/68\",[38,37.19]],[\"parent/68\",[69,1.157]],[\"name/69\",[70,42.34]],[\"parent/69\",[69,1.157]],[\"name/70\",[71,42.34]],[\"parent/70\",[69,1.157]],[\"name/71\",[72,42.34]],[\"parent/71\",[69,1.157]],[\"name/72\",[73,42.34]],[\"parent/72\",[69,1.157]],[\"name/73\",[74,42.34]],[\"parent/73\",[69,1.157]],[\"name/74\",[31,37.19]],[\"parent/74\",[69,1.157]],[\"name/75\",[22,33.798]],[\"parent/75\",[69,1.157]],[\"name/76\",[4,19.468]],[\"parent/76\",[69,1.157]],[\"name/77\",[75,42.34]],[\"parent/77\",[69,1.157]],[\"name/78\",[40,37.19]],[\"parent/78\",[69,1.157]],[\"name/79\",[4,19.468]],[\"parent/79\",[69,1.157]],[\"name/80\",[76,42.34]],[\"parent/80\",[69,1.157]],[\"name/81\",[77,42.34]],[\"parent/81\",[69,1.157]],[\"name/82\",[64,37.19]],[\"parent/82\",[69,1.157]],[\"name/83\",[34,37.19]],[\"parent/83\",[69,1.157]],[\"name/84\",[78,42.34]],[\"parent/84\",[69,1.157]],[\"name/85\",[27,37.19]],[\"parent/85\",[69,1.157]],[\"name/86\",[79,42.34]],[\"parent/86\",[69,1.157]],[\"name/87\",[80,42.34]],[\"parent/87\",[69,1.157]],[\"name/88\",[81,42.34]],[\"parent/88\",[69,1.157]],[\"name/89\",[82,42.34]],[\"parent/89\",[69,1.157]],[\"name/90\",[83,42.34]],[\"parent/90\",[69,1.157]],[\"name/91\",[84,42.34]],[\"parent/91\",[69,1.157]],[\"name/92\",[85,42.34]],[\"parent/92\",[69,1.157]],[\"name/93\",[86,42.34]],[\"parent/93\",[69,1.157]],[\"name/94\",[87,42.34]],[\"parent/94\",[69,1.157]],[\"name/95\",[88,42.34]],[\"parent/95\",[69,1.157]],[\"name/96\",[23,37.19]],[\"parent/96\",[0,2.663]],[\"name/97\",[89,42.34]],[\"parent/97\",[0,2.663]],[\"name/98\",[90,42.34]],[\"parent/98\",[0,2.663]]],\"invertedIndex\":[[\"__type\",{\"_index\":4,\"name\":{\"4\":{},\"17\":{},\"18\":{},\"21\":{},\"23\":{},\"26\":{},\"37\":{},\"41\":{},\"46\":{},\"51\":{},\"55\":{},\"59\":{},\"76\":{},\"79\":{}},\"parent\":{}}],[\"_getaccesstoken\",{\"_index\":84,\"name\":{\"91\":{}},\"parent\":{}}],[\"_handletokenchanged\",{\"_index\":88,\"name\":{\"95\":{}},\"parent\":{}}],[\"_initrealtimeclient\",{\"_index\":86,\"name\":{\"93\":{}},\"parent\":{}}],[\"_initsupabaseauthclient\",{\"_index\":85,\"name\":{\"92\":{}},\"parent\":{}}],[\"_listenforauthevents\",{\"_index\":87,\"name\":{\"94\":{}},\"parent\":{}}],[\"applysettingdefaults\",{\"_index\":17,\"name\":{\"13\":{}},\"parent\":{}}],[\"args\",{\"_index\":56,\"name\":{\"56\":{}},\"parent\":{}}],[\"auth\",{\"_index\":29,\"name\":{\"25\":{},\"67\":{}},\"parent\":{}}],[\"authurl\",{\"_index\":71,\"name\":{\"70\":{}},\"parent\":{}}],[\"autorefreshtoken\",{\"_index\":30,\"name\":{\"27\":{}},\"parent\":{}}],[\"changedaccesstoken\",{\"_index\":75,\"name\":{\"77\":{}},\"parent\":{}}],[\"channel\",{\"_index\":80,\"name\":{\"87\":{}},\"parent\":{}}],[\"client\",{\"_index\":7,\"name\":{\"5\":{}},\"parent\":{}}],[\"constructor\",{\"_index\":68,\"name\":{\"66\":{}},\"parent\":{}}],[\"createclient\",{\"_index\":1,\"name\":{\"1\":{}},\"parent\":{}}],[\"db\",{\"_index\":25,\"name\":{\"22\":{}},\"parent\":{}}],[\"debug\",{\"_index\":36,\"name\":{\"33\":{}},\"parent\":{}}],[\"default_headers\",{\"_index\":3,\"name\":{\"3\":{}},\"parent\":{}}],[\"detectsessioninurl\",{\"_index\":33,\"name\":{\"30\":{}},\"parent\":{}}],[\"fetch\",{\"_index\":22,\"name\":{\"19\":{},\"38\":{},\"75\":{}},\"parent\":{}}],[\"fetchwithauth\",{\"_index\":13,\"name\":{\"9\":{}},\"parent\":{}}],[\"flowtype\",{\"_index\":35,\"name\":{\"32\":{}},\"parent\":{}}],[\"from\",{\"_index\":78,\"name\":{\"84\":{}},\"parent\":{}}],[\"functions\",{\"_index\":64,\"name\":{\"62\":{},\"82\":{}},\"parent\":{}}],[\"functionsurl\",{\"_index\":73,\"name\":{\"72\":{}},\"parent\":{}}],[\"genericfunction\",{\"_index\":54,\"name\":{\"54\":{}},\"parent\":{}}],[\"genericnonupdatableview\",{\"_index\":50,\"name\":{\"50\":{}},\"parent\":{}}],[\"genericschema\",{\"_index\":59,\"name\":{\"58\":{}},\"parent\":{}}],[\"generictable\",{\"_index\":41,\"name\":{\"40\":{}},\"parent\":{}}],[\"genericupdatableview\",{\"_index\":47,\"name\":{\"45\":{}},\"parent\":{}}],[\"genericview\",{\"_index\":53,\"name\":{\"53\":{}},\"parent\":{}}],[\"getchannels\",{\"_index\":81,\"name\":{\"88\":{}},\"parent\":{}}],[\"global\",{\"_index\":39,\"name\":{\"36\":{}},\"parent\":{}}],[\"headers\",{\"_index\":40,\"name\":{\"39\":{},\"78\":{}},\"parent\":{}}],[\"index\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{\"1\":{},\"65\":{},\"96\":{},\"97\":{},\"98\":{}}}],[\"index.supabaseclient\",{\"_index\":69,\"name\":{},\"parent\":{\"66\":{},\"67\":{},\"68\":{},\"69\":{},\"70\":{},\"71\":{},\"72\":{},\"73\":{},\"74\":{},\"75\":{},\"76\":{},\"77\":{},\"78\":{},\"79\":{},\"80\":{},\"81\":{},\"82\":{},\"83\":{},\"84\":{},\"85\":{},\"86\":{},\"87\":{},\"88\":{},\"89\":{},\"90\":{},\"91\":{},\"92\":{},\"93\":{},\"94\":{},\"95\":{}}}],[\"info\",{\"_index\":8,\"name\":{\"5\":{}},\"parent\":{}}],[\"insert\",{\"_index\":45,\"name\":{\"43\":{},\"48\":{}},\"parent\":{}}],[\"isbrowser\",{\"_index\":18,\"name\":{\"14\":{}},\"parent\":{}}],[\"lib/constants\",{\"_index\":2,\"name\":{\"2\":{}},\"parent\":{\"3\":{}}}],[\"lib/constants.default_headers\",{\"_index\":5,\"name\":{},\"parent\":{\"4\":{}}}],[\"lib/constants.default_headers.__type\",{\"_index\":9,\"name\":{},\"parent\":{\"5\":{}}}],[\"lib/fetch\",{\"_index\":10,\"name\":{\"6\":{}},\"parent\":{\"7\":{},\"8\":{},\"9\":{}}}],[\"lib/helpers\",{\"_index\":14,\"name\":{\"10\":{}},\"parent\":{\"11\":{},\"12\":{},\"13\":{},\"14\":{}}}],[\"lib/types\",{\"_index\":19,\"name\":{\"15\":{}},\"parent\":{\"16\":{},\"19\":{},\"20\":{},\"40\":{},\"45\":{},\"50\":{},\"53\":{},\"54\":{},\"58\":{}}}],[\"lib/types.genericfunction\",{\"_index\":55,\"name\":{},\"parent\":{\"55\":{}}}],[\"lib/types.genericfunction.__type\",{\"_index\":57,\"name\":{},\"parent\":{\"56\":{},\"57\":{}}}],[\"lib/types.genericnonupdatableview\",{\"_index\":51,\"name\":{},\"parent\":{\"51\":{}}}],[\"lib/types.genericnonupdatableview.__type\",{\"_index\":52,\"name\":{},\"parent\":{\"52\":{}}}],[\"lib/types.genericschema\",{\"_index\":60,\"name\":{},\"parent\":{\"59\":{}}}],[\"lib/types.genericschema.__type\",{\"_index\":62,\"name\":{},\"parent\":{\"60\":{},\"61\":{},\"62\":{}}}],[\"lib/types.generictable\",{\"_index\":42,\"name\":{},\"parent\":{\"41\":{}}}],[\"lib/types.generictable.__type\",{\"_index\":44,\"name\":{},\"parent\":{\"42\":{},\"43\":{},\"44\":{}}}],[\"lib/types.genericupdatableview\",{\"_index\":48,\"name\":{},\"parent\":{\"46\":{}}}],[\"lib/types.genericupdatableview.__type\",{\"_index\":49,\"name\":{},\"parent\":{\"47\":{},\"48\":{},\"49\":{}}}],[\"lib/types.supabaseauthclientoptions\",{\"_index\":21,\"name\":{},\"parent\":{\"17\":{},\"18\":{}}}],[\"lib/types.supabaseclientoptions\",{\"_index\":24,\"name\":{},\"parent\":{\"21\":{}}}],[\"lib/types.supabaseclientoptions.__type\",{\"_index\":26,\"name\":{},\"parent\":{\"22\":{},\"23\":{},\"25\":{},\"26\":{},\"35\":{},\"36\":{},\"37\":{}}}],[\"lib/types.supabaseclientoptions.__type.__type\",{\"_index\":28,\"name\":{},\"parent\":{\"24\":{},\"27\":{},\"28\":{},\"29\":{},\"30\":{},\"31\":{},\"32\":{},\"33\":{},\"34\":{},\"38\":{},\"39\":{}}}],[\"lib/version\",{\"_index\":65,\"name\":{\"63\":{}},\"parent\":{\"64\":{}}}],[\"lock\",{\"_index\":37,\"name\":{\"34\":{}},\"parent\":{}}],[\"persistsession\",{\"_index\":32,\"name\":{\"29\":{}},\"parent\":{}}],[\"realtime\",{\"_index\":38,\"name\":{\"35\":{},\"68\":{}},\"parent\":{}}],[\"realtimeurl\",{\"_index\":70,\"name\":{\"69\":{}},\"parent\":{}}],[\"removeallchannels\",{\"_index\":83,\"name\":{\"90\":{}},\"parent\":{}}],[\"removechannel\",{\"_index\":82,\"name\":{\"89\":{}},\"parent\":{}}],[\"resolvefetch\",{\"_index\":11,\"name\":{\"7\":{}},\"parent\":{}}],[\"resolveheadersconstructor\",{\"_index\":12,\"name\":{\"8\":{}},\"parent\":{}}],[\"rest\",{\"_index\":74,\"name\":{\"73\":{}},\"parent\":{}}],[\"returns\",{\"_index\":58,\"name\":{\"57\":{}},\"parent\":{}}],[\"row\",{\"_index\":43,\"name\":{\"42\":{},\"47\":{},\"52\":{}},\"parent\":{}}],[\"rpc\",{\"_index\":79,\"name\":{\"86\":{}},\"parent\":{}}],[\"schema\",{\"_index\":27,\"name\":{\"24\":{},\"85\":{}},\"parent\":{}}],[\"session\",{\"_index\":89,\"name\":{\"97\":{}},\"parent\":{}}],[\"storage\",{\"_index\":34,\"name\":{\"31\":{},\"83\":{}},\"parent\":{}}],[\"storagekey\",{\"_index\":31,\"name\":{\"28\":{},\"74\":{}},\"parent\":{}}],[\"storageurl\",{\"_index\":72,\"name\":{\"71\":{}},\"parent\":{}}],[\"striptrailingslash\",{\"_index\":16,\"name\":{\"12\":{}},\"parent\":{}}],[\"supabaseauthclientoptions\",{\"_index\":20,\"name\":{\"16\":{}},\"parent\":{}}],[\"supabaseclient\",{\"_index\":67,\"name\":{\"65\":{}},\"parent\":{}}],[\"supabaseclientoptions\",{\"_index\":23,\"name\":{\"20\":{},\"96\":{}},\"parent\":{}}],[\"supabasekey\",{\"_index\":77,\"name\":{\"81\":{}},\"parent\":{}}],[\"supabaseurl\",{\"_index\":76,\"name\":{\"80\":{}},\"parent\":{}}],[\"tables\",{\"_index\":61,\"name\":{\"60\":{}},\"parent\":{}}],[\"update\",{\"_index\":46,\"name\":{\"44\":{},\"49\":{}},\"parent\":{}}],[\"user\",{\"_index\":90,\"name\":{\"98\":{}},\"parent\":{}}],[\"uuid\",{\"_index\":15,\"name\":{\"11\":{}},\"parent\":{}}],[\"version\",{\"_index\":66,\"name\":{\"64\":{}},\"parent\":{}}],[\"views\",{\"_index\":63,\"name\":{\"61\":{}},\"parent\":{}}],[\"x\",{\"_index\":6,\"name\":{\"5\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/v2/assets/style.css b/v2/assets/style.css new file mode 100644 index 00000000..6127b27c --- /dev/null +++ b/v2/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/v2/assets/widgets.png b/v2/assets/widgets.png new file mode 100644 index 00000000..c7380532 Binary files /dev/null and b/v2/assets/widgets.png differ diff --git a/v2/assets/widgets@2x.png b/v2/assets/widgets@2x.png new file mode 100644 index 00000000..4bbbd572 Binary files /dev/null and b/v2/assets/widgets@2x.png differ diff --git a/v2/classes/index.AuthApiError.html b/v2/classes/index.AuthApiError.html new file mode 100644 index 00000000..7a156025 --- /dev/null +++ b/v2/classes/index.AuthApiError.html @@ -0,0 +1,6 @@ +AuthApiError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      • new AuthApiError(message: string, status: number): AuthApiError
      • Parameters

        • message: string
        • status: number

        Returns AuthApiError

      Properties

      __isAuthError: boolean
      message: string
      name: string
      stack?: string
      status: number
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

      • toJSON(): { message: string; name: string; status: number }
      • Returns { message: string; name: string; status: number }

        • message: string
        • name: string
        • status: number
      • captureStackTrace(targetObject: object, constructorOpt?: Function): void
      • +

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.AuthError.html b/v2/classes/index.AuthError.html new file mode 100644 index 00000000..13ffca51 --- /dev/null +++ b/v2/classes/index.AuthError.html @@ -0,0 +1,6 @@ +AuthError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      • new AuthError(message: string, status?: number): AuthError
      • Parameters

        • message: string
        • Optional status: number

        Returns AuthError

      Properties

      __isAuthError: boolean
      message: string
      name: string
      stack?: string
      status: undefined | number
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

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

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

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

      Hierarchy

      Index

      Constructors

      Properties

      __isAuthError: boolean
      details: null | { code: string; error: string }
      message: string
      name: string
      stack?: string
      status: number
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

      • toJSON(): { details: null | { code: string; error: string }; message: string; name: string; status: number }
      • Returns { details: null | { code: string; error: string }; message: string; name: string; status: number }

        • details: null | { code: string; error: string }
        • message: string
        • name: string
        • status: number
      • captureStackTrace(targetObject: object, constructorOpt?: Function): void
      • +

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.AuthInvalidCredentialsError.html b/v2/classes/index.AuthInvalidCredentialsError.html new file mode 100644 index 00000000..5f6f61c8 --- /dev/null +++ b/v2/classes/index.AuthInvalidCredentialsError.html @@ -0,0 +1,6 @@ +AuthInvalidCredentialsError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      Properties

      __isAuthError: boolean
      message: string
      name: string
      stack?: string
      status: number
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

      • toJSON(): { message: string; name: string; status: number }
      • Returns { message: string; name: string; status: number }

        • message: string
        • name: string
        • status: number
      • captureStackTrace(targetObject: object, constructorOpt?: Function): void
      • +

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.AuthInvalidTokenResponseError.html b/v2/classes/index.AuthInvalidTokenResponseError.html new file mode 100644 index 00000000..a9b2fd98 --- /dev/null +++ b/v2/classes/index.AuthInvalidTokenResponseError.html @@ -0,0 +1,6 @@ +AuthInvalidTokenResponseError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      Properties

      __isAuthError: boolean
      message: string
      name: string
      stack?: string
      status: number
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

      • toJSON(): { message: string; name: string; status: number }
      • Returns { message: string; name: string; status: number }

        • message: string
        • name: string
        • status: number
      • captureStackTrace(targetObject: object, constructorOpt?: Function): void
      • +

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.AuthPKCEGrantCodeExchangeError.html b/v2/classes/index.AuthPKCEGrantCodeExchangeError.html new file mode 100644 index 00000000..1d567f6d --- /dev/null +++ b/v2/classes/index.AuthPKCEGrantCodeExchangeError.html @@ -0,0 +1,6 @@ +AuthPKCEGrantCodeExchangeError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      Properties

      __isAuthError: boolean
      details: null | { code: string; error: string }
      message: string
      name: string
      stack?: string
      status: number
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

      • toJSON(): { details: null | { code: string; error: string }; message: string; name: string; status: number }
      • Returns { details: null | { code: string; error: string }; message: string; name: string; status: number }

        • details: null | { code: string; error: string }
        • message: string
        • name: string
        • status: number
      • captureStackTrace(targetObject: object, constructorOpt?: Function): void
      • +

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.AuthRetryableFetchError.html b/v2/classes/index.AuthRetryableFetchError.html new file mode 100644 index 00000000..c3b9ba98 --- /dev/null +++ b/v2/classes/index.AuthRetryableFetchError.html @@ -0,0 +1,6 @@ +AuthRetryableFetchError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      Properties

      __isAuthError: boolean
      message: string
      name: string
      stack?: string
      status: number
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

      • toJSON(): { message: string; name: string; status: number }
      • Returns { message: string; name: string; status: number }

        • message: string
        • name: string
        • status: number
      • captureStackTrace(targetObject: object, constructorOpt?: Function): void
      • +

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.AuthSessionMissingError.html b/v2/classes/index.AuthSessionMissingError.html new file mode 100644 index 00000000..372a49b8 --- /dev/null +++ b/v2/classes/index.AuthSessionMissingError.html @@ -0,0 +1,6 @@ +AuthSessionMissingError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      Properties

      __isAuthError: boolean
      message: string
      name: string
      stack?: string
      status: number
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

      • toJSON(): { message: string; name: string; status: number }
      • Returns { message: string; name: string; status: number }

        • message: string
        • name: string
        • status: number
      • captureStackTrace(targetObject: object, constructorOpt?: Function): void
      • +

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.AuthUnknownError.html b/v2/classes/index.AuthUnknownError.html new file mode 100644 index 00000000..87343377 --- /dev/null +++ b/v2/classes/index.AuthUnknownError.html @@ -0,0 +1,6 @@ +AuthUnknownError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      Properties

      __isAuthError: boolean
      message: string
      name: string
      originalError: unknown
      stack?: string
      status: undefined | number
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

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

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.CustomAuthError.html b/v2/classes/index.CustomAuthError.html new file mode 100644 index 00000000..f855b152 --- /dev/null +++ b/v2/classes/index.CustomAuthError.html @@ -0,0 +1,6 @@ +CustomAuthError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      • new CustomAuthError(message: string, name: string, status: number): CustomAuthError
      • Parameters

        • message: string
        • name: string
        • status: number

        Returns CustomAuthError

      Properties

      __isAuthError: boolean
      message: string
      name: string
      stack?: string
      status: number
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

      • toJSON(): { message: string; name: string; status: number }
      • Returns { message: string; name: string; status: number }

        • message: string
        • name: string
        • status: number
      • captureStackTrace(targetObject: object, constructorOpt?: Function): void
      • +

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.FunctionsError.html b/v2/classes/index.FunctionsError.html new file mode 100644 index 00000000..aacc5cf9 --- /dev/null +++ b/v2/classes/index.FunctionsError.html @@ -0,0 +1,6 @@ +FunctionsError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      • new FunctionsError(message: string, name?: string, context?: any): FunctionsError
      • Parameters

        • message: string
        • Optional name: string
        • Optional context: any

        Returns FunctionsError

      Properties

      context: any
      message: string
      name: string
      stack?: string
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

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

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.FunctionsFetchError.html b/v2/classes/index.FunctionsFetchError.html new file mode 100644 index 00000000..7f97f8de --- /dev/null +++ b/v2/classes/index.FunctionsFetchError.html @@ -0,0 +1,8 @@ +FunctionsFetchError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      Properties

      context: any
      message: string
      name: string
      stack?: string
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)
      +

      Optional override for formatting stack traces

      +

      Type declaration

      stackTraceLimit: number

      Methods

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

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.FunctionsHttpError.html b/v2/classes/index.FunctionsHttpError.html new file mode 100644 index 00000000..f5a9ff0b --- /dev/null +++ b/v2/classes/index.FunctionsHttpError.html @@ -0,0 +1,8 @@ +FunctionsHttpError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      Properties

      context: any
      message: string
      name: string
      stack?: string
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)
      +

      Optional override for formatting stack traces

      +

      Type declaration

      stackTraceLimit: number

      Methods

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

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.FunctionsRelayError.html b/v2/classes/index.FunctionsRelayError.html new file mode 100644 index 00000000..1529691b --- /dev/null +++ b/v2/classes/index.FunctionsRelayError.html @@ -0,0 +1,8 @@ +FunctionsRelayError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      Index

      Constructors

      Properties

      context: any
      message: string
      name: string
      stack?: string
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)
      +

      Optional override for formatting stack traces

      +

      Type declaration

      stackTraceLimit: number

      Methods

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

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.GoTrueAdminApi.html b/v2/classes/index.GoTrueAdminApi.html new file mode 100644 index 00000000..04ac6b66 --- /dev/null +++ b/v2/classes/index.GoTrueAdminApi.html @@ -0,0 +1,47 @@ +GoTrueAdminApi | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      • GoTrueAdminApi

      Index

      Constructors

      • new GoTrueAdminApi(__namedParameters: { fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers?: {}; url: string }): GoTrueAdminApi
      • Parameters

        • __namedParameters: { fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers?: {}; url: string }
          • Optional fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
              • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
              • Parameters

                • input: RequestInfo | URL
                • Optional init: RequestInit

                Returns Promise<Response>

          • Optional headers?: {}
            • [key: string]: string
          • url: string

        Returns GoTrueAdminApi

      Properties

      _deleteFactor: any
      _listFactors: any
      fetch: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

      Type declaration

        • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
        • Parameters

          • input: RequestInfo | URL
          • Optional init: RequestInit

          Returns Promise<Response>

      headers: {}

      Type declaration

      • [key: string]: string
      +

      Contains all MFA administration methods.

      +
      url: string

      Methods

      • +

        Creates a new user. +This function should only be called on a server. Never expose your service_role key in the browser.

        +

        Parameters

        Returns Promise<UserResponse>

      • deleteUser(id: string, shouldSoftDelete?: boolean): Promise<UserResponse>
      • +

        Delete a user. Requires a service_role key.

        +

        Parameters

        • id: string
          +

          The user id you want to remove.

          +
        • Optional shouldSoftDelete: boolean
          +

          If true, then the user will be soft-deleted from the auth schema. +Defaults to false for backward compatibility.

          +

          This function should only be called on a server. Never expose your service_role key in the browser.

          +

        Returns Promise<UserResponse>

      • +

        Generates email links and OTPs to be sent via a custom email provider.

        +

        Parameters

        Returns Promise<GenerateLinkResponse>

      • +

        Get user by id.

        +

        Parameters

        • uid: string
          +

          The user's unique identifier

          +

          This function should only be called on a server. Never expose your service_role key in the browser.

          +

        Returns Promise<UserResponse>

      • inviteUserByEmail(email: string, options?: { data?: object; redirectTo?: string }): Promise<UserResponse>
      • +

        Sends an invite link to an email address.

        +

        Parameters

        • email: string
          +

          The email address of the user.

          +
        • Optional options: { data?: object; redirectTo?: string }
          +

          Additional options to be included when inviting.

          +
          • Optional data?: object
            +

            A custom data object to store additional metadata about the user. This maps to the auth.users.user_metadata column.

            +
          • Optional redirectTo?: string
            +

            The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL.

            +

        Returns Promise<UserResponse>

      • +

        Get a list of users.

        +

        This function should only be called on a server. Never expose your service_role key in the browser.

        +

        Parameters

        • Optional params: PageParams
          +

          An object which supports page and perPage as numbers, to alter the paginated results.

          +

        Returns Promise<{ data: { aud: string; users: AuthUser[] } & Pagination; error: null } | { data: { users: [] }; error: AuthError }>

      • signOut(jwt: string, scope?: "global" | "local" | "others"): Promise<{ data: null; error: null | AuthError }>
      • +

        Removes a logged-in session.

        +

        Parameters

        • jwt: string
          +

          A valid, logged-in JWT.

          +
        • Optional scope: "global" | "local" | "others"
          +

          The logout sope.

          +

        Returns Promise<{ data: null; error: null | AuthError }>

      • +

        Updates the user data.

        +

        Parameters

        • uid: string
        • attributes: AdminUserAttributes
          +

          The data you want to update.

          +

          This function should only be called on a server. Never expose your service_role key in the browser.

          +

        Returns Promise<UserResponse>

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.GoTrueClient.html b/v2/classes/index.GoTrueClient.html new file mode 100644 index 00000000..b2d6f98d --- /dev/null +++ b/v2/classes/index.GoTrueClient.html @@ -0,0 +1,202 @@ +GoTrueClient | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      • GoTrueClient

      Index

      Constructors

      • +

        Create a new client for use in the browser.

        +

        Parameters

        Returns GoTrueClient

      Properties

      __loadSession: any
      +

      NEVER USE DIRECTLY!

      +

      Always use {@link #_useSession}.

      +
      _acquireLock: any
      +

      Acquires a global lock based on the storage key.

      +
      _autoRefreshTokenTick: any
      +

      Runs the auto refresh token tick.

      +
      _callRefreshToken: any
      _challenge: any
      +

      {@see GoTrueMFAApi#challenge}

      +
      _challengeAndVerify: any
      +

      {@see GoTrueMFAApi#challengeAndVerify}

      +
      _debug: any
      _decodeJWT: any
      +

      Decodes a JWT (without performing any validation).

      +
      _emitInitialSession: any
      _enroll: any
      +

      {@see GoTrueMFAApi#enroll}

      +
      _exchangeCodeForSession: any
      _getAuthenticatorAssuranceLevel: any
      +

      {@see GoTrueMFAApi#getAuthenticatorAssuranceLevel}

      +
      _getSessionFromURL: any
      +

      Gets the session data from a URL string

      +
      _getUrlForProvider: any
      +

      Generates the relevant login URL for a third-party provider.

      +
      param options.redirectTo

      A URL or mobile address to send the user to after they are confirmed.

      +
      param options.scopes

      A space-separated list of scopes granted to the OAuth application.

      +
      param options.queryParams

      An object of key-value pairs containing query parameters granted to the OAuth application.

      +
      _getUser: any
      _handleProviderSignIn: any
      _handleVisibilityChange: any
      +

      Registers callbacks on the browser / platform, which in-turn run +algorithms when the browser window/tab are in foreground. On non-browser +platforms it assumes always foreground.

      +
      _initialize: any
      +

      IMPORTANT:

      +
        +
      1. Never throw in this method, as it is called from the constructor
      2. +
      3. Never return a session from this method as it would be cached over +the whole lifetime of the client
      4. +
      +
      _isImplicitGrantFlow: any
      +

      Checks if the current URL contains parameters given by an implicit oauth grant flow (https://www.rfc-editor.org/rfc/rfc6749.html#section-4.2)

      +
      _isPKCEFlow: any
      +

      Checks if the current URL and backing storage contain parameters given by a PKCE flow

      +
      _isValidSession: any
      _listFactors: any
      +

      {@see GoTrueMFAApi#listFactors}

      +
      _notifyAllSubscribers: any
      _onVisibilityChanged: any
      +

      Callback registered with window.addEventListener('visibilitychange').

      +
      _persistSession: any
      _reauthenticate: any
      _recoverAndRefresh: any
      +

      Recovers the session from LocalStorage and refreshes +Note: this method is async to accommodate for AsyncStorage e.g. in React native.

      +
      _refreshAccessToken: any
      +

      Generates a new JWT.

      +
      param refreshToken

      A valid refresh token that was returned on login.

      +
      _removeSession: any
      _removeVisibilityChangedCallback: any
      +

      Removes any registered visibilitychange callback.

      +

      {@see #startAutoRefresh} +{@see #stopAutoRefresh}

      +
      _saveSession: any
      +

      set currentSession and currentUser +process to _startAutoRefreshToken if possible

      +
      _startAutoRefresh: any
      +

      This is the private implementation of {@link #startAutoRefresh}. Use this +within the library.

      +
      _stopAutoRefresh: any
      +

      This is the private implementation of {@link #stopAutoRefresh}. Use this +within the library.

      +
      _unenroll: any
      _useSession: any
      +

      Use instead of {@link #getSession} inside the library. It is +semantically usually what you want, as getting a session involves some +processing afterwards that requires only one client operating on the +session at once across multiple tabs or processes.

      +
      _verify: any
      +

      {@see GoTrueMFAApi#verify}

      +
      +

      Namespace for the GoTrue admin methods. +These methods should only be used in a trusted server-side environment.

      +
      autoRefreshTicker: null | Timer
      autoRefreshToken: boolean
      broadcastChannel: null | BroadcastChannel
      +

      Used to broadcast state change events to other tabs listening.

      +
      detectSessionInUrl: boolean
      fetch: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

      Type declaration

        • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
        • Parameters

          • input: RequestInfo | URL
          • Optional init: RequestInit

          Returns Promise<Response>

      flowType: AuthFlowType
      headers: {}

      Type declaration

      • [key: string]: string
      initializePromise: null | Promise<InitializeResult>
      +

      Keeps track of the async client initialization. +When null or not yet resolved the auth state is unknown +Once resolved the the auth state is known and it's save to call any further client methods. +Keep extra care to never reject or throw uncaught errors

      +
      instanceID: any
      lock: LockFunc
      lockAcquired: boolean
      logDebugMessages: boolean
      logger: ((message: string, ...args: any[]) => void)

      Type declaration

        • (message: string, ...args: any[]): void
        • Parameters

          • message: string
          • Rest ...args: any[]

          Returns void

      memoryStorage: null | {}
      +

      Namespace for the MFA methods.

      +
      pendingInLock: Promise<any>[]
      persistSession: boolean
      refreshingDeferred: null | Deferred<CallRefreshTokenResult>
      stateChangeEmitters: Map<string, Subscription>
      storage: PromisifyMethods<Pick<Storage, "getItem" | "removeItem" | "setItem">>
      storageKey: string
      +

      The storage key used to identify the values saved in localStorage

      +
      url: string
      visibilityChangedCallback: null | (() => Promise<any>)
      nextInstanceID: any

      Methods

      • _refreshSession(currentSession?: { refresh_token: string }): Promise<AuthResponse>
      • Parameters

        • Optional currentSession: { refresh_token: string }
          • refresh_token: string

        Returns Promise<AuthResponse>

      • _setSession(currentSession: { access_token: string; refresh_token: string }): Promise<AuthResponse>
      • Parameters

        • currentSession: { access_token: string; refresh_token: string }
          • access_token: string
          • refresh_token: string

        Returns Promise<AuthResponse>

      • Parameters

        • Optional __namedParameters: SignOut

        Returns Promise<{ error: null | AuthError }>

      • Parameters

        • attributes: UserAttributes
        • Optional options: { emailRedirectTo?: string }
          • Optional emailRedirectTo?: string

        Returns Promise<UserResponse>

      • +

        Log in an existing user by exchanging an Auth Code issued during the PKCE flow.

        +

        Parameters

        • authCode: string

        Returns Promise<AuthTokenResponse>

      • getSession(): Promise<{ data: { session: AuthSession }; error: null } | { data: { session: null }; error: AuthError } | { data: { session: null }; error: null }>
      • +

        Returns the session, refreshing it if necessary. +The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.

        +

        Returns Promise<{ data: { session: AuthSession }; error: null } | { data: { session: null }; error: AuthError } | { data: { session: null }; error: null }>

      • +

        Gets the current user details if there is an existing session.

        +

        Parameters

        • Optional jwt: string
          +

          Takes in an optional access token jwt. If no jwt is provided, getUser() will attempt to get the jwt from the current session.

          +

        Returns Promise<UserResponse>

      • +

        Initializes the client session either from the url or from storage. +This method is automatically called when instantiating the client, but should also be called +manually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc).

        +

        Returns Promise<InitializeResult>

      • +

        Receive a notification every time an auth event happens.

        +

        Parameters

        Returns { data: { subscription: Subscription } }

      • +

        Sends a reauthentication OTP to the user's email or phone number. +Requires the user to be signed-in.

        +

        Returns Promise<AuthResponse>

      • refreshSession(currentSession?: { refresh_token: string }): Promise<AuthResponse>
      • +

        Returns a new session, regardless of expiry status. +Takes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession(). +If the current session's refresh token is invalid, an error will be thrown.

        +

        Parameters

        • Optional currentSession: { refresh_token: string }
          +

          The current session. If passed in, it must contain a refresh token.

          +
          • refresh_token: string

        Returns Promise<AuthResponse>

      • +

        Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP.

        +

        Parameters

        Returns Promise<AuthOtpResponse>

      • resetPasswordForEmail(email: string, options?: { captchaToken?: string; redirectTo?: string }): Promise<{ data: {}; error: null } | { data: null; error: AuthError }>
      • +

        Sends a password reset request to an email address. +This method supports the PKCE flow.

        +

        Parameters

        • email: string
          +

          The email address of the user.

          +
        • Optional options: { captchaToken?: string; redirectTo?: string }
          • Optional captchaToken?: string
            +

            Verification token received when the user completes the captcha on the site.

            +
          • Optional redirectTo?: string
            +

            The URL to send the user to after they click the password reset link.

            +

        Returns Promise<{ data: {}; error: null } | { data: null; error: AuthError }>

      • setSession(currentSession: { access_token: string; refresh_token: string }): Promise<AuthResponse>
      • +

        Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session. +If the refresh token or access token in the current session is invalid, an error will be thrown.

        +

        Parameters

        • currentSession: { access_token: string; refresh_token: string }
          +

          The current session that minimally contains an access token and refresh token.

          +
          • access_token: string
          • refresh_token: string

        Returns Promise<AuthResponse>

      • +

        Allows signing in with an OIDC ID token. The authentication provider used +should be enabled and configured.

        +

        Parameters

        Returns Promise<AuthTokenResponse>

      • +

        Log in an existing user via a third-party provider. +This method supports the PKCE flow.

        +

        Parameters

        Returns Promise<OAuthResponse>

      • +

        Log in a user using magiclink or a one-time password (OTP).

        +

        If the {{ .ConfirmationURL }} variable is specified in the email template, a magiclink will be sent. +If the {{ .Token }} variable is specified in the email template, an OTP will be sent. +If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.

        +

        Be aware that you may get back an error message that will not distinguish +between the cases where the account does not exist or, that the account +can only be accessed via social login.

        +

        Do note that you will need to configure a Whatsapp sender on Twilio +if you are using phone sign in with the 'whatsapp' channel. The whatsapp +channel is not supported on other providers +at this time. +This method supports PKCE when an email is passed.

        +

        Parameters

        Returns Promise<AuthOtpResponse>

      • +

        Log in an existing user with an email and password or phone and password.

        +

        Be aware that you may get back an error message that will not distinguish +between the cases where the account does not exist or that the +email/phone and password combination is wrong or that the account can only +be accessed via social login.

        +

        Parameters

        Returns Promise<AuthTokenResponse>

      • +

        Attempts a single-sign on using an enterprise Identity Provider. A +successful SSO attempt will redirect the current page to the identity +provider authorization page. The redirect URL is implementation and SSO +protocol specific.

        +

        You can use it by providing a SSO domain. Typically you can extract this +domain by asking users for their email address. If this domain is +registered on the Auth instance the redirect will use that organization's +currently active SSO Identity Provider for the login.

        +

        If you have built an organization-specific login page, you can use the +organization's SSO Identity Provider UUID directly instead.

        +

        Parameters

        Returns Promise<SSOResponse>

      • +

        Inside a browser context, signOut() will remove the logged in user from the browser session +and log them out - removing all items from localstorage and then trigger a "SIGNED_OUT" event.

        +

        For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to auth.api.signOut(JWT: string). +There is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.

        +

        If using others scope, no SIGNED_OUT event is fired!

        +

        Parameters

        Returns Promise<{ error: null | AuthError }>

      • +

        Creates a new user.

        +

        Be aware that if a user account exists in the system you may get back an +error message that attempts to hide this information from the user. +This method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled.

        +

        Parameters

        Returns Promise<AuthResponse>

        A logged-in session if the server has "autoconfirm" ON

        +
      • startAutoRefresh(): Promise<void>
      • +

        Starts an auto-refresh process in the background. The session is checked +every few seconds. Close to the time of expiration a process is started to +refresh the session. If refreshing fails it will be retried for as long as +necessary.

        +

        If you set the {@link GoTrueClientOptions#autoRefreshToken} you don't need +to call this function, it will be called for you.

        +

        On browsers the refresh process works only when the tab/window is in the +foreground to conserve resources as well as prevent race conditions and +flooding auth with requests. If you call this method any managed +visibility change callback will be removed and you must manage visibility +changes on your own.

        +

        On non-browser platforms the refresh process works continuously in the +background, which may not be desirable. You should hook into your +platform's foreground indication mechanism and call these methods +appropriately to conserve resources.

        +

        {@see #stopAutoRefresh}

        +

        Returns Promise<void>

      • stopAutoRefresh(): Promise<void>
      • +

        Stops an active auto refresh process running in the background (if any).

        +

        If you call this method any managed visibility change callback will be +removed and you must manage visibility changes on your own.

        +

        See {@link #startAutoRefresh} for more details.

        +

        Returns Promise<void>

      • +

        Updates user data for a logged in user.

        +

        Parameters

        • attributes: UserAttributes
        • Optional options: { emailRedirectTo?: string }
          • Optional emailRedirectTo?: string

        Returns Promise<UserResponse>

      • +

        Log in a user given a User supplied OTP or TokenHash received through mobile or email.

        +

        Parameters

        Returns Promise<AuthResponse>

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.NavigatorLockAcquireTimeoutError.html b/v2/classes/index.NavigatorLockAcquireTimeoutError.html new file mode 100644 index 00000000..42fa5254 --- /dev/null +++ b/v2/classes/index.NavigatorLockAcquireTimeoutError.html @@ -0,0 +1,6 @@ +NavigatorLockAcquireTimeoutError | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class NavigatorLockAcquireTimeoutError

      Hierarchy

      • LockAcquireTimeoutError
        • NavigatorLockAcquireTimeoutError

      Index

      Constructors

      • Parameters

        • message: string

        Returns NavigatorLockAcquireTimeoutError

      Properties

      isAcquireTimeout: true = true
      message: string
      name: string
      stack?: string
      prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

      Type declaration

      stackTraceLimit: number

      Methods

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

        Create .stack property on a target object

        +

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.RealtimeChannel.html b/v2/classes/index.RealtimeChannel.html new file mode 100644 index 00000000..aad1c06a --- /dev/null +++ b/v2/classes/index.RealtimeChannel.html @@ -0,0 +1,80 @@ +RealtimeChannel | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu
      +

      A channel is the basic building block of Realtime +and narrows the scope of data flow to subscribed clients. +You can think of a channel as a chatroom where participants are able to see who's online +and send and receive messages.

      +

      Hierarchy

      • RealtimeChannel

      Index

      Constructors

      Properties

      bindings: {}

      Type declaration

      • [key: string]: { callback: Function; filter: {}; id?: string; type: string }[]
      joinPush: default
      joinedOnce: boolean
      pushBuffer: default[]
      rejoinTimer: default
      state: CHANNEL_STATES
      timeout: number
      topic: string
      +

      Topic name can be any string.

      +

      Methods

      • +

        Creates an event handler that listens to changes.

        +

        Parameters

        • type: "presence"
          +

          One of "broadcast", "presence", or "postgres_changes".

          +
        • filter: { event: "sync" }
          +

          Custom object specific to the Realtime feature detailing which payloads to receive.

          +
          • event: "sync"
        • callback: (() => void)
          +

          Function to be invoked when event handler is triggered.

          +
            • (): void
            • Returns void

        Returns RealtimeChannel

      • +

        The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.

        +

        Type Parameters

        • T extends {}

        Parameters

        • type: "presence"
          +

          One of "broadcast", "presence", or "postgres_changes".

          +
        • filter: { event: "join" }
          +

          Custom object specific to the Realtime feature detailing which payloads to receive.

          +
          • event: "join"
        • callback: ((payload: RealtimePresenceJoinPayload<T>) => void)
          +

          Function to be invoked when event handler is triggered.

          +

        Returns RealtimeChannel

      • +

        The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.

        +

        Type Parameters

        • T extends {}

        Parameters

        • type: "presence"
          +

          One of "broadcast", "presence", or "postgres_changes".

          +
        • filter: { event: "leave" }
          +

          Custom object specific to the Realtime feature detailing which payloads to receive.

          +
          • event: "leave"
        • callback: ((payload: RealtimePresenceLeavePayload<T>) => void)
          +

          Function to be invoked when event handler is triggered.

          +

        Returns RealtimeChannel

      • +

        The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.

        +

        Type Parameters

        • T extends {}

        Parameters

        Returns RealtimeChannel

      • +

        The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.

        +

        Type Parameters

        • T extends {}

        Parameters

        Returns RealtimeChannel

      • +

        The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.

        +

        Type Parameters

        • T extends {}

        Parameters

        Returns RealtimeChannel

      • +

        The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.

        +

        Type Parameters

        • T extends {}

        Parameters

        Returns RealtimeChannel

      • +

        The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.

        +

        Parameters

        • type: "broadcast"
          +

          One of "broadcast", "presence", or "postgres_changes".

          +
        • filter: { event: string }
          +

          Custom object specific to the Realtime feature detailing which payloads to receive.

          +
          • event: string
        • callback: ((payload: { event: string; type: "broadcast" }) => void)
          +

          Function to be invoked when event handler is triggered.

          +
            • (payload: { event: string; type: "broadcast" }): void
            • Parameters

              • payload: { event: string; type: "broadcast" }
                • [key: string]: any
                • event: string
                • type: "broadcast"

              Returns void

        Returns RealtimeChannel

      • Type Parameters

        • T extends {} = {}

        Returns RealtimePresenceState<T>

      • Parameters

        • payload: { type: string }
          • [key: string]: any
          • type: string
        • Optional opts: {}
          • [key: string]: any

        Returns Promise<RealtimeChannelSendResponse>

      • subscribe(callback?: ((status: "SUBSCRIBED" | "TIMED_OUT" | "CLOSED" | "CHANNEL_ERROR", err?: Error) => void), timeout?: number): RealtimeChannel
      • +

        Subscribe registers your client with the server

        +

        Parameters

        • Optional callback: ((status: "SUBSCRIBED" | "TIMED_OUT" | "CLOSED" | "CHANNEL_ERROR", err?: Error) => void)
            • (status: "SUBSCRIBED" | "TIMED_OUT" | "CLOSED" | "CHANNEL_ERROR", err?: Error): void
            • Parameters

              • status: "SUBSCRIBED" | "TIMED_OUT" | "CLOSED" | "CHANNEL_ERROR"
              • Optional err: Error

              Returns void

        • Optional timeout: number

        Returns RealtimeChannel

      • Parameters

        • payload: {}
          • [key: string]: any
        • Optional opts: {}
          • [key: string]: any

        Returns Promise<RealtimeChannelSendResponse>

      • unsubscribe(timeout?: number): Promise<"error" | "ok" | "timed out">
      • +

        Leaves the channel.

        +

        Unsubscribes from server events, and instructs channel to terminate on server. +Triggers onClose() hooks.

        +

        To receive leave acknowledgements, use the a receive hook to bind to the server ack, ie: +channel.unsubscribe().receive("ok", () => alert("left!") )

        +

        Parameters

        • Optional timeout: number

        Returns Promise<"error" | "ok" | "timed out">

      • Parameters

        • Optional opts: {}
          • [key: string]: any

        Returns Promise<RealtimeChannelSendResponse>

      • updateJoinPayload(payload: {}): void
      • Parameters

        • payload: {}
          • [key: string]: any

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.RealtimeClient.html b/v2/classes/index.RealtimeClient.html new file mode 100644 index 00000000..d047763a --- /dev/null +++ b/v2/classes/index.RealtimeClient.html @@ -0,0 +1,35 @@ +RealtimeClient | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      • RealtimeClient

      Index

      Constructors

      • +

        Initializes the Socket.

        +

        Parameters

        • endPoint: string
          +

          The string WebSocket endpoint, ie, "ws://example.com/socket", "wss://example.com", "/socket" (inherited host & protocol)

          +
        • Optional options: RealtimeClientOptions

        Returns RealtimeClient

      Properties

      accessToken: null | string
      channels: RealtimeChannel[]
      conn: null | WebSocket
      decode: Function
      encode: Function
      endPoint: string
      eventsPerSecondLimitMs: number
      headers?: {}

      Type declaration

      • [key: string]: string
      heartbeatIntervalMs: number
      heartbeatTimer: undefined | Timer
      inThrottle: boolean
      logger: Function
      params?: {}

      Type declaration

      • [key: string]: string
      pendingHeartbeatRef: null | string
      reconnectAfterMs: Function
      reconnectTimer: default
      ref: number
      sendBuffer: Function[]
      serializer: default
      stateChangeCallbacks: { close: Function[]; error: Function[]; message: Function[]; open: Function[] }

      Type declaration

      • close: Function[]
      • error: Function[]
      • message: Function[]
      • open: Function[]
      timeout: number
      transport: any

      Methods

      • connect(): void
      • +

        Connects the socket, unless already connected.

        +

        Returns void

      • connectionState(): CONNECTION_STATE
      • +

        Returns the current state of the socket.

        +

        Returns CONNECTION_STATE

      • disconnect(code?: number, reason?: string): void
      • +

        Disconnects the socket.

        +

        Parameters

        • Optional code: number
          +

          A numeric status code to send on disconnect.

          +
        • Optional reason: string
          +

          A custom reason for the disconnect.

          +

        Returns void

      • +

        Returns all created channels

        +

        Returns RealtimeChannel[]

      • isConnected(): boolean
      • +

        Returns true is the connection is open.

        +

        Returns boolean

      • log(kind: string, msg: string, data?: any): void
      • +

        Logs the message.

        +

        For customized logging, this.logger can be overridden.

        +

        Parameters

        • kind: string
        • msg: string
        • Optional data: any

        Returns void

      • +

        Push out a message if the socket is connected.

        +

        If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.

        +

        Parameters

        Returns void | "rate limited"

      • +

        Unsubscribes and removes all channels

        +

        Returns Promise<RealtimeRemoveChannelResponse[]>

      • +

        Unsubscribes and removes a single channel

        +

        Parameters

        Returns Promise<RealtimeRemoveChannelResponse>

      • setAuth(token: null | string): void
      • +

        Sets the JWT access token used for channel subscription authorization and Realtime RLS.

        +

        Parameters

        • token: null | string
          +

          A JWT string.

          +

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.RealtimePresence.html b/v2/classes/index.RealtimePresence.html new file mode 100644 index 00000000..8c8c1331 --- /dev/null +++ b/v2/classes/index.RealtimePresence.html @@ -0,0 +1,8 @@ +RealtimePresence | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      • RealtimePresence

      Index

      Constructors

      • +

        Initializes the Presence.

        +

        Parameters

        • channel: RealtimeChannel
          +

          The RealtimeChannel

          +
        • Optional opts: PresenceOpts
          +

          The options, + for example {events: {state: 'state', diff: 'diff'}}

          +

        Returns RealtimePresence

      Properties

      caller: { onJoin: PresenceOnJoinCallback; onLeave: PresenceOnLeaveCallback; onSync: any }

      Type declaration

      • onJoin: PresenceOnJoinCallback
      • onLeave: PresenceOnLeaveCallback
      • onSync:function
        • onSync(): void
        • Returns void

      joinRef: null | string
      pendingDiffs: RawPresenceDiff[]

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/classes/index.SupabaseClient.html b/v2/classes/index.SupabaseClient.html new file mode 100644 index 00000000..d8e52777 --- /dev/null +++ b/v2/classes/index.SupabaseClient.html @@ -0,0 +1,69 @@ +SupabaseClient | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class SupabaseClient<Database, SchemaName, Schema>

      +

      Supabase Client.

      +

      An isomorphic Javascript client for interacting with Postgres.

      +

      Type Parameters

      • Database = any

      • SchemaName extends string & keyof Database = "public" extends keyof Database ? "public" : string & keyof Database

      • Schema extends GenericSchema = Database[SchemaName] extends GenericSchema ? Database[SchemaName] : any

      Hierarchy

      • SupabaseClient

      Index

      Constructors

      • new SupabaseClient<Database, SchemaName, Schema>(supabaseUrl: string, supabaseKey: string, options?: SupabaseClientOptions<SchemaName>): SupabaseClient<Database, SchemaName, Schema>
      • +

        Create a new client for use in the browser.

        +

        Type Parameters

        • Database = any

        • SchemaName extends string = "public" extends keyof Database ? "public" : string & keyof Database

        • Schema extends GenericSchema = Database[SchemaName] extends GenericSchema ? any[any] : any

        Parameters

        • supabaseUrl: string
          +

          The unique Supabase URL which is supplied when you create a new project in your project dashboard.

          +
        • supabaseKey: string
          +

          The unique Supabase Key which is supplied when you create a new project in your project dashboard.

          +
        • Optional options: SupabaseClientOptions<SchemaName>

        Returns SupabaseClient<Database, SchemaName, Schema>

      Properties

      auth: SupabaseAuthClient
      +

      Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies.

      +
      authUrl: string
      changedAccessToken?: string
      fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

      Type declaration

        • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
        • Parameters

          • input: RequestInfo | URL
          • Optional init: RequestInit

          Returns Promise<Response>

      functionsUrl: string
      headers: {}

      Type declaration

      • [key: string]: string
      realtime: RealtimeClient
      realtimeUrl: string
      rest: default<Database, SchemaName, Database[SchemaName] extends GenericSchema ? any[any] : any>
      storageKey: string
      storageUrl: string
      supabaseKey: string
      supabaseUrl: string

      Accessors

      • get functions(): FunctionsClient
      • +

        Supabase Functions allows you to deploy and invoke edge functions.

        +

        Returns FunctionsClient

      • get storage(): StorageClient
      • +

        Supabase Storage allows you to manage user-generated content, such as photos or videos.

        +

        Returns StorageClient

      Methods

      • _getAccessToken(): Promise<null | string>
      • _handleTokenChanged(event: AuthChangeEvent, source: "CLIENT" | "STORAGE", token?: string): void
      • _initSupabaseAuthClient(__namedParameters: SupabaseAuthClientOptions, headers?: Record<string, string>, fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)): SupabaseAuthClient
      • Parameters

        • __namedParameters: SupabaseAuthClientOptions
        • Optional headers: Record<string, string>
        • Optional fetch: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
            • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
            • Parameters

              • input: RequestInfo | URL
              • Optional init: RequestInit

              Returns Promise<Response>

        Returns SupabaseAuthClient

      • _listenForAuthEvents(): { data: { subscription: Subscription } }
      • from<TableName, Table>(relation: TableName): default<Schema, Table, Table extends { Relationships: R } ? R : unknown>
      • from<ViewName, View>(relation: ViewName): default<Schema, View, View extends { Relationships: R } ? R : unknown>
      • from(relation: string): default<Schema, any, unknown>
      • +

        Perform a query on a table or a view.

        +

        Type Parameters

        Parameters

        • relation: TableName
          +

          The table or view name to query

          +

        Returns default<Schema, Table, Table extends { Relationships: R } ? R : unknown>

      • +

        Perform a query on a table or a view.

        +

        Type Parameters

        Parameters

        • relation: ViewName
          +

          The table or view name to query

          +

        Returns default<Schema, View, View extends { Relationships: R } ? R : unknown>

      • +

        Perform a query on a table or a view.

        +

        Parameters

        • relation: string
          +

          The table or view name to query

          +

        Returns default<Schema, any, unknown>

      • removeAllChannels(): Promise<("error" | "ok" | "timed out")[]>
      • +

        Unsubscribes and removes all Realtime channels from Realtime client.

        +

        Returns Promise<("error" | "ok" | "timed out")[]>

      • removeChannel(channel: RealtimeChannel): Promise<"error" | "ok" | "timed out">
      • +

        Unsubscribes and removes Realtime channel from Realtime client.

        +

        Parameters

        Returns Promise<"error" | "ok" | "timed out">

      • rpc<FunctionName, Function_>(fn: FunctionName, args?: Function_["Args"], options?: { count?: "exact" | "planned" | "estimated"; head?: boolean }): default<Schema, Function_["Returns"] extends any[] ? any[any][number] extends Record<string, unknown> ? any[any] : never : never, Function_["Returns"], unknown>
      • +

        Perform a function call.

        +

        Type Parameters

        Parameters

        • fn: FunctionName
          +

          The function name to call

          +
        • args: Function_["Args"] = {}
          +

          The arguments to pass to the function call

          +
        • Optional options: { count?: "exact" | "planned" | "estimated"; head?: boolean }
          +

          Named parameters

          +
          • Optional count?: "exact" | "planned" | "estimated"
            +

            Count algorithm to use to count rows returned by the +function. Only applicable for set-returning +functions.

            +

            "exact": Exact but slow count algorithm. Performs a COUNT(*) under the +hood.

            +

            "planned": Approximated but fast count algorithm. Uses the Postgres +statistics under the hood.

            +

            "estimated": Uses exact count for low numbers and planned count for high +numbers.

            +
          • Optional head?: boolean
            +

            When set to true, data will not be returned. +Useful if you only need the count.

            +

        Returns default<Schema, Function_["Returns"] extends any[] ? any[any][number] extends Record<string, unknown> ? any[any] : never : never, Function_["Returns"], unknown>

      • schema<DynamicSchema>(schema: DynamicSchema): default<Database, DynamicSchema, Database[DynamicSchema] extends GenericSchema ? any[any] : any>
      • +

        Perform a query on a schema distinct from the default schema supplied via +the options.db.schema constructor parameter.

        +

        The schema needs to be on the list of exposed schemas inside Supabase.

        +

        Type Parameters

        • DynamicSchema extends string

        Parameters

        • schema: DynamicSchema
          +

          The name of the schema to query

          +

        Returns default<Database, DynamicSchema, Database[DynamicSchema] extends GenericSchema ? any[any] : any>

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Class with type parameter
      • Property
      • Method
      • Interface
      • Protected property
      • Private method

      Settings

      Theme

      Generated using TypeDoc

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

      Enumeration REALTIME_LISTEN_TYPES

      Index

      Enumeration Members

      BROADCAST: "broadcast"
      POSTGRES_CHANGES: "postgres_changes"
      +

      listen to Postgres changes.

      +
      PRESENCE: "presence"

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/enums/index.REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.html b/v2/enums/index.REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.html new file mode 100644 index 00000000..e195353b --- /dev/null +++ b/v2/enums/index.REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.html @@ -0,0 +1 @@ +REALTIME_POSTGRES_CHANGES_LISTEN_EVENT | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Enumeration REALTIME_POSTGRES_CHANGES_LISTEN_EVENT

      Index

      Enumeration Members

      Enumeration Members

      ALL: "*"
      DELETE: "DELETE"
      INSERT: "INSERT"
      UPDATE: "UPDATE"

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/enums/index.REALTIME_PRESENCE_LISTEN_EVENTS.html b/v2/enums/index.REALTIME_PRESENCE_LISTEN_EVENTS.html new file mode 100644 index 00000000..69a63601 --- /dev/null +++ b/v2/enums/index.REALTIME_PRESENCE_LISTEN_EVENTS.html @@ -0,0 +1 @@ +REALTIME_PRESENCE_LISTEN_EVENTS | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Enumeration REALTIME_PRESENCE_LISTEN_EVENTS

      Index

      Enumeration Members

      Enumeration Members

      JOIN: "join"
      LEAVE: "leave"
      SYNC: "sync"

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/enums/index.REALTIME_SUBSCRIBE_STATES.html b/v2/enums/index.REALTIME_SUBSCRIBE_STATES.html new file mode 100644 index 00000000..5d5a6800 --- /dev/null +++ b/v2/enums/index.REALTIME_SUBSCRIBE_STATES.html @@ -0,0 +1 @@ +REALTIME_SUBSCRIBE_STATES | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Enumeration REALTIME_SUBSCRIBE_STATES

      Index

      Enumeration Members

      CHANNEL_ERROR: "CHANNEL_ERROR"
      CLOSED: "CLOSED"
      SUBSCRIBED: "SUBSCRIBED"
      TIMED_OUT: "TIMED_OUT"

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/index.html b/v2/index.html new file mode 100644 index 00000000..481d3344 --- /dev/null +++ b/v2/index.html @@ -0,0 +1,54 @@ +@supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      @supabase/supabase-js

      + +

      supabase-js

      +
      +

      Coverage Status

      +

      An isomorphic JavaScript client for Supabase.

      + + + +

      Usage

      +
      +

      First of all, you need to install the library:

      +
      npm install @supabase/supabase-js
      +
      +

      Then you're able to import the library and establish the connection with the database:

      +
      import { createClient } from '@supabase/supabase-js'

      // Create a single supabase client for interacting with your database
      const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key') +
      + + +

      UMD

      +
      +

      You can now use plain <script>s to import supabase-js from CDNs, like:

      +
      <script src="https://cdn.jsdelivr.net/npm/@supabase/supabase-js"></script>
      +
      +

      or even:

      +
      <script src="https://unpkg.com/@supabase/supabase-js"></script>
      +
      +

      Then you can use it from a global supabase variable:

      +
      <script>
      const { createClient } = supabase
      const _supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')

      console.log('Supabase Instance: ', _supabase)
      // ...
      </script> +
      + + +

      ESM

      +
      +

      You can now use type="module" <script>s to import supabase-js from CDNs, like:

      +
      <script type="module">
      import { createClient } from 'https://cdn.jsdelivr.net/npm/@supabase/supabase-js/+esm'
      const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')

      console.log('Supabase Instance: ', supabase)
      // ...
      </script> +
      + + +

      Custom fetch implementation

      +
      +

      supabase-js uses the cross-fetch library to make HTTP requests, but an alternative fetch implementation can be provided as an option. This is most useful in environments where cross-fetch is not compatible, for instance Cloudflare Workers:

      +
      import { createClient } from '@supabase/supabase-js'

      // Provide a custom `fetch` implementation as an option
      const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key', {
      global: {
      fetch: (...args) => fetch(...args),
      },
      }) +
      + + +

      Sponsors

      +
      +

      We are building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products don’t exist we build them and open source them ourselves. Thanks to these sponsors who are making the OSS ecosystem better for everyone.

      +

      New Sponsor

      +

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.AMREntry.html b/v2/interfaces/index.AMREntry.html new file mode 100644 index 00000000..0f539e9c --- /dev/null +++ b/v2/interfaces/index.AMREntry.html @@ -0,0 +1,11 @@ +AMREntry | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu
      +

      An authentication methord reference (AMR) entry.

      +

      An entry designates what method was used by the user to verify their +identity and at what time.

      +
      see

      {@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}.

      +

      Hierarchy

      • AMREntry

      Index

      Properties

      Properties

      method: string
      +

      Authentication method name.

      +
      timestamp: number
      +

      Timestamp when the method was successfully used. Represents number of +seconds since 1st January 1970 (UNIX epoch) in UTC.

      +

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.AdminUserAttributes.html b/v2/interfaces/index.AdminUserAttributes.html new file mode 100644 index 00000000..842c4717 --- /dev/null +++ b/v2/interfaces/index.AdminUserAttributes.html @@ -0,0 +1,32 @@ +AdminUserAttributes | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Interface AdminUserAttributes

      Hierarchy

      Index

      Properties

      app_metadata?: object
      +

      A custom data object to store the user's application specific metadata. This maps to the auth.users.app_metadata column.

      +

      Only a service role can modify.

      +

      The app_metadata should be a JSON object that includes app-specific info, such as identity providers, roles, and other +access control information.

      +
      ban_duration?: string
      +

      Determines how long a user is banned for.

      +

      The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix. +Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

      +

      For example, some possible durations include: '300ms', '2h45m'.

      +

      Setting the ban duration to 'none' lifts the ban on the user.

      +
      email?: string
      +

      The user's email.

      +
      email_confirm?: boolean
      +

      Confirms the user's email address if set to true.

      +

      Only a service role can modify.

      +
      nonce?: string
      +

      The nonce sent for reauthentication if the user's password is to be updated.

      +

      Call reauthenticate() to obtain the nonce first.

      +
      password?: string
      +

      The user's password.

      +
      phone?: string
      +

      The user's phone.

      +
      phone_confirm?: boolean
      +

      Confirms the user's phone number if set to true.

      +

      Only a service role can modify.

      +
      user_metadata?: object
      +

      A custom data object to store the user's metadata. This maps to the auth.users.user_metadata column.

      +

      The user_metadata should be a JSON object that includes user-specific info, such as their first and last name.

      +

      Note: When using the GoTrueAdminApi and wanting to modify a user's metadata, +this attribute is used instead of UserAttributes data.

      +

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.AuthSession.html b/v2/interfaces/index.AuthSession.html new file mode 100644 index 00000000..d2290eca --- /dev/null +++ b/v2/interfaces/index.AuthSession.html @@ -0,0 +1,14 @@ +AuthSession | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      • AuthSession

      Index

      Properties

      access_token: string
      +

      The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value.

      +
      expires_at?: number
      +

      A timestamp of when the token will expire. Returned when a login is confirmed.

      +
      expires_in: number
      +

      The number of seconds until the token expires (since it was issued). Returned when a login is confirmed.

      +
      provider_refresh_token?: null | string
      +

      The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API. +Not all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token.

      +
      provider_token?: null | string
      +

      The oauth provider token. If present, this can be used to make external API requests to the oauth provider used.

      +
      refresh_token: string
      +

      A one-time used refresh token that never expires.

      +
      token_type: string
      user: AuthUser

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.AuthUser.html b/v2/interfaces/index.AuthUser.html new file mode 100644 index 00000000..20822e48 --- /dev/null +++ b/v2/interfaces/index.AuthUser.html @@ -0,0 +1 @@ +AuthUser | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      • AuthUser

      Index

      Properties

      action_link?: string
      app_metadata: UserAppMetadata
      aud: string
      confirmation_sent_at?: string
      confirmed_at?: string
      created_at: string
      email?: string
      email_change_sent_at?: string
      email_confirmed_at?: string
      factors?: Factor[]
      id: string
      identities?: UserIdentity[]
      invited_at?: string
      last_sign_in_at?: string
      new_email?: string
      new_phone?: string
      phone?: string
      phone_confirmed_at?: string
      recovery_sent_at?: string
      role?: string
      updated_at?: string
      user_metadata: UserMetadata

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.Factor.html b/v2/interfaces/index.Factor.html new file mode 100644 index 00000000..70c1494c --- /dev/null +++ b/v2/interfaces/index.Factor.html @@ -0,0 +1,15 @@ +Factor | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu
      +

      A MFA factor.

      +
      see

      {@link GoTrueMFAApi#enroll}

      +
      see

      {@link GoTrueMFAApi#listFactors}

      +
      see

      {@link GoTrueMFAAdminApi#listFactors}

      +

      Hierarchy

      • Factor

      Index

      Properties

      created_at: string
      factor_type: string
      +

      Type of factor. Only totp supported with this version but may change in +future versions.

      +
      friendly_name?: string
      +

      Friendly name of the factor, useful to disambiguate between multiple factors.

      +
      id: string
      +

      ID of the factor.

      +
      status: "verified" | "unverified"
      +

      Factor's status.

      +
      updated_at: string

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

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

      Interface GenerateLinkOptions

      Hierarchy

      • GenerateLinkOptions

      Index

      Properties

      Properties

      data?: object
      +

      A custom data object to store the user's metadata. This maps to the auth.users.user_metadata column.

      +

      The data should be a JSON object that includes user-specific info, such as their first and last name.

      +
      redirectTo?: string
      +

      The URL which will be appended to the email link generated.

      +

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.GoTrueAdminMFAApi.html b/v2/interfaces/index.GoTrueAdminMFAApi.html new file mode 100644 index 00000000..499b0e2d --- /dev/null +++ b/v2/interfaces/index.GoTrueAdminMFAApi.html @@ -0,0 +1,9 @@ +GoTrueAdminMFAApi | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu
      +

      Contains the full multi-factor authentication administration API.

      +
      expermental

      Hierarchy

      • GoTrueAdminMFAApi

      Index

      Methods

      • +

        Deletes a factor on a user. This will log the user out of all active +sessions if the deleted factor was verified.

        +
        see

        {@link GoTrueMFAApi#unenroll}

        +
        expermental

        Parameters

        Returns Promise<AuthMFAAdminDeleteFactorResponse>

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.GoTrueMFAApi.html b/v2/interfaces/index.GoTrueMFAApi.html new file mode 100644 index 00000000..aa18be1f --- /dev/null +++ b/v2/interfaces/index.GoTrueMFAApi.html @@ -0,0 +1,38 @@ +GoTrueMFAApi | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu
      +

      Contains the full multi-factor authentication API.

      +

      Hierarchy

      • GoTrueMFAApi

      Index

      Methods

      • +

        Prepares a challenge used to verify that a user has access to a MFA +factor.

        +

        Parameters

        Returns Promise<AuthMFAChallengeResponse>

      • +

        Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is +provided by the user by entering a code seen in their authenticator app.

        +

        Parameters

        Returns Promise<AuthMFAVerifyResponse>

      • +

        Starts the enrollment process for a new Multi-Factor Authentication (MFA) +factor. This method creates a new unverified factor. +To verify a factor, present the QR code or secret to the user and ask them to add it to their +authenticator app. +The user has to enter the code from their authenticator app to verify it.

        +

        Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to aal2.

        +

        Parameters

        Returns Promise<AuthMFAEnrollResponse>

      • +

        Returns the Authenticator Assurance Level (AAL) for the active session.

        +
          +
        • aal1 (or null) means that the user's identity has been verified only +with a conventional login (email+password, OTP, magic link, social login, +etc.).
        • +
        • aal2 means that the user's identity has been verified both with a conventional login and at least one MFA factor.
        • +
        +

        Although this method returns a promise, it's fairly quick (microseconds) +and rarely uses the network. You can use this to check whether the current +user needs to be shown a screen to verify their MFA factors.

        +

        Returns Promise<AuthMFAGetAuthenticatorAssuranceLevelResponse>

      • +

        Returns the list of MFA factors enabled for this user.

        +
        see

        {@link GoTrueMFAApi#enroll}

        +
        see

        {@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}

        +
        see

        {@link GoTrueClient#getUser}

        +

        Returns Promise<AuthMFAListFactorsResponse>

      • +

        Unenroll removes a MFA factor. +A user has to have an aal2 authenticator level in order to unenroll a verified factor.

        +

        Parameters

        Returns Promise<AuthMFAUnenrollResponse>

      • +

        Verifies a code against a challenge. The verification code is +provided by the user by entering a code seen in their authenticator app.

        +

        Parameters

        Returns Promise<AuthMFAVerifyResponse>

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.Subscription.html b/v2/interfaces/index.Subscription.html new file mode 100644 index 00000000..880ef812 --- /dev/null +++ b/v2/interfaces/index.Subscription.html @@ -0,0 +1,7 @@ +Subscription | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      • Subscription

      Index

      Properties

      Methods

      Properties

      id: string
      +

      The subscriber UUID. This will be set by the client.

      +

      Methods

      • +

        The function to call every time there is an event. eg: (eventName) => {}

        +

        Parameters

        Returns void

      • unsubscribe(): void
      • +

        Call this to remove the listener.

        +

        Returns void

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.UpdatableFactorAttributes.html b/v2/interfaces/index.UpdatableFactorAttributes.html new file mode 100644 index 00000000..98e52938 --- /dev/null +++ b/v2/interfaces/index.UpdatableFactorAttributes.html @@ -0,0 +1 @@ +UpdatableFactorAttributes | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Interface UpdatableFactorAttributes

      Hierarchy

      • UpdatableFactorAttributes

      Index

      Properties

      Properties

      friendlyName: string

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

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

      Hierarchy

      • UserAppMetadata

      Indexable

      [key: string]: any

      Index

      Properties

      Properties

      provider?: string

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

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

      Hierarchy

      • UserAttributes

      Index

      Properties

      data?: object
      +

      A custom data object to store the user's metadata. This maps to the auth.users.user_metadata column.

      +

      The data should be a JSON object that includes user-specific info, such as their first and last name.

      +
      email?: string
      +

      The user's email.

      +
      nonce?: string
      +

      The nonce sent for reauthentication if the user's password is to be updated.

      +

      Call reauthenticate() to obtain the nonce first.

      +
      password?: string
      +

      The user's password.

      +
      phone?: string
      +

      The user's phone.

      +

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

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

      Hierarchy

      • UserIdentity

      Index

      Properties

      created_at?: string
      id: string
      identity_data?: {}

      Type declaration

      • [key: string]: any
      last_sign_in_at?: string
      provider: string
      updated_at?: string
      user_id: string

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.UserMetadata.html b/v2/interfaces/index.UserMetadata.html new file mode 100644 index 00000000..4026ebe9 --- /dev/null +++ b/v2/interfaces/index.UserMetadata.html @@ -0,0 +1 @@ +UserMetadata | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.VerifyEmailOtpParams.html b/v2/interfaces/index.VerifyEmailOtpParams.html new file mode 100644 index 00000000..a14eda10 --- /dev/null +++ b/v2/interfaces/index.VerifyEmailOtpParams.html @@ -0,0 +1,11 @@ +VerifyEmailOtpParams | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Interface VerifyEmailOtpParams

      Hierarchy

      • VerifyEmailOtpParams

      Index

      Properties

      email: string
      +

      The user's email address.

      +
      options?: { captchaToken?: string; redirectTo?: string }

      Type declaration

      • Optional captchaToken?: string
        +

        Verification token received when the user completes the captcha on the site.

        +
        deprecated
      • Optional redirectTo?: string
        +

        A URL to send the user to after they are confirmed.

        +
      token: string
      +

      The otp sent to the user's email address.

      +
      +

      The user's verification type.

      +

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/index.VerifyMobileOtpParams.html b/v2/interfaces/index.VerifyMobileOtpParams.html new file mode 100644 index 00000000..4020f846 --- /dev/null +++ b/v2/interfaces/index.VerifyMobileOtpParams.html @@ -0,0 +1,11 @@ +VerifyMobileOtpParams | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Interface VerifyMobileOtpParams

      Hierarchy

      • VerifyMobileOtpParams

      Index

      Properties

      options?: { captchaToken?: string; redirectTo?: string }

      Type declaration

      • Optional captchaToken?: string
        +

        Verification token received when the user completes the captcha on the site.

        +
        deprecated
      • Optional redirectTo?: string
        +

        A URL to send the user to after they are confirmed.

        +
      phone: string
      +

      The user's phone number.

      +
      token: string
      +

      The otp sent to the user's phone number.

      +
      +

      The user's verification type.

      +

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

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

      Interface VerifyTokenHashParams

      Hierarchy

      • VerifyTokenHashParams

      Index

      Properties

      Properties

      token_hash: string
      +

      The token hash used in an email link

      +
      +

      The user's verification type.

      +

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/interfaces/lib_types.SupabaseAuthClientOptions.html b/v2/interfaces/lib_types.SupabaseAuthClientOptions.html new file mode 100644 index 00000000..b28124f9 --- /dev/null +++ b/v2/interfaces/lib_types.SupabaseAuthClientOptions.html @@ -0,0 +1,3 @@ +SupabaseAuthClientOptions | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Hierarchy

      • GoTrueClientOptions
        • SupabaseAuthClientOptions

      Index

      Properties

      autoRefreshToken?: boolean
      debug?: boolean | ((message: string, ...args: any[]) => void)
      detectSessionInUrl?: boolean
      fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

      Type declaration

        • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
        • Parameters

          • input: RequestInfo | URL
          • Optional init: RequestInit

          Returns Promise<Response>

      flowType?: AuthFlowType
      headers?: {}

      Type declaration

      • [key: string]: string
      lock?: LockFunc
      +

      Provide your own locking mechanism based on the environment. By default no locking is done at this time.

      +
      experimental
      persistSession?: boolean
      storage?: PromisifyMethods<Pick<Storage, "getItem" | "removeItem" | "setItem">>
      storageKey?: string
      url?: string

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

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

      @supabase/supabase-js

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/modules/index.html b/v2/modules/index.html new file mode 100644 index 00000000..122f97d0 --- /dev/null +++ b/v2/modules/index.html @@ -0,0 +1,143 @@ +index | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Index

      References

      Enumerations

      Classes

      Interfaces

      Type Aliases

      Variables

      Functions

      References

      Renames and re-exports AuthSession
      Re-exports SupabaseClientOptions
      Renames and re-exports AuthUser

      Type Aliases

      AuthChangeEvent: "INITIAL_SESSION" | "PASSWORD_RECOVERY" | "SIGNED_IN" | "SIGNED_OUT" | "TOKEN_REFRESHED" | "USER_UPDATED" | AuthChangeEventMFA
      AuthChangeEventMFA: "MFA_CHALLENGE_VERIFIED"
      AuthFlowType: "implicit" | "pkce"
      AuthMFAAdminDeleteFactorParams: { id: string; userId: string }
      expermental

      Type declaration

      • id: string
        +

        ID of the MFA factor to delete.

        +
      • userId: string
        +

        ID of the user whose factor is being deleted.

        +
      AuthMFAAdminDeleteFactorResponse: { data: { id: string }; error: null } | { data: null; error: AuthError }
      expermental
      AuthMFAAdminListFactorsParams: { userId: string }
      expermental

      Type declaration

      • userId: string
        +

        ID of the user.

        +
      AuthMFAAdminListFactorsResponse: { data: { factors: Factor[] }; error: null } | { data: null; error: AuthError }
      expermental
      AuthMFAChallengeResponse: { data: { expires_at: number; id: string }; error: null } | { data: null; error: AuthError }
      AuthMFAEnrollResponse: { data: { id: string; totp: { qr_code: string; secret: string; uri: string }; type: "totp" }; error: null } | { data: null; error: AuthError }
      AuthMFAGetAuthenticatorAssuranceLevelResponse: { data: { currentAuthenticationMethods: AMREntry[]; currentLevel: AuthenticatorAssuranceLevels | null; nextLevel: AuthenticatorAssuranceLevels | null }; error: null } | { data: null; error: AuthError }
      AuthMFAListFactorsResponse: { data: { all: Factor[]; totp: Factor[] }; error: null } | { data: null; error: AuthError }
      AuthMFAUnenrollResponse: { data: { id: string }; error: null } | { data: null; error: AuthError }
      AuthMFAVerifyResponse: { data: { access_token: string; expires_in: number; refresh_token: string; token_type: string; user: AuthUser }; error: null } | { data: null; error: AuthError }
      AuthOtpResponse: { data: { messageId?: string | null; session: null; user: null }; error: null } | { data: { messageId?: string | null; session: null; user: null }; error: AuthError }
      +

      AuthOtpResponse is returned when OTP is used.

      +

      {@see AuthRsponse}

      +
      AuthResponse: { data: { session: AuthSession | null; user: AuthUser | null }; error: null } | { data: { session: null; user: null }; error: AuthError }
      AuthTokenResponse: { data: { session: AuthSession; user: AuthUser }; error: null } | { data: { session: null; user: null }; error: AuthError }
      AuthenticatorAssuranceLevels: "aal1" | "aal2"
      CallRefreshTokenResult: { error: null; session: AuthSession } | { error: AuthError; session: null }
      EmailOtpType: "signup" | "invite" | "magiclink" | "recovery" | "email_change" | "email"
      GenerateEmailChangeLinkParams: { email: string; newEmail: string; options?: Pick<GenerateLinkOptions, "redirectTo">; type: "email_change_current" | "email_change_new" }

      Type declaration

      • email: string
        +

        The user's email

        +
      • newEmail: string
        +

        The user's new email. Only required if type is 'email_change_current' or 'email_change_new'.

        +
      • Optional options?: Pick<GenerateLinkOptions, "redirectTo">
      • type: "email_change_current" | "email_change_new"
      GenerateInviteOrMagiclinkParams: { email: string; options?: Pick<GenerateLinkOptions, "data" | "redirectTo">; type: "invite" | "magiclink" }

      Type declaration

      • email: string
        +

        The user's email

        +
      • Optional options?: Pick<GenerateLinkOptions, "data" | "redirectTo">
      • type: "invite" | "magiclink"
      GenerateLinkProperties: { action_link: string; email_otp: string; hashed_token: string; redirect_to: string; verification_type: GenerateLinkType }
      +

      The properties related to the email link generated

      +

      Type declaration

      • action_link: string
        +

        The email link to send to the user. +The action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}

        +
      • email_otp: string
        +

        The raw email OTP. +You should send this in the email if you want your users to verify using an OTP instead of the action link.

        +
      • hashed_token: string
        +

        The hashed token appended to the action link.

        +
      • redirect_to: string
        +

        The URL appended to the action link.

        +
      • verification_type: GenerateLinkType
        +

        The verification type that the email link is associated to.

        +
      GenerateLinkResponse: { data: { properties: GenerateLinkProperties; user: AuthUser }; error: null } | { data: { properties: null; user: null }; error: AuthError }
      GenerateLinkType: "signup" | "invite" | "magiclink" | "recovery" | "email_change_current" | "email_change_new"
      GenerateRecoveryLinkParams: { email: string; options?: Pick<GenerateLinkOptions, "redirectTo">; type: "recovery" }

      Type declaration

      • email: string
        +

        The user's email

        +
      • Optional options?: Pick<GenerateLinkOptions, "redirectTo">
      • type: "recovery"
      GenerateSignupLinkParams: { email: string; options?: Pick<GenerateLinkOptions, "data" | "redirectTo">; password: string; type: "signup" }

      Type declaration

      • email: string
      • Optional options?: Pick<GenerateLinkOptions, "data" | "redirectTo">
      • password: string
      • type: "signup"
      GoTrueClientOptions: { autoRefreshToken?: boolean; debug?: boolean | ((message: string, ...args: any[]) => void); detectSessionInUrl?: boolean; fetch?: Fetch; flowType?: AuthFlowType; headers?: {}; lock?: LockFunc; persistSession?: boolean; storage?: SupportedStorage; storageKey?: string; url?: string }

      Type declaration

      • Optional autoRefreshToken?: boolean
      • Optional debug?: boolean | ((message: string, ...args: any[]) => void)
      • Optional detectSessionInUrl?: boolean
      • Optional fetch?: Fetch
      • Optional flowType?: AuthFlowType
      • Optional headers?: {}
        • [key: string]: string
      • Optional lock?: LockFunc
        +

        Provide your own locking mechanism based on the environment. By default no locking is done at this time.

        +
        experimental
      • Optional persistSession?: boolean
      • Optional storage?: SupportedStorage
      • Optional storageKey?: string
      • Optional url?: string
      InitializeResult: { error: AuthError | null }

      Type declaration

      LockFunc: (<R>(name: string, acquireTimeout: number, fn: (() => Promise<R>)) => Promise<R>)

      Type declaration

        • <R>(name: string, acquireTimeout: number, fn: (() => Promise<R>)): Promise<R>
        • +

          Provide your own global lock implementation instead of the default +implementation. The function should acquire a lock for the duration of the +fn async function, such that no other client instances will be able to +hold it at the same time.

          +
          experimental

          Type Parameters

          • R

          Parameters

          • name: string
            +

            Name of the lock to be acquired.

            +
          • acquireTimeout: number
            +

            If negative, no timeout should occur. If positive it + should throw an Error with an isAcquireTimeout + property set to true if the operation fails to be + acquired after this much time (ms).

            +
          • fn: (() => Promise<R>)
            +

            The operation to execute when the lock is acquired.

            +
              • (): Promise<R>
              • Returns Promise<R>

          Returns Promise<R>

      MFAChallengeAndVerifyParams: { code: string; factorId: string }

      Type declaration

      • code: string
        +

        Verification code provided by the user.

        +
      • factorId: string
        +

        ID of the factor being verified. Returned in enroll().

        +
      MFAChallengeParams: { factorId: string }

      Type declaration

      • factorId: string
        +

        ID of the factor to be challenged. Returned in enroll().

        +
      MFAEnrollParams: { factorType: "totp"; friendlyName?: string; issuer?: string }

      Type declaration

      • factorType: "totp"
        +

        The type of factor being enrolled.

        +
      • Optional friendlyName?: string
        +

        Human readable name assigned to the factor.

        +
      • Optional issuer?: string
        +

        Domain which the user is enrolled with.

        +
      MFAUnenrollParams: { factorId: string }

      Type declaration

      • factorId: string
        +

        ID of the factor being unenrolled.

        +
      MFAVerifyParams: { challengeId: string; code: string; factorId: string }

      Type declaration

      • challengeId: string
        +

        ID of the challenge being verified. Returned in challenge().

        +
      • code: string
        +

        Verification code provided by the user.

        +
      • factorId: string
        +

        ID of the factor being verified. Returned in enroll().

        +
      MobileOtpType: "sms" | "phone_change"
      OAuthResponse: { data: { provider: Provider; url: string }; error: null } | { data: { provider: Provider; url: null }; error: AuthError }
      PageParams: { page?: number; perPage?: number }

      Type declaration

      • Optional page?: number
        +

        The page number

        +
      • Optional perPage?: number
        +

        Number of items returned per page

        +
      Pagination: { lastPage: number; nextPage: number | null; total: number }

      Type declaration

      • [key: string]: any
      • lastPage: number
      • nextPage: number | null
      • total: number
      PostgrestError: { code: string; details: string; hint: string; message: string }

      Type declaration

      • code: string
      • details: string
      • hint: string
      • message: string
      PostgrestMaybeSingleResponse<T>: PostgrestSingleResponse<T | null>

      Type Parameters

      • T

      PostgrestResponse<T>: PostgrestSingleResponse<T[]>

      Type Parameters

      • T

      PostgrestSingleResponse<T>: PostgrestResponseSuccess<T> | PostgrestResponseFailure

      Type Parameters

      • T

      Provider: "apple" | "azure" | "bitbucket" | "discord" | "facebook" | "figma" | "github" | "gitlab" | "google" | "kakao" | "keycloak" | "linkedin" | "notion" | "slack" | "spotify" | "twitch" | "twitter" | "workos" | "zoom"
      +

      One of the providers supported by GoTrue.

      +
      RealtimeChannelOptions: { config: { broadcast?: { ack?: boolean; self?: boolean }; presence?: { key?: string } } }

      Type declaration

      • config: { broadcast?: { ack?: boolean; self?: boolean }; presence?: { key?: string } }
        • Optional broadcast?: { ack?: boolean; self?: boolean }
          +

          self option enables client to receive message it broadcast +ack option instructs server to acknowledge that broadcast message was received

          +
          • Optional ack?: boolean
          • Optional self?: boolean
        • Optional presence?: { key?: string }
          +

          key option is used to track presence payload across clients

          +
          • Optional key?: string
      RealtimeChannelSendResponse: "ok" | "timed out" | "rate limited"
      RealtimeClientOptions: { decode?: Function; encode?: Function; headers?: {}; heartbeatIntervalMs?: number; log_level?: "info" | "debug" | "warn" | "error"; logger?: Function; params?: {}; reconnectAfterMs?: Function; timeout?: number; transport?: WebSocket }

      Type declaration

      • Optional decode?: Function
      • Optional encode?: Function
      • Optional headers?: {}
        • [key: string]: string
      • Optional heartbeatIntervalMs?: number
      • Optional log_level?: "info" | "debug" | "warn" | "error"
      • Optional logger?: Function
      • Optional params?: {}
        • [key: string]: any
      • Optional reconnectAfterMs?: Function
      • Optional timeout?: number
      • Optional transport?: WebSocket
      RealtimeMessage: { event: string; join_ref?: string; payload: any; ref: string; topic: string }

      Type declaration

      • event: string
      • Optional join_ref?: string
      • payload: any
      • ref: string
      • topic: string
      RealtimePostgresChangesFilter<T>: { event: T; filter?: string; schema: string; table?: string }

      Type Parameters

      Type declaration

      • event: T
        +

        The type of database change to listen to.

        +
      • Optional filter?: string
        +

        Receive database changes when filter is matched.

        +
      • schema: string
        +

        The database schema to listen to.

        +
      • Optional table?: string
        +

        The database table to listen to.

        +

      Type Parameters

      • T extends {}

      RealtimePostgresDeletePayload<T>: RealtimePostgresChangesPayloadBase & { eventType: `${DELETE}`; new: {}; old: Partial<T> }

      Type Parameters

      • T extends {}

      RealtimePostgresInsertPayload<T>: RealtimePostgresChangesPayloadBase & { eventType: `${INSERT}`; new: T; old: {} }

      Type Parameters

      • T extends {}

      RealtimePostgresUpdatePayload<T>: RealtimePostgresChangesPayloadBase & { eventType: `${UPDATE}`; new: T; old: Partial<T> }

      Type Parameters

      • T extends {}

      RealtimePresenceJoinPayload<T>: { currentPresences: Presence<T>[]; event: `${JOIN}`; key: string; newPresences: Presence<T>[] }

      Type Parameters

      • T extends {}

      Type declaration

      • currentPresences: Presence<T>[]
      • event: `${JOIN}`
      • key: string
      • newPresences: Presence<T>[]
      RealtimePresenceLeavePayload<T>: { currentPresences: Presence<T>[]; event: `${LEAVE}`; key: string; leftPresences: Presence<T>[] }

      Type Parameters

      • T extends {}

      Type declaration

      • currentPresences: Presence<T>[]
      • event: `${LEAVE}`
      • key: string
      • leftPresences: Presence<T>[]
      RealtimePresenceState<T>: {}

      Type Parameters

      • T extends {} = {}

      Type declaration

      • [key: string]: Presence<T>[]
      RealtimeRemoveChannelResponse: "ok" | "timed out" | "error"
      ResendParams: { email: string; options?: { captchaToken?: string; emailRedirectTo?: string }; type: Extract<EmailOtpType, "signup" | "email_change"> } | { options?: { captchaToken?: string }; phone: string; type: Extract<MobileOtpType, "sms" | "phone_change"> }
      SSOResponse: { data: { url: string }; error: null } | { data: null; error: AuthError }
      SignInWithIdTokenCredentials: { access_token?: string; nonce?: string; options?: { captchaToken?: string }; provider: "google" | "apple" | "azure" | "facebook" | string; token: string }

      Type declaration

      • Optional access_token?: string
        +

        If the ID token contains an at_hash claim, then the hash of this value is compared to the value in the ID token.

        +
      • Optional nonce?: string
        +

        If the ID token contains a nonce claim, then the hash of this value is compared to the value in the ID token.

        +
      • Optional options?: { captchaToken?: string }
        • Optional captchaToken?: string
          +

          Verification token received when the user completes the captcha on the site.

          +
      • provider: "google" | "apple" | "azure" | "facebook" | string
        +

        Provider name or OIDC iss value identifying which provider should be used to verify the provided token. Supported names: google, apple, azure, facebook, keycloak (deprecated).

        +
      • token: string
        +

        OIDC ID token issued by the specified provider. The iss claim in the ID token must match the supplied provider. Some ID tokens contain an at_hash which require that you provide an access_token value to be accepted properly. If the token contains a nonce claim you must supply the nonce used to obtain the ID token.

        +
      SignInWithOAuthCredentials: { options?: { queryParams?: {}; redirectTo?: string; scopes?: string; skipBrowserRedirect?: boolean }; provider: Provider }

      Type declaration

      • Optional options?: { queryParams?: {}; redirectTo?: string; scopes?: string; skipBrowserRedirect?: boolean }
        • Optional queryParams?: {}
          +

          An object of query params

          +
          • [key: string]: string
        • Optional redirectTo?: string
          +

          A URL to send the user to after they are confirmed.

          +
        • Optional scopes?: string
          +

          A space-separated list of scopes granted to the OAuth application.

          +
        • Optional skipBrowserRedirect?: boolean
          +

          If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider.

          +
      • provider: Provider
        +

        One of the providers supported by GoTrue.

        +
      SignInWithPasswordCredentials: { email: string; options?: { captchaToken?: string }; password: string } | { options?: { captchaToken?: string; data?: object }; password: string; phone: string }
      SignInWithPasswordlessCredentials: { email: string; options?: { captchaToken?: string; data?: object; emailRedirectTo?: string; shouldCreateUser?: boolean } } | { options?: { captchaToken?: string; channel?: "sms" | "whatsapp"; data?: object; shouldCreateUser?: boolean }; phone: string }
      SignInWithSSO: { options?: { captchaToken?: string; redirectTo?: string }; providerId: string } | { domain: string; options?: { captchaToken?: string; redirectTo?: string } }
      SignOut: { scope?: "global" | "local" | "others" }

      Type declaration

      • Optional scope?: "global" | "local" | "others"
        +

        Determines which sessions should be +logged out. Global means all +sessions by this account. Local +means only this session. Others +means all other sessions except the +current one. When using others, +there is no sign-out event fired on +the current session!

        +
      SignUpWithPasswordCredentials: { email: string; options?: { captchaToken?: string; data?: object; emailRedirectTo?: string }; password: string } | { options?: { captchaToken?: string; channel?: "sms" | "whatsapp"; data?: object }; password: string; phone: string }
      SupportedStorage: PromisifyMethods<Pick<Storage, "getItem" | "setItem" | "removeItem">>
      UserResponse: { data: { user: AuthUser }; error: null } | { data: { user: null }; error: AuthError }

      Variables

      lockInternals: { debug: boolean }
      experimental

      Type declaration

      • debug: boolean
        experimental

      Functions

      • createClient<Database, SchemaName, Schema>(supabaseUrl: string, supabaseKey: string, options?: SupabaseClientOptions<SchemaName>): SupabaseClient<Database, SchemaName, Schema>
      • +

        Creates a new Supabase Client.

        +

        Type Parameters

        • Database = any

        • SchemaName extends string = "public" extends keyof Database ? "public" : string & keyof Database

        • Schema extends GenericSchema = Database[SchemaName] extends GenericSchema ? any[any] : any

        Parameters

        Returns SupabaseClient<Database, SchemaName, Schema>

      • Parameters

        • error: unknown

        Returns error is AuthApiError

      • isAuthError(error: unknown): error is AuthError
      • Parameters

        • error: unknown

        Returns error is AuthError

      • Parameters

        • error: unknown

        Returns error is AuthRetryableFetchError

      • navigatorLock<R>(name: string, acquireTimeout: number, fn: (() => Promise<R>)): Promise<R>
      • +

        Implements a global exclusive lock using the Navigator LockManager API. It +is available on all browsers released after 2022-03-15 with Safari being the +last one to release support. If the API is not available, this function will +throw. Make sure you check availablility before configuring GoTrueClient.

        +

        You can turn on debugging by setting the supabase.gotrue-js.locks.debug +local storage item to true.

        +

        Internals:

        +

        Since the LockManager API does not preserve stack traces for the async +function passed in the request method, a trick is used where acquiring the +lock releases a previously started promise to run the operation in the fn +function. The lock waits for that promise to finish (with or without error), +while the function will finally wait for the result anyway.

        +
        experimental

        Type Parameters

        • R

        Parameters

        • name: string
          +

          Name of the lock to be acquired.

          +
        • acquireTimeout: number
          +

          If negative, no timeout. If 0 an error is thrown if + the lock can't be acquired without waiting. If positive, the lock acquire + will time out after so many milliseconds. An error is + a timeout if it has isAcquireTimeout set to true.

          +
        • fn: (() => Promise<R>)
          +

          The operation to run once the lock is acquired.

          +
            • (): Promise<R>
            • Returns Promise<R>

        Returns Promise<R>

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/modules/lib_constants.html b/v2/modules/lib_constants.html new file mode 100644 index 00000000..8f3fec77 --- /dev/null +++ b/v2/modules/lib_constants.html @@ -0,0 +1 @@ +lib/constants | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Index

      Variables

      DEFAULT_HEADERS: { X-Client-Info: string } = ...

      Type declaration

      • X-Client-Info: string

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/modules/lib_fetch.html b/v2/modules/lib_fetch.html new file mode 100644 index 00000000..f4699fa7 --- /dev/null +++ b/v2/modules/lib_fetch.html @@ -0,0 +1 @@ +lib/fetch | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Index

      Functions

      • fetchWithAuth(supabaseKey: string, getAccessToken: (() => Promise<null | string>), customFetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)): ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
      • Parameters

        • supabaseKey: string
        • getAccessToken: (() => Promise<null | string>)
            • (): Promise<null | string>
            • Returns Promise<null | string>

        • Optional customFetch: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
            • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
            • Parameters

              • input: RequestInfo | URL
              • Optional init: RequestInit

              Returns Promise<Response>

        Returns ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

          • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
          • Parameters

            • input: RequestInfo | URL
            • Optional init: RequestInit

            Returns Promise<Response>

      • resolveFetch(customFetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)): ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
      • Parameters

        • Optional customFetch: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
            • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
            • Parameters

              • input: RequestInfo | URL
              • Optional init: RequestInit

              Returns Promise<Response>

        Returns ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

          • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
          • Parameters

            • input: RequestInfo | URL
            • Optional init: RequestInit

            Returns Promise<Response>

      • resolveHeadersConstructor(): any

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/modules/lib_helpers.html b/v2/modules/lib_helpers.html new file mode 100644 index 00000000..56c16f4e --- /dev/null +++ b/v2/modules/lib_helpers.html @@ -0,0 +1 @@ +lib/helpers | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Index

      Functions

      • isBrowser(): boolean
      • stripTrailingSlash(url: string): string
      • uuid(): string

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/modules/lib_types.html b/v2/modules/lib_types.html new file mode 100644 index 00000000..0fe4ea64 --- /dev/null +++ b/v2/modules/lib_types.html @@ -0,0 +1,25 @@ +lib/types | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Index

      Type Aliases

      Fetch: typeof __type
      GenericFunction: { Args: Record<string, unknown>; Returns: unknown }

      Type declaration

      • Args: Record<string, unknown>
      • Returns: unknown
      GenericNonUpdatableView: { Row: Record<string, unknown> }

      Type declaration

      • Row: Record<string, unknown>
      GenericSchema: { Functions: Record<string, GenericFunction>; Tables: Record<string, GenericTable>; Views: Record<string, GenericView> }

      Type declaration

      GenericTable: { Insert: Record<string, unknown>; Row: Record<string, unknown>; Update: Record<string, unknown> }

      Type declaration

      • Insert: Record<string, unknown>
      • Row: Record<string, unknown>
      • Update: Record<string, unknown>
      GenericUpdatableView: { Insert: Record<string, unknown>; Row: Record<string, unknown>; Update: Record<string, unknown> }

      Type declaration

      • Insert: Record<string, unknown>
      • Row: Record<string, unknown>
      • Update: Record<string, unknown>
      SupabaseClientOptions<SchemaName>: { auth?: { autoRefreshToken?: boolean; debug?: SupabaseAuthClientOptions["debug"]; detectSessionInUrl?: boolean; flowType?: SupabaseAuthClientOptions["flowType"]; lock?: SupabaseAuthClientOptions["lock"]; persistSession?: boolean; storage?: SupabaseAuthClientOptions["storage"]; storageKey?: string }; db?: { schema?: SchemaName }; global?: { fetch?: Fetch; headers?: Record<string, string> }; realtime?: RealtimeClientOptions }

      Type Parameters

      • SchemaName

      Type declaration

      • Optional auth?: { autoRefreshToken?: boolean; debug?: SupabaseAuthClientOptions["debug"]; detectSessionInUrl?: boolean; flowType?: SupabaseAuthClientOptions["flowType"]; lock?: SupabaseAuthClientOptions["lock"]; persistSession?: boolean; storage?: SupabaseAuthClientOptions["storage"]; storageKey?: string }
        • Optional autoRefreshToken?: boolean
          +

          Automatically refreshes the token for logged-in users. Defaults to true.

          +
        • Optional debug?: SupabaseAuthClientOptions["debug"]
          +

          If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library.

          +
        • Optional detectSessionInUrl?: boolean
          +

          Detect a session from the URL. Used for OAuth login callbacks. Defaults to true.

          +
        • Optional flowType?: SupabaseAuthClientOptions["flowType"]
          +

          OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications.

          +
        • Optional lock?: SupabaseAuthClientOptions["lock"]
          +

          Provide your own locking mechanism based on the environment. By default no locking is done at this time.

          +
          experimental
        • Optional persistSession?: boolean
          +

          Whether to persist a logged-in session to storage. Defaults to true.

          +
        • Optional storage?: SupabaseAuthClientOptions["storage"]
          +

          A storage provider. Used to store the logged-in session.

          +
        • Optional storageKey?: string
          +

          Optional key name used for storing tokens in local storage.

          +
      • Optional db?: { schema?: SchemaName }
        +

        The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to public.

        +
        • Optional schema?: SchemaName
      • Optional global?: { fetch?: Fetch; headers?: Record<string, string> }
        • Optional fetch?: Fetch
          +

          A custom fetch implementation.

          +
        • Optional headers?: Record<string, string>
          +

          Optional headers for initializing the client.

          +
      • Optional realtime?: RealtimeClientOptions
        +

        Options passed to the realtime-js instance

        +

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/modules/lib_version.html b/v2/modules/lib_version.html new file mode 100644 index 00000000..c61bbd92 --- /dev/null +++ b/v2/modules/lib_version.html @@ -0,0 +1 @@ +lib/version | @supabase/supabase-js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Index

      Variables

      Variables

      version: "0.0.0-automated" = '0.0.0-automated'

      Legend

      • Variable
      • Function
      • Function with type parameter
      • Type alias
      • Type alias with type parameter
      • Interface
      • Class with type parameter

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/v2/spec.json b/v2/spec.json new file mode 100644 index 00000000..5f9505d3 --- /dev/null +++ b/v2/spec.json @@ -0,0 +1,4457 @@ +{ + "id": 0, + "name": "@supabase/supabase-js", + "kind": 1, + "flags": {}, + "originalName": "", + "children": [ + { + "id": 1, + "name": "index", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 202, + "name": "SupabaseClientOptions", + "kind": 16777216, + "kindString": "Reference", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 20, + "character": 14 + } + ], + "target": 60 + }, + { + "id": 106, + "name": "SupabaseClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Supabase Client.", + "text": "An isomorphic Javascript client for interacting with Postgres.\n" + }, + "children": [ + { + "id": 107, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 83, + "character": 2 + } + ], + "signatures": [ + { + "id": 108, + "name": "new SupabaseClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Create a new client for use in the browser." + }, + "typeParameter": [ + { + "id": 109, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 110, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 109, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 109, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 111, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 99, + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 110, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 109, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "id": 99, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "parameters": [ + { + "id": 112, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 113, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 114, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 60, + "typeArguments": [ + { + "type": "reference", + "id": 110, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 106, + "typeArguments": [ + { + "type": "reference", + "id": 109, + "name": "Database" + }, + { + "type": "reference", + "id": 110, + "name": "SchemaName" + }, + { + "type": "reference", + "id": 111, + "name": "Schema" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 115, + "name": "auth", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 55, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "SupabaseAuthClient" + } + }, + { + "id": 118, + "name": "authUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 128, + "name": "changedAccessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 65, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 123, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 64, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 124, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 125, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 126, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 127, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + }, + { + "id": 120, + "name": "functionsUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 61, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 129, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 67, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 130, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 131, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 132, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 116, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClient", + "package": "@supabase/realtime-js", + "name": "default" + } + }, + { + "id": 117, + "name": "realtimeUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 58, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 121, + "name": "rest", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 62, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 109, + "name": "Database" + }, + { + "type": "reference", + "id": 110, + "name": "SchemaName" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 110, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 109, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "qualifiedName": "GenericSchema", + "package": "@supabase/postgrest-js", + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + ], + "qualifiedName": "PostgrestClient", + "package": "@supabase/postgrest-js", + "name": "default" + } + }, + { + "id": 122, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 63, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 119, + "name": "storageUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 134, + "name": "supabaseKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 133, + "name": "supabaseUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 135, + "name": "functions", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 132, + "character": 6 + } + ], + "getSignature": [ + { + "id": 136, + "name": "functions", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "comment": { + "shortText": "Supabase Functions allows you to deploy and invoke edge functions." + }, + "type": { + "type": "reference", + "qualifiedName": "FunctionsClient", + "package": "@supabase/functions-js", + "name": "FunctionsClient" + } + } + ] + }, + { + "id": 137, + "name": "storage", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 142, + "character": 6 + } + ], + "getSignature": [ + { + "id": 138, + "name": "storage", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "comment": { + "shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos." + }, + "type": { + "type": "reference", + "qualifiedName": "StorageClient", + "package": "@supabase/storage-js", + "name": "StorageClient" + } + } + ] + }, + { + "id": 177, + "name": "_getAccessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 259, + "character": 16 + } + ], + "signatures": [ + { + "id": 178, + "name": "_getAccessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 194, + "name": "_handleTokenChanged", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 310, + "character": 10 + } + ], + "signatures": [ + { + "id": 195, + "name": "_handleTokenChanged", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 196, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "AuthChangeEvent", + "package": "@supabase/gotrue-js", + "name": "AuthChangeEvent" + } + }, + { + "id": 197, + "name": "source", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "CLIENT" + }, + { + "type": "literal", + "value": "STORAGE" + } + ] + } + }, + { + "id": 198, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 188, + "name": "_initRealtimeClient", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 296, + "character": 10 + } + ], + "signatures": [ + { + "id": 189, + "name": "_initRealtimeClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 190, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RealtimeClientOptions", + "package": "@supabase/realtime-js", + "name": "RealtimeClientOptions" + } + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClient", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ] + }, + { + "id": 179, + "name": "_initSupabaseAuthClient", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 265, + "character": 10 + } + ], + "signatures": [ + { + "id": 180, + "name": "_initSupabaseAuthClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 181, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 58, + "name": "SupabaseAuthClientOptions" + } + }, + { + "id": 182, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 183, + "name": "fetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 184, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 185, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 186, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 187, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "name": "SupabaseAuthClient" + } + } + ] + }, + { + "id": 191, + "name": "_listenForAuthEvents", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 303, + "character": 10 + } + ], + "signatures": [ + { + "id": 192, + "name": "_listenForAuthEvents", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 193, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + } + ] + }, + { + "id": 166, + "name": "channel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 231, + "character": 2 + } + ], + "signatures": [ + { + "id": 167, + "name": "channel", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." + }, + "parameters": [ + { + "id": 168, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The name of the Realtime channel." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 169, + "name": "opts", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The options to pass to the Realtime channel.\n\n" + }, + "type": { + "type": "reference", + "qualifiedName": "RealtimeChannelOptions", + "package": "@supabase/realtime-js", + "name": "RealtimeChannelOptions" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeChannel", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ] + }, + { + "id": 139, + "name": "from", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 146, + "character": 2 + } + ], + "signatures": [ + { + "id": 140, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a query on a table or a view." + }, + "typeParameter": [ + { + "id": 141, + "name": "TableName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 142, + "name": "Table", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 81, + "name": "GenericTable" + } + } + ], + "parameters": [ + { + "id": 143, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The table or view name to query\n" + }, + "type": { + "type": "reference", + "id": 141, + "name": "TableName" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 111, + "name": "Schema" + }, + { + "type": "reference", + "id": 142, + "name": "Table" + }, + { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 142, + "name": "Table" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 144, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + }, + "trueType": { + "type": "reference", + "qualifiedName": "R", + "package": "@supabase/postgrest-js", + "name": "R" + }, + "falseType": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "qualifiedName": "PostgrestQueryBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + }, + { + "id": 145, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a query on a table or a view." + }, + "typeParameter": [ + { + "id": 146, + "name": "ViewName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 147, + "name": "View", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 94, + "name": "GenericView" + } + } + ], + "parameters": [ + { + "id": 148, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The table or view name to query\n" + }, + "type": { + "type": "reference", + "id": 146, + "name": "ViewName" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 111, + "name": "Schema" + }, + { + "type": "reference", + "id": 147, + "name": "View" + }, + { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 147, + "name": "View" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 149, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + }, + "trueType": { + "type": "reference", + "qualifiedName": "R", + "package": "@supabase/postgrest-js", + "name": "R" + }, + "falseType": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "qualifiedName": "PostgrestQueryBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + }, + { + "id": 150, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a query on a table or a view." + }, + "parameters": [ + { + "id": 151, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The table or view name to query\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 111, + "name": "Schema" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "PostgrestQueryBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + } + ] + }, + { + "id": 170, + "name": "getChannels", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 238, + "character": 2 + } + ], + "signatures": [ + { + "id": 171, + "name": "getChannels", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns all Realtime channels." + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "RealtimeChannel", + "package": "@supabase/realtime-js", + "name": "default" + } + } + } + ] + }, + { + "id": 175, + "name": "removeAllChannels", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 255, + "character": 2 + } + ], + "signatures": [ + { + "id": 176, + "name": "removeAllChannels", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Unsubscribes and removes all Realtime channels from Realtime client." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "error" + }, + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 172, + "name": "removeChannel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 248, + "character": 2 + } + ], + "signatures": [ + { + "id": 173, + "name": "removeChannel", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Unsubscribes and removes Realtime channel from Realtime client." + }, + "parameters": [ + { + "id": 174, + "name": "channel", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The name of the Realtime channel.\n\n" + }, + "type": { + "type": "reference", + "qualifiedName": "RealtimeChannel", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "error" + }, + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 156, + "name": "rpc", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 202, + "character": 2 + } + ], + "signatures": [ + { + "id": 157, + "name": "rpc", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a function call." + }, + "typeParameter": [ + { + "id": 158, + "name": "FunctionName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 159, + "name": "Function_", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 95, + "name": "GenericFunction" + } + } + ], + "parameters": [ + { + "id": 160, + "name": "fn", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The function name to call" + }, + "type": { + "type": "reference", + "id": 158, + "name": "FunctionName" + } + }, + { + "id": 161, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The arguments to pass to the function call" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Args" + }, + "objectType": { + "type": "reference", + "id": 159, + "name": "Function_" + } + }, + "defaultValue": "{}" + }, + { + "id": 162, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 163, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 165, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 210, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 164, + "name": "head", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 209, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 165, + 164 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 111, + "name": "Schema" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Returns" + }, + "objectType": { + "type": "reference", + "id": 159, + "name": "Function_" + } + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "number" + }, + "objectType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + } + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Returns" + }, + "objectType": { + "type": "reference", + "id": 159, + "name": "Function_" + } + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "PostgrestFilterBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + } + ] + }, + { + "id": 152, + "name": "schema", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 171, + "character": 2 + } + ], + "signatures": [ + { + "id": 153, + "name": "schema", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a query on a schema distinct from the default schema supplied via\nthe `options.db.schema` constructor parameter.", + "text": "The schema needs to be on the list of exposed schemas inside Supabase.\n" + }, + "typeParameter": [ + { + "id": 154, + "name": "DynamicSchema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 155, + "name": "schema", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The name of the schema to query\n" + }, + "type": { + "type": "reference", + "id": 154, + "name": "DynamicSchema" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 109, + "name": "Database" + }, + { + "type": "reference", + "id": 154, + "name": "DynamicSchema" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 154, + "name": "DynamicSchema" + }, + "objectType": { + "type": "reference", + "id": 109, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "id": 99, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + ], + "qualifiedName": "PostgrestClient", + "package": "@supabase/postgrest-js", + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 107 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 115, + 118, + 128, + 123, + 120, + 129, + 116, + 117, + 121, + 122, + 119, + 134, + 133 + ] + }, + { + "title": "Accessors", + "kind": 262144, + "children": [ + 135, + 137 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 177, + 194, + 188, + 179, + 191, + 166, + 139, + 170, + 175, + 172, + 156, + 152 + ] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 43, + "character": 21 + } + ], + "typeParameter": [ + { + "id": 199, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 200, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 109, + "name": "Database" + } + } + ] + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 109, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 109, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 201, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 99, + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 110, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 109, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "id": 99, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 110, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 109, + "name": "Database" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ] + }, + { + "id": 2, + "name": "createClient", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 25, + "character": 13 + } + ], + "signatures": [ + { + "id": 3, + "name": "createClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new Supabase Client." + }, + "typeParameter": [ + { + "id": 4, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 5, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 6, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 99, + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "id": 99, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "parameters": [ + { + "id": 7, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 8, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 9, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 60, + "typeArguments": [ + { + "type": "reference", + "id": 5, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 106, + "typeArguments": [ + { + "type": "reference", + "id": 4, + "name": "Database" + }, + { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + { + "type": "reference", + "id": 6, + "name": "Schema" + } + ], + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "References", + "kind": 16777216, + "children": [ + 202 + ] + }, + { + "title": "Classes", + "kind": 128, + "children": [ + 106 + ] + }, + { + "title": "Functions", + "kind": 64, + "children": [ + 2 + ] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 10, + "name": "lib/constants", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 11, + "name": "DEFAULT_HEADERS", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 14, + "character": 13 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 12, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 13, + "name": "X-Client-Info", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 14, + "character": 33 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 13 + ] + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 11 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 2, + "character": 0 + } + ] + }, + { + "id": 14, + "name": "lib/fetch", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 28, + "name": "fetchWithAuth", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 26, + "character": 13 + } + ], + "signatures": [ + { + "id": 29, + "name": "fetchWithAuth", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 30, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 31, + "name": "getAccessToken", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 32, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 33, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + }, + { + "id": 34, + "name": "customFetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 35, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 36, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 37, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 38, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 39, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 40, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 41, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 42, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + } + ] + }, + { + "id": 15, + "name": "resolveFetch", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 6, + "character": 13 + } + ], + "signatures": [ + { + "id": 16, + "name": "resolveFetch", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 17, + "name": "customFetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 18, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 19, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 20, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 21, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 22, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 23, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 24, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 25, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + } + ] + }, + { + "id": 26, + "name": "resolveHeadersConstructor", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 18, + "character": 13 + } + ], + "signatures": [ + { + "id": 27, + "name": "resolveHeadersConstructor", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "kind": 64, + "children": [ + 28, + 15, + 26 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 2, + "character": 0 + } + ] + }, + { + "id": 43, + "name": "lib/helpers", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 49, + "name": "applySettingDefaults", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 18, + "character": 16 + } + ], + "signatures": [ + { + "id": 50, + "name": "applySettingDefaults", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 51, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 52, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 51, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 51, + "name": "Database" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 53, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 60, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + }, + { + "id": 54, + "name": "defaults", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 60, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 60, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + } + ] + }, + { + "id": 55, + "name": "isBrowser", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 16, + "character": 13 + } + ], + "signatures": [ + { + "id": 56, + "name": "isBrowser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 46, + "name": "stripTrailingSlash", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 12, + "character": 16 + } + ], + "signatures": [ + { + "id": 47, + "name": "stripTrailingSlash", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 48, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 44, + "name": "uuid", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 4, + "character": 16 + } + ], + "signatures": [ + { + "id": 45, + "name": "uuid", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "kind": 64, + "children": [ + 49, + 55, + 46, + 44 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 2, + "character": 0 + } + ] + }, + { + "id": 57, + "name": "lib/types", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 58, + "name": "SupabaseAuthClientOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 6, + "character": 17 + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "GoTrueClientOptions" + } + ] + }, + { + "id": 59, + "name": "Fetch", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 18, + "qualifiedName": "fetch", + "package": "typescript", + "name": "fetch" + } + } + }, + { + "id": 95, + "name": "GenericFunction", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 96, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 97, + "name": "Args", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 89, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 98, + "name": "Returns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 97, + 98 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 30 + } + ] + } + } + }, + { + "id": 91, + "name": "GenericNonUpdatableView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 82, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 92, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 93, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 83, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 93 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 82, + "character": 38 + } + ] + } + } + }, + { + "id": 99, + "name": "GenericSchema", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 93, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 100, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 103, + "name": "Functions", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 96, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 95, + "name": "GenericFunction" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 101, + "name": "Tables", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 94, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 81, + "name": "GenericTable" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 102, + "name": "Views", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 95, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 94, + "name": "GenericView" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 103, + 101, + 102 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 93, + "character": 28 + } + ] + } + } + }, + { + "id": 81, + "name": "GenericTable", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 82, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 84, + "name": "Insert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 72, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 83, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 85, + "name": "Update", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 73, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 84, + 83, + 85 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 27 + } + ] + } + } + }, + { + "id": 86, + "name": "GenericUpdatableView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 76, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 87, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 89, + "name": "Insert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 78, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 88, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 77, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 90, + "name": "Update", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 79, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 89, + 88, + 90 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 76, + "character": 35 + } + ] + } + } + }, + { + "id": 94, + "name": "GenericView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 86, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 86, + "name": "GenericUpdatableView" + }, + { + "type": "reference", + "id": 91, + "name": "GenericNonUpdatableView" + } + ] + } + }, + { + "id": 60, + "name": "SupabaseClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 80, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 61, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 65, + "name": "auth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 66, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 67, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 22, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 73, + "name": "debug", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 46, + "character": 4 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "debug" + }, + "objectType": { + "type": "reference", + "id": 58, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 70, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 34, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 72, + "name": "flowType", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 42, + "character": 4 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "flowType" + }, + "objectType": { + "type": "reference", + "id": 58, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 74, + "name": "lock", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", + "tags": [ + { + "tag": "experimental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 52, + "character": 4 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "lock" + }, + "objectType": { + "type": "reference", + "id": 58, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 69, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Whether to persist a logged-in session to storage. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 71, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A storage provider. Used to store the logged-in session." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 38, + "character": 4 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "storage" + }, + "objectType": { + "type": "reference", + "id": 58, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 68, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optional key name used for storing tokens in local storage." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 26, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 67, + 73, + 70, + 72, + 74, + 69, + 71, + 68 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 18, + "character": 9 + } + ] + } + } + }, + { + "id": 62, + "name": "db", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 14, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 63, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 64, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 15, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 80, + "name": "SchemaName" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 64 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 14, + "character": 7 + } + ] + } + } + }, + { + "id": 76, + "name": "global", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 58, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 77, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 78, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom `fetch` implementation." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 62, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 59, + "name": "Fetch" + } + }, + { + "id": 79, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optional headers for initializing the client." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 4 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 78, + 79 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 58, + "character": 11 + } + ] + } + } + }, + { + "id": 75, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Options passed to the realtime-js instance" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClientOptions", + "package": "@supabase/realtime-js", + "name": "RealtimeClientOptions" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 65, + 62, + 76, + 75 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 48 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Interfaces", + "kind": 256, + "children": [ + 58 + ] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [ + 59, + 95, + 91, + 99, + 81, + 86, + 94, + 60 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 104, + "name": "lib/version", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 105, + "name": "version", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, + "sources": [ + { + "fileName": "src/lib/version.ts", + "line": 1, + "character": 13 + } + ], + "type": { + "type": "literal", + "value": "0.0.0-automated" + }, + "defaultValue": "'0.0.0-automated'" + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 105 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/version.ts", + "line": 1, + "character": 0 + } + ] + } + ], + "groups": [ + { + "title": "Modules", + "kind": 2, + "children": [ + 1, + 10, + 14, + 43, + 57, + 104 + ] + } + ] +} \ No newline at end of file