Skip to content

Commit

Permalink
Update devel docs via c13259a
Browse files Browse the repository at this point in the history
  • Loading branch information
@pluma4345
pluma4345 committed Jan 13, 2025
1 parent 3bcc23b commit 48e3bea
Show file tree
Hide file tree
Showing 331 changed files with 331 additions and 331 deletions.
2 changes: 1 addition & 1 deletion devel/classes/analyzers.Analyzer.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Analyzer | arangojs</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=1736762823025"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762823025"/><script defer src="../assets/main.js?cache=1736762823025"></script><script async src="../assets/icons.js?cache=1736762823025" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762823025" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762823025" 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</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.Analyzer.html">Analyzer</a></li></ul><h1>Class Analyzer</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an Analyzer in a <a href="databases.Database.html" class="tsd-kind-class">databases.Database</a>.</p>
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Analyzer | arangojs</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=1736762909846"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762909846"/><script defer src="../assets/main.js?cache=1736762909846"></script><script async src="../assets/icons.js?cache=1736762909846" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762909846" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762909846" 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</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.Analyzer.html">Analyzer</a></li></ul><h1>Class Analyzer</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an Analyzer in a <a href="databases.Database.html" class="tsd-kind-class">databases.Database</a>.</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/c13259a05ee55554136b905db3375d223cbbd365/src/analyzers.ts#L844">analyzers.ts:844</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">Accessors</h3><div class="tsd-index-list"><a href="analyzers.Analyzer.html#database" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>database</span></a>
<a href="analyzers.Analyzer.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>name</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="analyzers.Analyzer.html#create" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a>
Expand Down
2 changes: 1 addition & 1 deletion devel/classes/cursors.BatchCursor.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchCursor | arangojs</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=1736762823025"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762823025"/><script defer src="../assets/main.js?cache=1736762823025"></script><script async src="../assets/icons.js?cache=1736762823025" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762823025" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762823025" 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</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/cursors.html">cursors</a></li><li><a href="cursors.BatchCursor.html">BatchCursor</a></li></ul><h1>Class BatchCursor&lt;ItemType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The <code>BatchCursor</code> provides a batch-wise API to an <a href="cursors.Cursor.html" class="tsd-kind-class">Cursor</a>.</p>
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BatchCursor | arangojs</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=1736762909846"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762909846"/><script defer src="../assets/main.js?cache=1736762909846"></script><script async src="../assets/icons.js?cache=1736762909846" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762909846" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762909846" 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</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/cursors.html">cursors</a></li><li><a href="cursors.BatchCursor.html">BatchCursor</a></li></ul><h1>Class BatchCursor&lt;ItemType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The <code>BatchCursor</code> provides a batch-wise API to an <a href="cursors.Cursor.html" class="tsd-kind-class">Cursor</a>.</p>
<p>When using TypeScript, cursors can be cast to a specific item type in order
to increase type safety.</p>
</div><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><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-3">new</span><span class="hl-1"> </span><span class="hl-0">Database</span><span class="hl-1">();</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">query</span><span class="hl-1"> = </span><span class="hl-0">aql</span><span class="hl-2">`FOR x IN 1..5 RETURN x`</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">cursor</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-11">query</span><span class="hl-1">) </span><span class="hl-10">as</span><span class="hl-1"> </span><span class="hl-14">Cursor</span><span class="hl-1">&lt;</span><span class="hl-14">number</span><span class="hl-1">&gt;;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-12">batches</span><span class="hl-1"> = </span><span class="hl-11">cursor</span><span class="hl-1">.</span><span class="hl-11">batches</span><span class="hl-1">;</span>
Expand Down
2 changes: 1 addition & 1 deletion devel/classes/cursors.Cursor.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Cursor | arangojs</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=1736762823025"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762823025"/><script defer src="../assets/main.js?cache=1736762823025"></script><script async src="../assets/icons.js?cache=1736762823025" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762823025" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762823025" 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</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/cursors.html">cursors</a></li><li><a href="cursors.Cursor.html">Cursor</a></li></ul><h1>Class Cursor&lt;ItemType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The <code>Cursor</code> type represents a cursor returned from a
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Cursor | arangojs</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=1736762909846"/><link rel="stylesheet" href="../assets/highlight.css?cache=1736762909846"/><script defer src="../assets/main.js?cache=1736762909846"></script><script async src="../assets/icons.js?cache=1736762909846" id="tsd-icons-script"></script><script async src="../assets/search.js?cache=1736762909846" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1736762909846" 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</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/cursors.html">cursors</a></li><li><a href="cursors.Cursor.html">Cursor</a></li></ul><h1>Class Cursor&lt;ItemType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The <code>Cursor</code> type represents a cursor returned from a
<a href="databases.Database.html#query" class="tsd-kind-method">databases.Database#query</a>.</p>
<p>When using TypeScript, cursors can be cast to a specific item type in order
to increase type safety.</p>
Expand Down
Loading

0 comments on commit 48e3bea

Please sign in to comment.