redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-13 10:02:24 +03:00
Code Activity

Updates

Browse Source
This commit is contained in:
documentation-bot
2023-09-19 20:22:59 +00:00
parent 26311eb750
commit 0a5fcc658b
2100 changed files with 3183 additions and 2900 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
documentation/graph/classes/graph.default.html
View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">default</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L140">graph.ts:140</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L140">graph.ts:140</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">
@@ -69,29 +69,29 @@
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="graph.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L145">graph.ts:145</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L145">graph.ts:145</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_client" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#client</span><a href="#_client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#client</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">GraphClientType</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L141">graph.ts:141</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L141">graph.ts:141</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_metadata" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>#metadata</span><a href="#_metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#metadata</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">GraphMetadata</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L143">graph.ts:143</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L143">graph.ts:143</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#name</span><a href="#_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L142">graph.ts:142</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L142">graph.ts:142</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_setMetadataPromise" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>#set<wbr/>Metadata<wbr/>Promise</span><a href="#_setMetadataPromise" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#set<wbr/>Metadata<wbr/>Promise</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">GraphMetadata</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L181">graph.ts:181</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L181">graph.ts:181</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_cleanMetadataArray" class="tsd-anchor"></a>
@@ -106,7 +106,7 @@
<h5><span class="tsd-kind-parameter">arr</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L206">graph.ts:206</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L206">graph.ts:206</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_getMetadata" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#get<wbr/>Metadata</span><a href="#_getMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
@@ -126,7 +126,7 @@
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">GraphMetadata</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">T</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-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">GraphMetadata</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">T</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-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L210">graph.ts:210</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L210">graph.ts:210</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_getMetadataAsync" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#get<wbr/>Metadata<wbr/>Async</span><a href="#_getMetadataAsync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
@@ -146,7 +146,7 @@
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">GraphMetadata</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">T</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-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L218">graph.ts:218</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L218">graph.ts:218</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_parseEdge" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#parse<wbr/>Edge</span><a href="#_parseEdge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
@@ -161,7 +161,7 @@
<h5><span class="tsd-kind-parameter">promises</span>: <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">GraphEdge</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L297">graph.ts:297</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L297">graph.ts:297</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_parseNode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#parse<wbr/>Node</span><a href="#_parseNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
@@ -176,7 +176,7 @@
<h5><span class="tsd-kind-parameter">promises</span>: <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">GraphNode</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L323">graph.ts:323</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L323">graph.ts:323</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_parseProperties" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#parse<wbr/>Properties</span><a href="#_parseProperties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
@@ -191,7 +191,7 @@
<h5><span class="tsd-kind-parameter">promises</span>: <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">GraphEntityProperties</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L345">graph.ts:345</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L345">graph.ts:345</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_parseReply" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#parse<wbr/>Reply</span><a href="#_parseReply" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
@@ -209,7 +209,7 @@
<h5><span class="tsd-kind-parameter">reply</span>: <a href="../types/commands_QUERY.QueryReply.html" class="tsd-signature-type tsd-kind-type-alias">QueryReply</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">GraphReply</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L227">graph.ts:227</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L227">graph.ts:227</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_parseValue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#parse<wbr/>Value</span><a href="#_parseValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
@@ -224,7 +224,7 @@
<h5><span class="tsd-kind-parameter">promises</span>: <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">GraphValue</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L248">graph.ts:248</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L248">graph.ts:248</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_setMetadata" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#set<wbr/>Metadata</span><a href="#_setMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
@@ -232,7 +232,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">GraphMetadata</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L190">graph.ts:190</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L190">graph.ts:190</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_updateMetadata" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#update<wbr/>Metadata</span><a href="#_updateMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
@@ -240,7 +240,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">GraphMetadata</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L183">graph.ts:183</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L183">graph.ts:183</a></li></ul></aside></li></ul></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="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -260,7 +260,7 @@
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/commands.QueryOptions.html" class="tsd-signature-type tsd-kind-interface">QueryOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">GraphReply</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L153">graph.ts:153</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L153">graph.ts:153</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="roQuery" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ro<wbr/>Query</span><a href="#roQuery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -280,7 +280,7 @@
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/commands.QueryOptions.html" class="tsd-signature-type tsd-kind-interface">QueryOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">GraphReply</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/graph/lib/graph.ts#L167">graph.ts:167</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/graph/lib/graph.ts#L167">graph.ts:167</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">