-
Notifications
You must be signed in to change notification settings - Fork 109
Commit
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
:root { | ||
--light-hl-0: #795E26; | ||
--dark-hl-0: #DCDCAA; | ||
--light-hl-1: #000000; | ||
--dark-hl-1: #D4D4D4; | ||
--light-hl-2: #A31515; | ||
--dark-hl-2: #CE9178; | ||
--light-hl-3: #0000FF; | ||
--dark-hl-3: #569CD6; | ||
--light-hl-4: #008000; | ||
--dark-hl-4: #6A9955; | ||
--light-hl-5: #800000; | ||
--dark-hl-5: #808080; | ||
--light-hl-6: #800000; | ||
--dark-hl-6: #569CD6; | ||
--light-hl-7: #000000FF; | ||
--dark-hl-7: #D4D4D4; | ||
--light-hl-8: #E50000; | ||
--dark-hl-8: #9CDCFE; | ||
--light-hl-9: #0000FF; | ||
--dark-hl-9: #CE9178; | ||
--light-hl-10: #AF00DB; | ||
--dark-hl-10: #C586C0; | ||
--light-hl-11: #001080; | ||
--dark-hl-11: #9CDCFE; | ||
--light-hl-12: #0070C1; | ||
--dark-hl-12: #4FC1FF; | ||
--light-hl-13: #098658; | ||
--dark-hl-13: #B5CEA8; | ||
--light-hl-14: #267F99; | ||
--dark-hl-14: #4EC9B0; | ||
--light-hl-15: #EE0000; | ||
--dark-hl-15: #D7BA7D; | ||
--light-code-background: #FFFFFF; | ||
--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); | ||
--hl-13: var(--light-hl-13); | ||
--hl-14: var(--light-hl-14); | ||
--hl-15: var(--light-hl-15); | ||
--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); | ||
--hl-13: var(--dark-hl-13); | ||
--hl-14: var(--dark-hl-14); | ||
--hl-15: var(--dark-hl-15); | ||
--code-background: var(--dark-code-background); | ||
} } | ||
|
||
:root[data-theme='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); | ||
--hl-13: var(--light-hl-13); | ||
--hl-14: var(--light-hl-14); | ||
--hl-15: var(--light-hl-15); | ||
--code-background: var(--light-code-background); | ||
} | ||
|
||
:root[data-theme='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); | ||
--hl-13: var(--dark-hl-13); | ||
--hl-14: var(--dark-hl-14); | ||
--hl-15: var(--dark-hl-15); | ||
--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); } | ||
.hl-13 { color: var(--hl-13); } | ||
.hl-14 { color: var(--hl-14); } | ||
.hl-15 { color: var(--hl-15); } | ||
pre, code { background: var(--code-background); } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CollectionStatus | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/collections.html">collections</a></li><li><a href="collections.CollectionStatus.html">CollectionStatus</a></li></ul><h1>Enumeration CollectionStatus</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Integer values indicating the collection loading status.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L80">collections.ts:80</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="collections.CollectionStatus.html#DELETED" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DELETED</span></a> | ||
<a href="collections.CollectionStatus.html#LOADED" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>LOADED</span></a> | ||
<a href="collections.CollectionStatus.html#LOADING" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>LOADING</span></a> | ||
<a href="collections.CollectionStatus.html#NEWBORN" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>NEWBORN</span></a> | ||
<a href="collections.CollectionStatus.html#UNLOADED" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>UNLOADED</span></a> | ||
<a href="collections.CollectionStatus.html#UNLOADING" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>UNLOADING</span></a> | ||
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="DELETED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DELETED</span><a href="#DELETED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">DELETED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">5</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L85">collections.ts:85</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="LOADED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>LOADED</span><a href="#LOADED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">LOADED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L83">collections.ts:83</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="LOADING" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>LOADING</span><a href="#LOADING" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">LOADING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">6</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L86">collections.ts:86</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="NEWBORN" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>NEWBORN</span><a href="#NEWBORN" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">NEWBORN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L81">collections.ts:81</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="UNLOADED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>UNLOADED</span><a href="#UNLOADED" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">UNLOADED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L82">collections.ts:82</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="UNLOADING" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>UNLOADING</span><a href="#UNLOADING" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">UNLOADING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">4</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L84">collections.ts:84</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#DELETED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DELETED</span></a><a href="#LOADED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>LOADED</span></a><a href="#LOADING" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>LOADING</span></a><a href="#NEWBORN" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>NEWBORN</span></a><a href="#UNLOADED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>UNLOADED</span></a><a href="#UNLOADING" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>UNLOADING</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CollectionType | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/collections.html">collections</a></li><li><a href="collections.CollectionType.html">CollectionType</a></li></ul><h1>Enumeration CollectionType</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Integer values indicating the collection type.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L72">collections.ts:72</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="collections.CollectionType.html#DOCUMENT_COLLECTION" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DOCUMENT_<wbr/>COLLECTION</span></a> | ||
<a href="collections.CollectionType.html#EDGE_COLLECTION" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EDGE_<wbr/>COLLECTION</span></a> | ||
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="DOCUMENT_COLLECTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DOCUMENT_<wbr/>COLLECTION</span><a href="#DOCUMENT_COLLECTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">DOCUMENT_<wbr/>COLLECTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L73">collections.ts:73</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="EDGE_COLLECTION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>EDGE_<wbr/>COLLECTION</span><a href="#EDGE_COLLECTION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">EDGE_<wbr/>COLLECTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L74">collections.ts:74</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#DOCUMENT_COLLECTION" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DOCUMENT_<wbr/>COLLECTION</span></a><a href="#EDGE_COLLECTION" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EDGE_<wbr/>COLLECTION</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LogLevel | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/logs.html">logs</a></li><li><a href="logs.LogLevel.html">LogLevel</a></li></ul><h1>Enumeration LogLevel</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Numeric representation of the logging level of a log entry.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/logs.ts#L15">logs.ts:15</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="logs.LogLevel.html#DEBUG" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DEBUG</span></a> | ||
<a href="logs.LogLevel.html#ERROR" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>ERROR</span></a> | ||
<a href="logs.LogLevel.html#FATAL" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FATAL</span></a> | ||
<a href="logs.LogLevel.html#INFO" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>INFO</span></a> | ||
<a href="logs.LogLevel.html#WARNING" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>WARNING</span></a> | ||
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="DEBUG" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DEBUG</span><a href="#DEBUG" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">DEBUG</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">4</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/logs.ts#L20">logs.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ERROR" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ERROR</span><a href="#ERROR" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">ERROR</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/logs.ts#L17">logs.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="FATAL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>FATAL</span><a href="#FATAL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">FATAL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/logs.ts#L16">logs.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="INFO" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>INFO</span><a href="#INFO" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">INFO</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/logs.ts#L19">logs.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="WARNING" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>WARNING</span><a href="#WARNING" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">WARNING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/logs.ts#L18">logs.ts:18</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#DEBUG" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DEBUG</span></a><a href="#ERROR" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>ERROR</span></a><a href="#FATAL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FATAL</span></a><a href="#INFO" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>INFO</span></a><a href="#WARNING" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>WARNING</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isArangoAnalyzer | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/analyzers.html">analyzers</a></li><li><a href="analyzers.isArangoAnalyzer.html">isArangoAnalyzer</a></li></ul><h1>Function isArangoAnalyzer</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isArangoAnalyzer" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Arango<wbr/>Analyzer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">analyzer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">analyzer</span><span class="tsd-signature-keyword"> is </span><a href="../classes/analyzers.Analyzer.html" class="tsd-signature-type tsd-kind-class">Analyzer</a><a href="#isArangoAnalyzer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the given value represents an <a href="../classes/analyzers.Analyzer.html" class="tsd-kind-class">Analyzer</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">analyzer</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>A value that might be an Analyzer.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">analyzer</span><span class="tsd-signature-keyword"> is </span><a href="../classes/analyzers.Analyzer.html" class="tsd-signature-type tsd-kind-class">Analyzer</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/analyzers.ts#L837">analyzers.ts:837</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>aql | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/aql.html">aql</a></li><li><a href="aql.aql.html">aql</a></li></ul><h1>Function aql</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="aql" class="tsd-anchor"></a><span class="tsd-kind-call-signature">aql</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="aql.aql.html#aql.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">templateStrings</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/aql.AqlQuery.html" class="tsd-signature-type tsd-kind-interface">AqlQuery</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="aql.aql.html#aql.T">T</a><span class="tsd-signature-symbol">></span><a href="#aql" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Template string handler (template tag) for AQL queries.</p> | ||
<p>The <code>aql</code> tag can be used to write complex AQL queries as multi-line strings | ||
without having to worry about <code>bindVars</code> and the distinction between | ||
collections and regular parameters.</p> | ||
<p>Tagged template strings will return an <a href="../interfaces/aql.AqlQuery.html" class="tsd-kind-interface">AqlQuery</a> object with | ||
<code>query</code> and <code>bindVars</code> attributes reflecting any interpolated values.</p> | ||
<p>Any <a href="../interfaces/collections.ArangoCollection.html" class="tsd-kind-interface">collections.ArangoCollection</a> instance used in a query string will | ||
be recognized as a collection reference and generate an AQL collection bind | ||
parameter instead of a regular AQL value bind parameter.</p> | ||
<p><strong>Note</strong>: you should always use the <code>aql</code> template tag when writing | ||
dynamic AQL queries instead of using untagged (normal) template strings. | ||
Untagged template strings will inline any interpolated values and return | ||
a plain string as result. The <code>aql</code> template tag will only inline references | ||
to the interpolated values and produce an AQL query object containing both | ||
the query and the values. This prevents most injection attacks when using | ||
untrusted values in dynamic queries.</p> | ||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="aql.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">templateStrings</span>: <span class="tsd-signature-type">TemplateStringsArray</span></span></li><li><span><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <a href="../types/aql.AqlValue.html" class="tsd-signature-type tsd-kind-type-alias">AqlValue</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/aql.AqlQuery.html" class="tsd-signature-type tsd-kind-interface">AqlQuery</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="aql.aql.html#aql.T">T</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-js"><span class="hl-4">// Some user-supplied string that may be malicious</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">untrustedValue</span><span class="hl-1"> = </span><span class="hl-11">req</span><span class="hl-1">.</span><span class="hl-11">body</span><span class="hl-1">.</span><span class="hl-11">email</span><span class="hl-1">;</span><br/><br/><span class="hl-4">// Without aql tag: BAD! DO NOT DO THIS!</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">badQuery</span><span class="hl-1"> = </span><span class="hl-2">`</span><br/><span class="hl-2"> FOR user IN users</span><br/><span class="hl-2"> FILTER user.email == "</span><span class="hl-3">${</span><span class="hl-11">untrustedValue</span><span class="hl-3">}</span><span class="hl-2">"</span><br/><span class="hl-2"> RETURN user</span><br/><span class="hl-2">`</span><span class="hl-1">;</span><br/><span class="hl-4">// e.g. if untrustedValue is '" || user.admin == true || "':</span><br/><span class="hl-4">// Query:</span><br/><span class="hl-4">// FOR user IN users</span><br/><span class="hl-4">// FILTER user.email == "" || user.admin == true || ""</span><br/><span class="hl-4">// RETURN user</span><br/><br/><span class="hl-4">// With the aql tag: GOOD! MUCH SAFER!</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">betterQuery</span><span class="hl-1"> = </span><span class="hl-0">aql</span><span class="hl-2">`</span><br/><span class="hl-2"> FOR user IN users</span><br/><span class="hl-2"> FILTER user.email == </span><span class="hl-3">${</span><span class="hl-11">untrustedValue</span><span class="hl-3">}</span><br/><span class="hl-2"> RETURN user</span><br/><span class="hl-2">`</span><span class="hl-1">;</span><br/><span class="hl-4">// Query:</span><br/><span class="hl-4">// FOR user IN users</span><br/><span class="hl-4">// FILTER user.email == @value0</span><br/><span class="hl-4">// RETURN user</span><br/><span class="hl-4">// Bind parameters:</span><br/><span class="hl-4">// value0 -> untrustedValue</span> | ||
</code><button>Copy</button></pre> | ||
<h4>Example</h4><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">collection</span><span class="hl-1"> = </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">collection</span><span class="hl-1">(</span><span class="hl-2">"some-collection"</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">minValue</span><span class="hl-1"> = </span><span class="hl-13">23</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">result</span><span class="hl-1"> = </span><span class="hl-10">await</span><span class="hl-1"> </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">query</span><span class="hl-1">(</span><span class="hl-0">aql</span><span class="hl-2">`</span><br/><span class="hl-2"> FOR d IN </span><span class="hl-3">${</span><span class="hl-11">collection</span><span class="hl-3">}</span><br/><span class="hl-2"> FILTER d.num > </span><span class="hl-3">${</span><span class="hl-11">minValue</span><span class="hl-3">}</span><br/><span class="hl-2"> RETURN d</span><br/><span class="hl-2">`</span><span class="hl-1">);</span><br/><br/><span class="hl-4">// Equivalent raw query object</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">result2</span><span class="hl-1"> = </span><span class="hl-10">await</span><span class="hl-1"> </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">query</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-11">query:</span><span class="hl-1"> </span><span class="hl-2">`</span><br/><span class="hl-2"> FOR d IN @@collection</span><br/><span class="hl-2"> FILTER d.num > @minValue</span><br/><span class="hl-2"> RETURN d</span><br/><span class="hl-2"> `</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">bindVars:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">"@collection"</span><span class="hl-11">:</span><span class="hl-1"> </span><span class="hl-11">collection</span><span class="hl-1">.</span><span class="hl-11">name</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">minValue:</span><span class="hl-1"> </span><span class="hl-11">minValue</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span> | ||
</code><button>Copy</button></pre> | ||
<h4>Example</h4><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">collection</span><span class="hl-1"> = </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">collection</span><span class="hl-1">(</span><span class="hl-2">"some-collection"</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">color</span><span class="hl-1"> = </span><span class="hl-2">"green"</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">filter</span><span class="hl-1"> = </span><span class="hl-0">aql</span><span class="hl-2">`FILTER d.color == </span><span class="hl-3">${</span><span class="hl-11">color</span><span class="hl-3">}</span><span class="hl-2">'`</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">result</span><span class="hl-1"> = </span><span class="hl-10">await</span><span class="hl-1"> </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">query</span><span class="hl-1">(</span><span class="hl-0">aql</span><span class="hl-2">`</span><br/><span class="hl-2"> FOR d IN </span><span class="hl-3">${</span><span class="hl-11">collection</span><span class="hl-3">}</span><br/><span class="hl-2"> </span><span class="hl-3">${</span><span class="hl-11">filter</span><span class="hl-3">}</span><br/><span class="hl-2"> RETURN d</span><br/><span class="hl-2">`</span><span class="hl-1">);</span> | ||
</code><button>Copy</button></pre> | ||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/aql.ts#L204">aql.ts:204</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isAqlLiteral | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/aql.html">aql</a></li><li><a href="aql.isAqlLiteral.html">isAqlLiteral</a></li></ul><h1>Function isAqlLiteral</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isAqlLiteral" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Aql<wbr/>Literal</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">literal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">literal</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/aql.AqlLiteral.html" class="tsd-signature-type tsd-kind-interface">AqlLiteral</a><a href="#isAqlLiteral" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the given value is an <a href="../interfaces/aql.AqlLiteral.html" class="tsd-kind-interface">AqlLiteral</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">literal</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>A value that might be an <code>AqlLiteral</code>.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">literal</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/aql.AqlLiteral.html" class="tsd-signature-type tsd-kind-interface">AqlLiteral</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/aql.ts#L111">aql.ts:111</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isAqlQuery | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/aql.html">aql</a></li><li><a href="aql.isAqlQuery.html">isAqlQuery</a></li></ul><h1>Function isAqlQuery</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isAqlQuery" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Aql<wbr/>Query</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/aql.AqlQuery.html" class="tsd-signature-type tsd-kind-interface">AqlQuery</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#isAqlQuery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the given value is an <a href="../interfaces/aql.AqlQuery.html" class="tsd-kind-interface">AqlQuery</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>A value that might be an <code>AqlQuery</code>.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">query</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/aql.AqlQuery.html" class="tsd-signature-type tsd-kind-interface">AqlQuery</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/aql.ts#L91">aql.ts:91</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>join | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/aql.html">aql</a></li><li><a href="aql.join.html">join</a></li></ul><h1>Function join</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="join" class="tsd-anchor"></a><span class="tsd-kind-call-signature">join</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">values</span>, <span class="tsd-kind-parameter">sep</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/aql.AqlQuery.html" class="tsd-signature-type tsd-kind-interface">AqlQuery</a><a href="#join" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Constructs <a href="../interfaces/aql.AqlQuery.html" class="tsd-kind-interface">AqlQuery</a> objects from an array of arbitrary values.</p> | ||
<p><strong>Note</strong>: Nesting <code>aql</code> template strings is a much safer alternative | ||
for most use cases. This low-level helper function only exists to | ||
complement the <code>aql</code> tag when constructing complex queries from dynamic | ||
arrays of query fragments.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">values</span>: <a href="../types/aql.AqlValue.html" class="tsd-signature-type tsd-kind-type-alias">AqlValue</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Array of values to join. These values will behave exactly | ||
like values interpolated in an <code>aql</code> template string.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">sep</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = " "</span></span><div class="tsd-comment tsd-typography"><p>Seperator to insert between values. This value will behave | ||
exactly like a value passed to <a href="aql.literal.html" class="tsd-kind-function">literal</a>, i.e. it will be | ||
inlined as-is, rather than being converted into a bind parameter.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/aql.AqlQuery.html" class="tsd-signature-type tsd-kind-interface">AqlQuery</a></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">users</span><span class="hl-1"> = </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">collection</span><span class="hl-1">(</span><span class="hl-2">"users"</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">filters</span><span class="hl-1"> = [];</span><br/><span class="hl-10">if</span><span class="hl-1"> (</span><span class="hl-11">adminsOnly</span><span class="hl-1">) </span><span class="hl-11">filters</span><span class="hl-1">.</span><span class="hl-0">push</span><span class="hl-1">(</span><span class="hl-0">aql</span><span class="hl-2">`FILTER user.admin`</span><span class="hl-1">);</span><br/><span class="hl-10">if</span><span class="hl-1"> (</span><span class="hl-11">activeOnly</span><span class="hl-1">) </span><span class="hl-11">filters</span><span class="hl-1">.</span><span class="hl-0">push</span><span class="hl-1">(</span><span class="hl-0">aql</span><span class="hl-2">`FILTER user.active`</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">result</span><span class="hl-1"> = </span><span class="hl-10">await</span><span class="hl-1"> </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">query</span><span class="hl-1">(</span><span class="hl-0">aql</span><span class="hl-2">`</span><br/><span class="hl-2"> FOR user IN </span><span class="hl-3">${</span><span class="hl-11">users</span><span class="hl-3">}</span><br/><span class="hl-2"> </span><span class="hl-3">${</span><span class="hl-0">join</span><span class="hl-7">(</span><span class="hl-11">filters</span><span class="hl-7">)</span><span class="hl-3">}</span><br/><span class="hl-2"> RETURN user</span><br/><span class="hl-2">`</span><span class="hl-1">);</span> | ||
</code><button>Copy</button></pre> | ||
<h4>Example</h4><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">users</span><span class="hl-1"> = </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">collection</span><span class="hl-1">(</span><span class="hl-2">"users"</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">keys</span><span class="hl-1"> = [</span><span class="hl-2">"jreyes"</span><span class="hl-1">, </span><span class="hl-2">"ghermann"</span><span class="hl-1">];</span><br/><br/><span class="hl-4">// BAD! NEEDLESSLY COMPLEX!</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">docs</span><span class="hl-1"> = </span><span class="hl-11">keys</span><span class="hl-1">.</span><span class="hl-0">map</span><span class="hl-1">(</span><span class="hl-11">key</span><span class="hl-1"> </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">aql</span><span class="hl-2">`DOCUMENT(</span><span class="hl-3">${</span><span class="hl-11">users</span><span class="hl-3">}</span><span class="hl-2">, </span><span class="hl-3">${</span><span class="hl-11">key</span><span class="hl-3">}</span><span class="hl-2">`</span><span class="hl-1">));</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">result</span><span class="hl-1"> = </span><span class="hl-10">await</span><span class="hl-1"> </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">query</span><span class="hl-1">(</span><span class="hl-0">aql</span><span class="hl-2">`</span><br/><span class="hl-2"> FOR user IN [</span><br/><span class="hl-2"> </span><span class="hl-3">${</span><span class="hl-0">join</span><span class="hl-7">(</span><span class="hl-11">docs</span><span class="hl-7">, </span><span class="hl-2">", "</span><span class="hl-7">)</span><span class="hl-3">}</span><br/><span class="hl-2"> ]</span><br/><span class="hl-2"> RETURN user</span><br/><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-4">// Query:</span><br/><span class="hl-4">// FOR user IN [</span><br/><span class="hl-4">// DOCUMENT(@@value0, @value1), DOCUMENT(@@value0, @value2)</span><br/><span class="hl-4">// ]</span><br/><span class="hl-4">// RETURN user</span><br/><span class="hl-4">// Bind parameters:</span><br/><span class="hl-4">// @value0 -> "users"</span><br/><span class="hl-4">// value1 -> "jreyes"</span><br/><span class="hl-4">// value2 -> "ghermann"</span><br/><br/><span class="hl-4">// GOOD! MUCH SIMPLER!</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">result</span><span class="hl-1"> = </span><span class="hl-10">await</span><span class="hl-1"> </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">query</span><span class="hl-1">(</span><span class="hl-0">aql</span><span class="hl-2">`</span><br/><span class="hl-2"> FOR key IN </span><span class="hl-3">${</span><span class="hl-11">keys</span><span class="hl-3">}</span><br/><span class="hl-2"> LET user = DOCUMENT(</span><span class="hl-3">${</span><span class="hl-11">users</span><span class="hl-3">}</span><span class="hl-2">, key)</span><br/><span class="hl-2"> RETURN user</span><br/><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-4">// Query:</span><br/><span class="hl-4">// FOR user IN @value0</span><br/><span class="hl-4">// LET user = DOCUMENT(@@value1, key)</span><br/><span class="hl-4">// RETURN user</span><br/><span class="hl-4">// Bind parameters:</span><br/><span class="hl-4">// value0 -> ["jreyes", "ghermann"]</span><br/><span class="hl-4">// @value1 -> "users"</span> | ||
</code><button>Copy</button></pre> | ||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/aql.ts#L400">aql.ts:400</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>literal | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/aql.html">aql</a></li><li><a href="aql.literal.html">literal</a></li></ul><h1>Function literal</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="literal" class="tsd-anchor"></a><span class="tsd-kind-call-signature">literal</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/aql.AqlLiteral.html" class="tsd-signature-type tsd-kind-interface">AqlLiteral</a><a href="#literal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Marks an arbitrary scalar value (i.e. a string, number or boolean) as | ||
safe for being inlined directly into AQL queries when used in an <code>aql</code> | ||
template string, rather than being converted into a bind parameter.</p> | ||
<p><strong>Note</strong>: Nesting <code>aql</code> template strings is a much safer alternative for | ||
most use cases. This low-level helper function only exists to help with | ||
rare edge cases where a trusted AQL query fragment must be read from a | ||
string (e.g. when reading query fragments from JSON) and should only be | ||
used as a last resort.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/aql.AqlLiteral.html" class="tsd-signature-type tsd-kind-interface">AqlLiteral</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/aql.AqlLiteral.html" class="tsd-signature-type tsd-kind-interface">AqlLiteral</a></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-js"><span class="hl-4">// BAD! DO NOT DO THIS!</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">sortDirection</span><span class="hl-1"> = </span><span class="hl-0">literal</span><span class="hl-1">(</span><span class="hl-2">'ASC'</span><span class="hl-1">);</span><br/><br/><span class="hl-4">// GOOD! DO THIS INSTEAD!</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">sortDirection</span><span class="hl-1"> = </span><span class="hl-0">aql</span><span class="hl-2">`ASC`</span><span class="hl-1">;</span> | ||
</code><button>Copy</button></pre> | ||
<h4>Example</h4><pre><code class="language-js"><span class="hl-4">// BAD! DO NOT DO THIS!</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">filterColor</span><span class="hl-1"> = </span><span class="hl-0">literal</span><span class="hl-1">(</span><span class="hl-2">'FILTER d.color == "green"'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">result</span><span class="hl-1"> = </span><span class="hl-10">await</span><span class="hl-1"> </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">query</span><span class="hl-1">(</span><span class="hl-0">aql</span><span class="hl-2">`</span><br/><span class="hl-2"> FOR d IN some-collection</span><br/><span class="hl-2"> </span><span class="hl-3">${</span><span class="hl-11">filterColor</span><span class="hl-3">}</span><br/><span class="hl-2"> RETURN d</span><br/><span class="hl-2">`</span><span class="hl-1">);</span><br/><br/><span class="hl-4">// GOOD! DO THIS INSTEAD!</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">color</span><span class="hl-1"> = </span><span class="hl-2">"green"</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">filterColor</span><span class="hl-1"> = </span><span class="hl-0">aql</span><span class="hl-2">`FILTER d.color === </span><span class="hl-3">${</span><span class="hl-11">color</span><span class="hl-3">}</span><span class="hl-2">`</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">result</span><span class="hl-1"> = </span><span class="hl-10">await</span><span class="hl-1"> </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">query</span><span class="hl-1">(</span><span class="hl-0">aql</span><span class="hl-2">`</span><br/><span class="hl-2"> FOR d IN some-collection</span><br/><span class="hl-2"> </span><span class="hl-3">${</span><span class="hl-11">filterColor</span><span class="hl-3">}</span><br/><span class="hl-2"> RETURN d</span><br/><span class="hl-2">`</span><span class="hl-1">);</span> | ||
</code><button>Copy</button></pre> | ||
<h4>Example</h4><pre><code class="language-js"><span class="hl-4">// WARNING: We explicitly trust the environment variable to be safe!</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">filter</span><span class="hl-1"> = </span><span class="hl-0">literal</span><span class="hl-1">(</span><span class="hl-11">process</span><span class="hl-1">.</span><span class="hl-11">env</span><span class="hl-1">.</span><span class="hl-12">FILTER_STATEMENT</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">users</span><span class="hl-1"> = </span><span class="hl-10">await</span><span class="hl-1"> </span><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">query</span><span class="hl-1">(</span><span class="hl-0">aql</span><span class="hl-2">`</span><br/><span class="hl-2"> FOR user IN users</span><br/><span class="hl-2"> </span><span class="hl-3">${</span><span class="hl-11">filter</span><span class="hl-3">}</span><br/><span class="hl-2"> RETURN user</span><br/><span class="hl-2">`</span><span class="hl-1">);</span> | ||
</code><button>Copy</button></pre> | ||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/aql.ts#L319">aql.ts:319</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>collectionToString | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/collections.html">collections</a></li><li><a href="collections.collectionToString.html">collectionToString</a></li></ul><h1>Function collectionToString</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="collectionToString" class="tsd-anchor"></a><span class="tsd-kind-call-signature">collection<wbr/>To<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">collection</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#collectionToString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Coerces the given collection name or <a href="../interfaces/collections.ArangoCollection.html" class="tsd-kind-interface">ArangoCollection</a> object to | ||
a string representing the collection name.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collection</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/collections.ArangoCollection.html" class="tsd-signature-type tsd-kind-interface">ArangoCollection</a></span><div class="tsd-comment tsd-typography"><p>Collection name or <a href="../interfaces/collections.ArangoCollection.html" class="tsd-kind-interface">ArangoCollection</a> object.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L40">collections.ts:40</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isArangoCollection | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/collections.html">collections</a></li><li><a href="collections.isArangoCollection.html">isArangoCollection</a></li></ul><h1>Function isArangoCollection</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isArangoCollection" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Arango<wbr/>Collection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">collection</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">collection</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/collections.ArangoCollection.html" class="tsd-signature-type tsd-kind-interface">ArangoCollection</a><a href="#isArangoCollection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the given value represents an <a href="../interfaces/collections.ArangoCollection.html" class="tsd-kind-interface">ArangoCollection</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collection</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>A value that might be a collection.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">collection</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/collections.ArangoCollection.html" class="tsd-signature-type tsd-kind-interface">ArangoCollection</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/collections.ts#L28">collections.ts:28</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isBearerAuth | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/configuration.html">configuration</a></li><li><a href="configuration.isBearerAuth.html">isBearerAuth</a></li></ul><h1>Function isBearerAuth</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isBearerAuth" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Bearer<wbr/>Auth</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">auth</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">auth</span><span class="tsd-signature-keyword"> is </span><a href="../types/configuration.BearerAuthCredentials.html" class="tsd-signature-type tsd-kind-type-alias">BearerAuthCredentials</a><a href="#isBearerAuth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Determines if the given credentials are for Bearer token authentication.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">auth</span>: <a href="../types/configuration.BasicAuthCredentials.html" class="tsd-signature-type tsd-kind-type-alias">BasicAuthCredentials</a><span class="tsd-signature-symbol"> | </span><a href="../types/configuration.BearerAuthCredentials.html" class="tsd-signature-type tsd-kind-type-alias">BearerAuthCredentials</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">auth</span><span class="tsd-signature-keyword"> is </span><a href="../types/configuration.BearerAuthCredentials.html" class="tsd-signature-type tsd-kind-type-alias">BearerAuthCredentials</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/configuration.ts#L57">configuration.ts:57</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>getStatusMessage | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/connection.html">connection</a></li><li><a href="connection.getStatusMessage.html">getStatusMessage</a></li></ul><h1>Function getStatusMessage</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStatusMessage" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Status<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getStatusMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the status message for the given response's status code or the | ||
status text of the response.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">response</span>: <a href="../interfaces/connection.ProcessedResponse.html" class="tsd-signature-type tsd-kind-interface">ProcessedResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/connection.ts#L312">connection.ts:312</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isArangoErrorResponse | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/connection.html">connection</a></li><li><a href="connection.isArangoErrorResponse.html">isArangoErrorResponse</a></li></ul><h1>Function isArangoErrorResponse</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isArangoErrorResponse" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Arango<wbr/>Error<wbr/>Response</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">body</span><span class="tsd-signature-keyword"> is </span><a href="../types/connection.ArangoErrorResponse.html" class="tsd-signature-type tsd-kind-type-alias">ArangoErrorResponse</a><a href="#isArangoErrorResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the given value represents an ArangoDB error response.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <span class="tsd-signature-type">unknown</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">body</span><span class="tsd-signature-keyword"> is </span><a href="../types/connection.ArangoErrorResponse.html" class="tsd-signature-type tsd-kind-type-alias">ArangoErrorResponse</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/connection.ts#L342">connection.ts:342</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isArangoDatabase | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/databases.html">databases</a></li><li><a href="databases.isArangoDatabase.html">isArangoDatabase</a></li></ul><h1>Function isArangoDatabase</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isArangoDatabase" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Arango<wbr/>Database</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">database</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">database</span><span class="tsd-signature-keyword"> is </span><a href="../classes/databases.Database.html" class="tsd-signature-type tsd-kind-class">Database</a><a href="#isArangoDatabase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the given value represents a <a href="../classes/databases.Database.html" class="tsd-kind-class">Database</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">database</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>A value that might be a database.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">database</span><span class="tsd-signature-keyword"> is </span><a href="../classes/databases.Database.html" class="tsd-signature-type tsd-kind-class">Database</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/databases.ts#L131">databases.ts:131</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isArangoError | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/errors.html">errors</a></li><li><a href="errors.isArangoError.html">isArangoError</a></li></ul><h1>Function isArangoError</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isArangoError" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Arango<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-keyword"> is </span><a href="../classes/errors.ArangoError.html" class="tsd-signature-type tsd-kind-class">ArangoError</a><a href="#isArangoError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the given value represents an <a href="../classes/errors.ArangoError.html" class="tsd-kind-class">ArangoError</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>A value that might be an <code>ArangoError</code>.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">error</span><span class="tsd-signature-keyword"> is </span><a href="../classes/errors.ArangoError.html" class="tsd-signature-type tsd-kind-class">ArangoError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/errors.ts#L20">errors.ts:20</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isNetworkError | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/errors.html">errors</a></li><li><a href="errors.isNetworkError.html">isNetworkError</a></li></ul><h1>Function isNetworkError</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isNetworkError" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Network<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-keyword"> is </span><a href="../classes/errors.NetworkError.html" class="tsd-signature-type tsd-kind-class">NetworkError</a><a href="#isNetworkError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the given value represents a <a href="../classes/errors.NetworkError.html" class="tsd-kind-class">NetworkError</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>A value that might be a <code>NetworkError</code>.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">error</span><span class="tsd-signature-keyword"> is </span><a href="../classes/errors.NetworkError.html" class="tsd-signature-type tsd-kind-class">NetworkError</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/errors.ts#L29">errors.ts:29</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isArangoGraph | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/graphs.html">graphs</a></li><li><a href="graphs.isArangoGraph.html">isArangoGraph</a></li></ul><h1>Function isArangoGraph</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isArangoGraph" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Arango<wbr/>Graph</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">graph</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">graph</span><span class="tsd-signature-keyword"> is </span><a href="../classes/graphs.Graph.html" class="tsd-signature-type tsd-kind-class">Graph</a><a href="#isArangoGraph" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the given value represents a <a href="../classes/graphs.Graph.html" class="tsd-kind-class">Graph</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">graph</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>A value that might be a Graph.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">graph</span><span class="tsd-signature-keyword"> is </span><a href="../classes/graphs.Graph.html" class="tsd-signature-type tsd-kind-class">Graph</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/graphs.ts#L1276">graphs.ts:1276</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>arangojs | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.arangojs.html">arangojs</a></li></ul><h1>Function arangojs</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="arangojs" class="tsd-anchor"></a><span class="tsd-kind-call-signature">arangojs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/databases.Database.html" class="tsd-signature-type tsd-kind-class">Database</a><a href="#arangojs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new <code>Database</code> instance with its own connection pool.</p> | ||
<p>This is a wrapper function for the <a href="../classes/databases.Database.html" class="tsd-kind-class">:constructor</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">config</span>: <a href="../types/configuration.ConfigOptions.html" class="tsd-signature-type tsd-kind-type-alias">ConfigOptions</a></span><div class="tsd-comment tsd-typography"><p>An object with configuration options.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/databases.Database.html" class="tsd-signature-type tsd-kind-class">Database</a></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">db</span><span class="hl-1"> = </span><span class="hl-0">arangojs</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-11">url:</span><span class="hl-1"> </span><span class="hl-2">"http://127.0.0.1:8529"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">databaseName:</span><span class="hl-1"> </span><span class="hl-2">"myDatabase"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">auth:</span><span class="hl-1"> { </span><span class="hl-11">username:</span><span class="hl-1"> </span><span class="hl-2">"admin"</span><span class="hl-1">, </span><span class="hl-11">password:</span><span class="hl-1"> </span><span class="hl-2">"hunter2"</span><span class="hl-1"> },</span><br/><span class="hl-1">});</span> | ||
</code><button>Copy</button></pre> | ||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/index.ts#L37">index.ts:37</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="arangojs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">arangojs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/databases.Database.html" class="tsd-signature-type tsd-kind-class">Database</a><a href="#arangojs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new <code>Database</code> instance with its own connection pool.</p> | ||
<p>This is a wrapper function for the <a href="../classes/databases.Database.html" class="tsd-kind-class">:constructor</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Base URL of the ArangoDB server or list of server URLs. | ||
Equivalent to the <code>url</code> option in <a href="../types/configuration.ConfigOptions.html" class="tsd-kind-type-alias">configuration.ConfigOptions</a>.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/databases.Database.html" class="tsd-signature-type tsd-kind-class">Database</a></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">db</span><span class="hl-1"> = </span><span class="hl-0">arangojs</span><span class="hl-1">(</span><span class="hl-2">"http://127.0.0.1:8529"</span><span class="hl-1">, </span><span class="hl-2">"myDatabase"</span><span class="hl-1">);</span><br/><span class="hl-11">db</span><span class="hl-1">.</span><span class="hl-0">useBasicAuth</span><span class="hl-1">(</span><span class="hl-2">"admin"</span><span class="hl-1">, </span><span class="hl-2">"hunter2"</span><span class="hl-1">);</span> | ||
</code><button>Copy</button></pre> | ||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/index.ts#L54">index.ts:54</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isArangoTransaction | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/transactions.html">transactions</a></li><li><a href="transactions.isArangoTransaction.html">isArangoTransaction</a></li></ul><h1>Function isArangoTransaction</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isArangoTransaction" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Arango<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transaction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">transaction</span><span class="tsd-signature-keyword"> is </span><a href="../classes/transactions.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a><a href="#isArangoTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the given value represents a <a href="../classes/transactions.Transaction.html" class="tsd-kind-class">Transaction</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">transaction</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>A value that might be a transaction.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">transaction</span><span class="tsd-signature-keyword"> is </span><a href="../classes/transactions.Transaction.html" class="tsd-signature-type tsd-kind-class">Transaction</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/transactions.ts#L207">transactions.ts:207</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isArangoView | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/views.html">views</a></li><li><a href="views.isArangoView.html">isArangoView</a></li></ul><h1>Function isArangoView</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isArangoView" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Arango<wbr/>View</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">view</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">view</span><span class="tsd-signature-keyword"> is </span><a href="../classes/views.View.html" class="tsd-signature-type tsd-kind-class">View</a><a href="#isArangoView" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the given value represents a <a href="../classes/views.View.html" class="tsd-kind-class">View</a>.</p> | ||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">view</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>A value that might be a View.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">view</span><span class="tsd-signature-keyword"> is </span><a href="../classes/views.View.html" class="tsd-signature-type tsd-kind-class">View</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/views.ts#L500">views.ts:500</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="assets/highlight.css?cache=1736762803515"/><script defer src="assets/main.js?cache=1736762803515"></script><script async src="assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>arangojs - v10.1.1</h2></div><h2>Class Hierarchy</h2><ul class="tsd-full-hierarchy"><li><a id="aql.AqlQuery" class="tsd-anchor"></a><a href="interfaces/aql.AqlQuery.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>AqlQuery</a><ul><li><a id="aql.GeneratedAqlQuery" class="tsd-anchor"></a><a href="interfaces/aql.GeneratedAqlQuery.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>GeneratedAqlQuery</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="collections.ArangoCollection" class="tsd-anchor"></a><a href="interfaces/collections.ArangoCollection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ArangoCollection</a><ul><li><a id="graphs.GraphEdgeCollection" class="tsd-anchor"></a><a href="classes/graphs.GraphEdgeCollection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>GraphEdgeCollection</a><ul></ul></li><li><a id="graphs.GraphVertexCollection" class="tsd-anchor"></a><a href="classes/graphs.GraphVertexCollection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>GraphVertexCollection</a><ul></ul></li><li><a id="collections.DocumentCollection" class="tsd-anchor"></a><a href="interfaces/collections.DocumentCollection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>DocumentCollection</a><ul><li><a id="collections.EdgeCollection" class="tsd-anchor"></a><a href="interfaces/collections.EdgeCollection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>EdgeCollection</a><ul></ul></li></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="errors.NetworkError" class="tsd-anchor"></a><a href="classes/errors.NetworkError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>NetworkError</a><ul><li><a id="errors.ResponseTimeoutError" class="tsd-anchor"></a><a href="classes/errors.ResponseTimeoutError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>ResponseTimeoutError</a><ul></ul></li><li><a id="errors.RequestAbortedError" class="tsd-anchor"></a><a href="classes/errors.RequestAbortedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>RequestAbortedError</a><ul></ul></li><li><a id="errors.FetchFailedError" class="tsd-anchor"></a><a href="classes/errors.FetchFailedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>FetchFailedError</a><ul></ul></li><li><a id="errors.HttpError" class="tsd-anchor"></a><a href="classes/errors.HttpError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>HttpError</a><ul></ul></li></ul></li></ul></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueueTimeMetrics | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/administration.html">administration</a></li><li><a href="administration.QueueTimeMetrics.html">QueueTimeMetrics</a></li></ul><h1>Interface QueueTimeMetrics</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An object providing methods for accessing queue time metrics of the most | ||
recently received server responses if the server supports this feature.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">QueueTimeMetrics</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="administration.QueueTimeMetrics.html#getAvg.getAvg-1">getAvg</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="administration.QueueTimeMetrics.html#getLatest.getLatest-1">getLatest</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="administration.QueueTimeMetrics.html#getValues.getValues-1">getValues</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/administration.ts#L410">administration.ts:410</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="administration.QueueTimeMetrics.html#getAvg" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Avg</span></a> | ||
<a href="administration.QueueTimeMetrics.html#getLatest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Latest</span></a> | ||
<a href="administration.QueueTimeMetrics.html#getValues" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Values</span></a> | ||
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getAvg" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Avg</span><a href="#getAvg" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAvg.getAvg-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Avg</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getAvg.getAvg-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the average queue time of the most recently received responses | ||
in seconds.</p> | ||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/administration.ts#L425">administration.ts:425</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getLatest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Latest</span><a href="#getLatest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getLatest.getLatest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Latest</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><a href="#getLatest.getLatest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the queue time of the most recently received response in seconds.</p> | ||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/administration.ts#L414">administration.ts:414</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Values</span><a href="#getValues" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getValues.getValues-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Values</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span><a href="#getValues.getValues-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a list of the most recently received queue time values as tuples | ||
of the timestamp of the response being processed in milliseconds and the | ||
queue time in seconds.</p> | ||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/administration.ts#L420">administration.ts:420</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#getAvg" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Avg</span></a><a href="#getLatest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Latest</span></a><a href="#getValues" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Values</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AqlLiteral | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/aql.html">aql</a></li><li><a href="aql.AqlLiteral.html">AqlLiteral</a></li></ul><h1>Interface AqlLiteral</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An object representing a trusted AQL literal that will be inlined directly | ||
when used in an AQL template or passed to AQL helper functions.</p> | ||
<p>Arbitrary values can be converted to trusted AQL literals by passing them | ||
to the <a href="../functions/aql.literal.html" class="tsd-kind-function">literal</a> helper function.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AqlLiteral</span> <span class="tsd-signature-symbol">{}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/aql.ts#L58">aql.ts:58</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AqlQuery | arangojs - v10.1.1</title><meta name="description" content="Documentation for arangojs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1736762803515"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762803515"/><script defer src="../assets/main.js?cache=1736762803515"></script><script async src="../assets/icons.js?cache=1736762803515" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762803515" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762803515" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">arangojs - v10.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">arangojs</a></li><li><a href="../modules/aql.html">aql</a></li><li><a href="aql.AqlQuery.html">AqlQuery</a></li></ul><h1>Interface AqlQuery<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Generic AQL query object consisting of an AQL query string and its bind | ||
parameters.</p> | ||
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AqlQuery</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="aql.AqlQuery.html#T">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="aql.AqlQuery.html#_type_">[type]</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="aql.AqlQuery.html#bindVars">bindVars</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="aql.AqlQuery.html#query">query</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">any</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#aql.AqlQuery">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">AqlQuery</span><ul class="tsd-hierarchy"><li><a href="aql.GeneratedAqlQuery.html" class="tsd-signature-type tsd-kind-interface">GeneratedAqlQuery</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/aql.ts#L24">aql.ts:24</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="aql.AqlQuery.html#_type_" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>[type]?</span></a> | ||
<a href="aql.AqlQuery.html#bindVars" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bind<wbr/>Vars</span></a> | ||
<a href="aql.AqlQuery.html#query" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>query</span></a> | ||
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="_type_" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>[type]</span><a href="#_type_" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">[type]</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/aql.ts#L25">aql.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="bindVars" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bind<wbr/>Vars</span><a href="#bindVars" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bind<wbr/>Vars</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>An object mapping AQL bind parameter names to their respective values.</p> | ||
<p>Names of parameters representing collections are prefixed with an | ||
at-symbol.</p> | ||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/aql.ts#L36">aql.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="query" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>query</span><a href="#query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>An AQL query string.</p> | ||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/arangodb/arangojs/blob/v10.1.1/src/aql.ts#L29">aql.ts:29</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#_type_" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>[type]</span></a><a href="#bindVars" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bind<wbr/>Vars</span></a><a href="#query" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>query</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>arangojs - v10.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |