You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by xi...@apache.org on 2023/01/21 03:22:47 UTC
svn commit: r1906850 [1/22] - in /tinkerpop/site/jsdocs/3.6.2: ./ fonts/ scripts/ scripts/prettify/ styles/
Author: xiazcy
Date: Sat Jan 21 03:22:46 2023
New Revision: 1906850
URL: http://svn.apache.org/viewvc?rev=1906850&view=rev
Log:
Adding 3.6.2 JavaScript docs
Added:
tinkerpop/site/jsdocs/3.6.2/
tinkerpop/site/jsdocs/3.6.2/AnonymousTraversalSource.html
tinkerpop/site/jsdocs/3.6.2/Authenticator.html
tinkerpop/site/jsdocs/3.6.2/Bytecode.html
tinkerpop/site/jsdocs/3.6.2/Client.html
tinkerpop/site/jsdocs/3.6.2/Connection.html
tinkerpop/site/jsdocs/3.6.2/DriverRemoteConnection.html
tinkerpop/site/jsdocs/3.6.2/EdgeLabelVerificationStrategy.html
tinkerpop/site/jsdocs/3.6.2/Graph.html
tinkerpop/site/jsdocs/3.6.2/GraphSON2Reader.html
tinkerpop/site/jsdocs/3.6.2/GraphSON2Writer.html
tinkerpop/site/jsdocs/3.6.2/GraphSON3Reader.html
tinkerpop/site/jsdocs/3.6.2/GraphSON3Writer.html
tinkerpop/site/jsdocs/3.6.2/GraphTraversal.html
tinkerpop/site/jsdocs/3.6.2/GraphTraversalSource.html
tinkerpop/site/jsdocs/3.6.2/HaltedTraverserStrategy.html
tinkerpop/site/jsdocs/3.6.2/MatchAlgorithmStrategy.html
tinkerpop/site/jsdocs/3.6.2/P.html
tinkerpop/site/jsdocs/3.6.2/PartitionStrategy.html
tinkerpop/site/jsdocs/3.6.2/Path.html
tinkerpop/site/jsdocs/3.6.2/PlainTextSaslAuthenticator.html
tinkerpop/site/jsdocs/3.6.2/ProductiveByStrategy.html
tinkerpop/site/jsdocs/3.6.2/RemoteConnection.html
tinkerpop/site/jsdocs/3.6.2/RemoteStrategy.html
tinkerpop/site/jsdocs/3.6.2/RemoteTraversal.html
tinkerpop/site/jsdocs/3.6.2/ReservedKeysVerificationStrategy.html
tinkerpop/site/jsdocs/3.6.2/ResponseError.html
tinkerpop/site/jsdocs/3.6.2/ResultSet.html
tinkerpop/site/jsdocs/3.6.2/SaslAuthenticator.html
tinkerpop/site/jsdocs/3.6.2/SaslMechanismBase.html
tinkerpop/site/jsdocs/3.6.2/SaslMechanismPlain.html
tinkerpop/site/jsdocs/3.6.2/SeedStrategy.html
tinkerpop/site/jsdocs/3.6.2/SubgraphStrategy.html
tinkerpop/site/jsdocs/3.6.2/TextP.html
tinkerpop/site/jsdocs/3.6.2/Transaction.html
tinkerpop/site/jsdocs/3.6.2/Translator.html
tinkerpop/site/jsdocs/3.6.2/TraversalStrategies.html
tinkerpop/site/jsdocs/3.6.2/TraversalStrategy.html
tinkerpop/site/jsdocs/3.6.2/TypeSerializer.html
tinkerpop/site/jsdocs/3.6.2/driver_auth_authenticator.js.html
tinkerpop/site/jsdocs/3.6.2/driver_auth_mechanisms_sasl-mechanism-base.js.html
tinkerpop/site/jsdocs/3.6.2/driver_auth_mechanisms_sasl-mechanism-plain.js.html
tinkerpop/site/jsdocs/3.6.2/driver_auth_plain-text-sasl-authenticator.js.html
tinkerpop/site/jsdocs/3.6.2/driver_auth_sasl-authenticator.js.html
tinkerpop/site/jsdocs/3.6.2/driver_client.js.html
tinkerpop/site/jsdocs/3.6.2/driver_connection.js.html
tinkerpop/site/jsdocs/3.6.2/driver_driver-remote-connection.js.html
tinkerpop/site/jsdocs/3.6.2/driver_remote-connection.js.html
tinkerpop/site/jsdocs/3.6.2/driver_response-error.js.html
tinkerpop/site/jsdocs/3.6.2/driver_result-set.js.html
tinkerpop/site/jsdocs/3.6.2/fonts/
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Bold-webfont.eot (with props)
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Bold-webfont.svg
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Bold-webfont.woff (with props)
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-BoldItalic-webfont.eot (with props)
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-BoldItalic-webfont.svg
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-BoldItalic-webfont.woff (with props)
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Italic-webfont.eot (with props)
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Italic-webfont.svg
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Italic-webfont.woff (with props)
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Light-webfont.eot (with props)
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Light-webfont.svg
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Light-webfont.woff (with props)
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-LightItalic-webfont.eot (with props)
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-LightItalic-webfont.svg
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-LightItalic-webfont.woff (with props)
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Regular-webfont.eot (with props)
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Regular-webfont.svg
tinkerpop/site/jsdocs/3.6.2/fonts/OpenSans-Regular-webfont.woff (with props)
tinkerpop/site/jsdocs/3.6.2/global.html
tinkerpop/site/jsdocs/3.6.2/index.html
tinkerpop/site/jsdocs/3.6.2/module.exports.html
tinkerpop/site/jsdocs/3.6.2/process_anonymous-traversal.js.html
tinkerpop/site/jsdocs/3.6.2/process_bytecode.js.html
tinkerpop/site/jsdocs/3.6.2/process_graph-traversal.js.html
tinkerpop/site/jsdocs/3.6.2/process_transaction.js.html
tinkerpop/site/jsdocs/3.6.2/process_translator.js.html
tinkerpop/site/jsdocs/3.6.2/process_traversal-strategy.js.html
tinkerpop/site/jsdocs/3.6.2/process_traversal.js.html
tinkerpop/site/jsdocs/3.6.2/scripts/
tinkerpop/site/jsdocs/3.6.2/scripts/linenumber.js
tinkerpop/site/jsdocs/3.6.2/scripts/prettify/
tinkerpop/site/jsdocs/3.6.2/scripts/prettify/Apache-License-2.0.txt
tinkerpop/site/jsdocs/3.6.2/scripts/prettify/lang-css.js
tinkerpop/site/jsdocs/3.6.2/scripts/prettify/prettify.js
tinkerpop/site/jsdocs/3.6.2/structure_graph.js.html
tinkerpop/site/jsdocs/3.6.2/structure_io_binary_internals_DataType.js.html
tinkerpop/site/jsdocs/3.6.2/structure_io_binary_internals_GraphBinaryReader.js.html
tinkerpop/site/jsdocs/3.6.2/structure_io_binary_internals_GraphBinaryWriter.js.html
tinkerpop/site/jsdocs/3.6.2/structure_io_graph-serializer.js.html
tinkerpop/site/jsdocs/3.6.2/structure_io_type-serializers.js.html
tinkerpop/site/jsdocs/3.6.2/styles/
tinkerpop/site/jsdocs/3.6.2/styles/jsdoc-default.css
tinkerpop/site/jsdocs/3.6.2/styles/prettify-jsdoc.css
tinkerpop/site/jsdocs/3.6.2/styles/prettify-tomorrow.css
Added: tinkerpop/site/jsdocs/3.6.2/AnonymousTraversalSource.html
URL: http://svn.apache.org/viewvc/tinkerpop/site/jsdocs/3.6.2/AnonymousTraversalSource.html?rev=1906850&view=auto
==============================================================================
--- tinkerpop/site/jsdocs/3.6.2/AnonymousTraversalSource.html (added)
+++ tinkerpop/site/jsdocs/3.6.2/AnonymousTraversalSource.html Sat Jan 21 03:22:46 2023
@@ -0,0 +1,731 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <title>JSDoc: Class: AnonymousTraversalSource</title>
+
+ <script src="scripts/prettify/prettify.js"> </script>
+ <script src="scripts/prettify/lang-css.js"> </script>
+ <!--[if lt IE 9]>
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+ <h1 class="page-title">Class: AnonymousTraversalSource</h1>
+
+
+
+
+
+
+<section>
+
+<header>
+
+ <h2><span class="attribs"><span class="type-signature"></span></span>AnonymousTraversalSource<span class="signature">(traversalSourceClass<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
+
+ <div class="class-description">Provides a unified way to construct a <code>TraversalSource</code> from the perspective of the traversal. In this
+syntax the user is creating the source and binding it to a reference which is either an existing <code>Graph</code>
+instance or a <code>RemoteConnection</code>.</div>
+
+
+</header>
+
+<article>
+ <div class="container-overview">
+
+
+
+
+ <h2>Constructor</h2>
+
+
+
+ <h4 class="name" id="AnonymousTraversalSource"><span class="type-signature"></span>new AnonymousTraversalSource<span class="signature">(traversalSourceClass<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+
+
+
+
+
+
+<div class="description">
+ Creates a new instance of {@code AnonymousTraversalSource}.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>traversalSourceClass</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">function</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">Optional {@code GraphTraversalSource} constructor.</td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="process_anonymous-traversal.js.html">process/anonymous-traversal.js</a>, <a href="process_anonymous-traversal.js.html#line32">line 32</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h3 class="subsection-title">Methods</h3>
+
+
+
+
+
+
+
+ <h4 class="name" id=".traversal"><span class="type-signature">(static) </span>traversal<span class="signature">(traversalSourceClass<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="AnonymousTraversalSource.html">AnonymousTraversalSource</a>}</span></h4>
+
+
+
+
+
+
+<div class="description">
+ Constructs an {@code AnonymousTraversalSource} which will then be configured to spawn a
+<a href="GraphTraversalSource.html">GraphTraversalSource</a>.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>traversalSourceClass</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">function</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">Optional {@code GraphTraversalSource} constructor.</td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="process_anonymous-traversal.js.html">process/anonymous-traversal.js</a>, <a href="process_anonymous-traversal.js.html#line47">line 47</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+<div class="param-desc">
+ .
+</div>
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type"><a href="AnonymousTraversalSource.html">AnonymousTraversalSource</a></span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h4 class="name" id="withGraph"><span class="type-signature"></span>withGraph<span class="signature">(graph)</span><span class="type-signature"> → {<a href="GraphTraversalSource.html">GraphTraversalSource</a>}</span></h4>
+
+
+
+
+
+
+<div class="description">
+ Creates the specified <a href="GraphTraversalSource.html">GraphTraversalSource</a> binding an embedded <a href="Graph.html">Graph</a> as its reference such that
+traversals spawned from it will execute over that reference. As there are no "embedded Graph" instances in
+gremlin-javascript as there on the JVM, the <a href="GraphTraversalSource.html">GraphTraversalSource</a> can only ever be constructed as "empty"
+with a <a href="Graph.html">Graph</a> instance (which is only a reference to a graph and is not capable of holding data). As a
+result, the <a href="GraphTraversalSource.html">GraphTraversalSource</a> will do nothing unless a "remote" is then assigned to it later.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>graph</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="Graph.html">Graph</a></span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"></td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>As of release 3.4.9, prefer withRemote until some form of "embedded graph" becomes available
+at which point there will be support for {@code withEmbedded} which is part of the canonical Java API.</li></ul></dd>
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="process_anonymous-traversal.js.html">process/anonymous-traversal.js</a>, <a href="process_anonymous-traversal.js.html#line72">line 72</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type"><a href="GraphTraversalSource.html">GraphTraversalSource</a></span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h4 class="name" id="withRemote"><span class="type-signature"></span>withRemote<span class="signature">(remoteConnection)</span><span class="type-signature"> → {<a href="GraphTraversalSource.html">GraphTraversalSource</a>}</span></h4>
+
+
+
+
+
+
+<div class="description">
+ Creates a <a href="GraphTraversalSource.html">GraphTraversalSource</a> binding a <a href="RemoteConnection.html">RemoteConnection</a> to a remote <a href="Graph.html">Graph</a> instances as its
+reference so that traversals spawned from it will execute over that reference.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>remoteConnection</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="RemoteConnection.html">RemoteConnection</a></span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"></td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="process_anonymous-traversal.js.html">process/anonymous-traversal.js</a>, <a href="process_anonymous-traversal.js.html#line57">line 57</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type"><a href="GraphTraversalSource.html">GraphTraversalSource</a></span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnonymousTraversalSource.html">AnonymousTraversalSource</a></li><li><a href="Authenticator.html">Authenticator</a></li><li><a href="Bytecode.html">Bytecode</a></li><li><a href="Client.html">Client</a></li><li><a href="Connection.html">Connection</a></li><li><a href="DriverRemoteConnection.html">DriverRemoteConnection</a></li><li><a href="EdgeLabelVerificationStrategy.html">EdgeLabelVerificationStrategy</a></li><li><a href="Graph.html">Graph</a></li><li><a href="GraphSON2Reader.html">GraphSON2Reader</a></li><li><a href="GraphSON2Writer.html">GraphSON2Writer</a></li><li><a href="GraphSON3Reader.html">GraphSON3Reader</a></li><li><a href="GraphSON3Writer.html">GraphSON3Writer</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="HaltedTraverserStrategy.html">HaltedTraverserStrategy</a></li><li><a href="MatchAlgorithmStrat
egy.html">MatchAlgorithmStrategy</a></li><li><a href="module.exports.html">exports</a></li><li><a href="P.html">P</a></li><li><a href="PartitionStrategy.html">PartitionStrategy</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</a></li><li><a href="ProductiveByStrategy.html">ProductiveByStrategy</a></li><li><a href="RemoteConnection.html">RemoteConnection</a></li><li><a href="RemoteStrategy.html">RemoteStrategy</a></li><li><a href="RemoteTraversal.html">RemoteTraversal</a></li><li><a href="ReservedKeysVerificationStrategy.html">ReservedKeysVerificationStrategy</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="SaslAuthenticator.html">SaslAuthenticator</a></li><li><a href="SaslMechanismBase.html">SaslMechanismBase</a></li><li><a href="SaslMechanismPlain.html">SaslMechanismPlain</a></li><li><a href="SeedStrategy.html">SeedStrategy</a></li><li><a hr
ef="SubgraphStrategy.html">SubgraphStrategy</a></li><li><a href="TextP.html">TextP</a></li><li><a href="Transaction.html">Transaction</a></li><li><a href="Translator.html">Translator</a></li><li><a href="TraversalStrategies.html">TraversalStrategies</a></li><li><a href="TraversalStrategy.html">TraversalStrategy</a></li><li><a href="TypeSerializer.html">TypeSerializer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DataType">DataType</a></li><li><a href="global.html#statics">statics</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri Jan 20 2023 17:38:52 GMT-0800 (Pacific Standard Time)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>
\ No newline at end of file
Added: tinkerpop/site/jsdocs/3.6.2/Authenticator.html
URL: http://svn.apache.org/viewvc/tinkerpop/site/jsdocs/3.6.2/Authenticator.html?rev=1906850&view=auto
==============================================================================
--- tinkerpop/site/jsdocs/3.6.2/Authenticator.html (added)
+++ tinkerpop/site/jsdocs/3.6.2/Authenticator.html Sat Jan 21 03:22:46 2023
@@ -0,0 +1,303 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <title>JSDoc: Class: Authenticator</title>
+
+ <script src="scripts/prettify/prettify.js"> </script>
+ <script src="scripts/prettify/lang-css.js"> </script>
+ <!--[if lt IE 9]>
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+ <h1 class="page-title">Class: Authenticator</h1>
+
+
+
+
+
+
+<section>
+
+<header>
+
+ <h2><span class="attribs"><span class="type-signature">(abstract) </span></span>Authenticator<span class="signature">()</span><span class="type-signature"></span></h2>
+
+
+</header>
+
+<article>
+ <div class="container-overview">
+
+
+
+
+
+
+ <h4 class="name" id="Authenticator"><span class="type-signature">(abstract) </span>new Authenticator<span class="signature">()</span><span class="type-signature"></span></h4>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="driver_auth_authenticator.js.html">driver/auth/authenticator.js</a>, <a href="driver_auth_authenticator.js.html#line23">line 23</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h3 class="subsection-title">Methods</h3>
+
+
+
+
+
+
+
+ <h4 class="name" id="evaluateChallenge"><span class="type-signature">(abstract) </span>evaluateChallenge<span class="signature">(challenge)</span><span class="type-signature"></span></h4>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>challenge</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last">Challenge string presented by the server.</td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="driver_auth_authenticator.js.html">driver/auth/authenticator.js</a>, <a href="driver_auth_authenticator.js.html#line33">line 33</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnonymousTraversalSource.html">AnonymousTraversalSource</a></li><li><a href="Authenticator.html">Authenticator</a></li><li><a href="Bytecode.html">Bytecode</a></li><li><a href="Client.html">Client</a></li><li><a href="Connection.html">Connection</a></li><li><a href="DriverRemoteConnection.html">DriverRemoteConnection</a></li><li><a href="EdgeLabelVerificationStrategy.html">EdgeLabelVerificationStrategy</a></li><li><a href="Graph.html">Graph</a></li><li><a href="GraphSON2Reader.html">GraphSON2Reader</a></li><li><a href="GraphSON2Writer.html">GraphSON2Writer</a></li><li><a href="GraphSON3Reader.html">GraphSON3Reader</a></li><li><a href="GraphSON3Writer.html">GraphSON3Writer</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="HaltedTraverserStrategy.html">HaltedTraverserStrategy</a></li><li><a href="MatchAlgorithmStrat
egy.html">MatchAlgorithmStrategy</a></li><li><a href="module.exports.html">exports</a></li><li><a href="P.html">P</a></li><li><a href="PartitionStrategy.html">PartitionStrategy</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</a></li><li><a href="ProductiveByStrategy.html">ProductiveByStrategy</a></li><li><a href="RemoteConnection.html">RemoteConnection</a></li><li><a href="RemoteStrategy.html">RemoteStrategy</a></li><li><a href="RemoteTraversal.html">RemoteTraversal</a></li><li><a href="ReservedKeysVerificationStrategy.html">ReservedKeysVerificationStrategy</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="SaslAuthenticator.html">SaslAuthenticator</a></li><li><a href="SaslMechanismBase.html">SaslMechanismBase</a></li><li><a href="SaslMechanismPlain.html">SaslMechanismPlain</a></li><li><a href="SeedStrategy.html">SeedStrategy</a></li><li><a hr
ef="SubgraphStrategy.html">SubgraphStrategy</a></li><li><a href="TextP.html">TextP</a></li><li><a href="Transaction.html">Transaction</a></li><li><a href="Translator.html">Translator</a></li><li><a href="TraversalStrategies.html">TraversalStrategies</a></li><li><a href="TraversalStrategy.html">TraversalStrategy</a></li><li><a href="TypeSerializer.html">TypeSerializer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DataType">DataType</a></li><li><a href="global.html#statics">statics</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri Jan 20 2023 17:38:52 GMT-0800 (Pacific Standard Time)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>
\ No newline at end of file
Added: tinkerpop/site/jsdocs/3.6.2/Bytecode.html
URL: http://svn.apache.org/viewvc/tinkerpop/site/jsdocs/3.6.2/Bytecode.html?rev=1906850&view=auto
==============================================================================
--- tinkerpop/site/jsdocs/3.6.2/Bytecode.html (added)
+++ tinkerpop/site/jsdocs/3.6.2/Bytecode.html Sat Jan 21 03:22:46 2023
@@ -0,0 +1,941 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <title>JSDoc: Class: Bytecode</title>
+
+ <script src="scripts/prettify/prettify.js"> </script>
+ <script src="scripts/prettify/lang-css.js"> </script>
+ <!--[if lt IE 9]>
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+ <h1 class="page-title">Class: Bytecode</h1>
+
+
+
+
+
+
+<section>
+
+<header>
+
+ <h2><span class="attribs"><span class="type-signature"></span></span>Bytecode<span class="signature">(toClone<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
+
+
+</header>
+
+<article>
+ <div class="container-overview">
+
+
+
+
+
+
+ <h4 class="name" id="Bytecode"><span class="type-signature"></span>new Bytecode<span class="signature">(toClone<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+
+
+
+
+
+
+<div class="description">
+ Creates a new instance of Bytecode
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>toClone</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="Bytecode.html">Bytecode</a></span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last"></td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="process_bytecode.js.html">process/bytecode.js</a>, <a href="process_bytecode.js.html#line32">line 32</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h3 class="subsection-title">Members</h3>
+
+
+
+<h4 class="name" id=".GraphOp"><span class="type-signature">(static) </span>GraphOp<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+ Gets the <code>Bytecode</code> that is meant to be sent as "graph operations" to the server.
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="process_bytecode.js.html">process/bytecode.js</a>, <a href="process_bytecode.js.html#line116">line 116</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+ <h3 class="subsection-title">Methods</h3>
+
+
+
+
+
+
+
+ <h4 class="name" id="._createGraphOp"><span class="type-signature">(static) </span>_createGraphOp<span class="signature">(name, values)</span><span class="type-signature"> → {<a href="Bytecode.html">Bytecode</a>}</span></h4>
+
+
+
+
+
+
+<div class="description">
+ Adds a new source instructions
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>name</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>values</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Array</span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"></td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="process_bytecode.js.html">process/bytecode.js</a>, <a href="process_bytecode.js.html#line106">line 106</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type"><a href="Bytecode.html">Bytecode</a></span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h4 class="name" id="addSource"><span class="type-signature"></span>addSource<span class="signature">(name, values)</span><span class="type-signature"> → {<a href="Bytecode.html">Bytecode</a>}</span></h4>
+
+
+
+
+
+
+<div class="description">
+ Adds a new source instructions
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>name</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>values</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Array</span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"></td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="process_bytecode.js.html">process/bytecode.js</a>, <a href="process_bytecode.js.html#line48">line 48</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type"><a href="Bytecode.html">Bytecode</a></span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h4 class="name" id="addStep"><span class="type-signature"></span>addStep<span class="signature">(name, values)</span><span class="type-signature"> → {<a href="Bytecode.html">Bytecode</a>}</span></h4>
+
+
+
+
+
+
+<div class="description">
+ Adds a new step instructions
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>name</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>values</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Array</span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"></td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="process_bytecode.js.html">process/bytecode.js</a>, <a href="process_bytecode.js.html#line67">line 67</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type"><a href="Bytecode.html">Bytecode</a></span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> → {String}</span></h4>
+
+
+
+
+
+
+<div class="description">
+ Returns the JSON representation of the source and step instructions
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="process_bytecode.js.html">process/bytecode.js</a>, <a href="process_bytecode.js.html#line96">line 96</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type">String</span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnonymousTraversalSource.html">AnonymousTraversalSource</a></li><li><a href="Authenticator.html">Authenticator</a></li><li><a href="Bytecode.html">Bytecode</a></li><li><a href="Client.html">Client</a></li><li><a href="Connection.html">Connection</a></li><li><a href="DriverRemoteConnection.html">DriverRemoteConnection</a></li><li><a href="EdgeLabelVerificationStrategy.html">EdgeLabelVerificationStrategy</a></li><li><a href="Graph.html">Graph</a></li><li><a href="GraphSON2Reader.html">GraphSON2Reader</a></li><li><a href="GraphSON2Writer.html">GraphSON2Writer</a></li><li><a href="GraphSON3Reader.html">GraphSON3Reader</a></li><li><a href="GraphSON3Writer.html">GraphSON3Writer</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="HaltedTraverserStrategy.html">HaltedTraverserStrategy</a></li><li><a href="MatchAlgorithmStrat
egy.html">MatchAlgorithmStrategy</a></li><li><a href="module.exports.html">exports</a></li><li><a href="P.html">P</a></li><li><a href="PartitionStrategy.html">PartitionStrategy</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</a></li><li><a href="ProductiveByStrategy.html">ProductiveByStrategy</a></li><li><a href="RemoteConnection.html">RemoteConnection</a></li><li><a href="RemoteStrategy.html">RemoteStrategy</a></li><li><a href="RemoteTraversal.html">RemoteTraversal</a></li><li><a href="ReservedKeysVerificationStrategy.html">ReservedKeysVerificationStrategy</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="SaslAuthenticator.html">SaslAuthenticator</a></li><li><a href="SaslMechanismBase.html">SaslMechanismBase</a></li><li><a href="SaslMechanismPlain.html">SaslMechanismPlain</a></li><li><a href="SeedStrategy.html">SeedStrategy</a></li><li><a hr
ef="SubgraphStrategy.html">SubgraphStrategy</a></li><li><a href="TextP.html">TextP</a></li><li><a href="Transaction.html">Transaction</a></li><li><a href="Translator.html">Translator</a></li><li><a href="TraversalStrategies.html">TraversalStrategies</a></li><li><a href="TraversalStrategy.html">TraversalStrategy</a></li><li><a href="TypeSerializer.html">TypeSerializer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DataType">DataType</a></li><li><a href="global.html#statics">statics</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri Jan 20 2023 17:38:52 GMT-0800 (Pacific Standard Time)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>
\ No newline at end of file
Added: tinkerpop/site/jsdocs/3.6.2/Client.html
URL: http://svn.apache.org/viewvc/tinkerpop/site/jsdocs/3.6.2/Client.html?rev=1906850&view=auto
==============================================================================
--- tinkerpop/site/jsdocs/3.6.2/Client.html (added)
+++ tinkerpop/site/jsdocs/3.6.2/Client.html Sat Jan 21 03:22:46 2023
@@ -0,0 +1,1902 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <title>JSDoc: Class: Client</title>
+
+ <script src="scripts/prettify/prettify.js"> </script>
+ <script src="scripts/prettify/lang-css.js"> </script>
+ <!--[if lt IE 9]>
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+ <h1 class="page-title">Class: Client</h1>
+
+
+
+
+
+
+<section>
+
+<header>
+
+ <h2><span class="attribs"><span class="type-signature"></span></span>Client<span class="signature">(url, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
+
+ <div class="class-description">A <a href="Client.html">Client</a> contains methods to send messages to a Gremlin Server.</div>
+
+
+</header>
+
+<article>
+ <div class="container-overview">
+
+
+
+
+ <h2>Constructor</h2>
+
+
+
+ <h4 class="name" id="Client"><span class="type-signature"></span>new Client<span class="signature">(url, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+
+
+
+
+
+
+<div class="description">
+ Creates a new instance of <a href="Client.html">Client</a>.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>url</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The resource uri.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>options</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The connection options.
+ <h6>Properties</h6>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>ca</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Array</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">Trusted certificates.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>cert</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+|
+
+<span class="param-type">Array</span>
+|
+
+<span class="param-type">Buffer</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The certificate key.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>mimeType</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The mime type to use.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>pfx</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+|
+
+<span class="param-type">Buffer</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The private key, certificate, and CA certs.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>reader</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">GraphSONReader</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The reader to use.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>rejectUnauthorized</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Boolean</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">Determines whether to verify or not the server certificate.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>traversalSource</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The traversal source. Defaults to: 'g'.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>writer</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">GraphSONWriter</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The writer to use.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>authenticator</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="Authenticator.html">Authenticator</a></span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The authentication handler to use.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>headers</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">An associative array containing the additional header key/values for the initial request.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>enableUserAgentOnConnect</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Boolean</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">Determines if a user agent will be sent during connection handshake. Defaults to: true</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>processor</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The name of the opProcessor to use, leave it undefined or set 'session' when session mode.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>session</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The sessionId of Client in session mode. Defaults to null means session-less Client.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>pingEnabled</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Boolean</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">Setup ping interval. Defaults to: true.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>pingInterval</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Number</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">Ping request interval in ms if ping enabled. Defaults to: 60000.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>pongTimeout</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Number</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">Timeout of pong response in ms after sending a ping. Defaults to: 30000.</td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+ </td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line28">line 28</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h3 class="subsection-title">Members</h3>
+
+
+
+<h4 class="name" id="isOpen"><span class="type-signature"></span>isOpen<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+ Returns true if the underlying connection is open
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line76">line 76</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+ <h3 class="subsection-title">Methods</h3>
+
+
+
+
+
+
+
+ <h4 class="name" id="addListener"><span class="type-signature"></span>addListener<span class="signature">(event, handler)</span><span class="type-signature"></span></h4>
+
+
+
+
+
+
+<div class="description">
+ Adds an event listener to the connection
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>event</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last">The event name that you want to listen to.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>handler</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">function</span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last">The callback to be called when the event occurs.</td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line185">line 185</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h4 class="name" id="close"><span class="type-signature"></span>close<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
+
+
+
+
+
+
+<div class="description">
+ Closes the underlying connection
+send session close request before connection close if session mode
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line172">line 172</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type">Promise</span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h4 class="name" id="open"><span class="type-signature"></span>open<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
+
+
+
+
+
+
+<div class="description">
+ Opens the underlying connection to the Gremlin Server, if it's not already opened.
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line68">line 68</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type">Promise</span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h4 class="name" id="removeListener"><span class="type-signature"></span>removeListener<span class="signature">(event, handler)</span><span class="type-signature"></span></h4>
+
+
+
+
+
+
+<div class="description">
+ Removes a previowsly added event listener to the connection
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>event</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last">The event name that you want to listen to.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>handler</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">function</span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last">The event handler to be removed.</td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line194">line 194</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h4 class="name" id="stream"><span class="type-signature"></span>stream<span class="signature">(message, bindings<span class="signature-attributes">opt</span>, requestOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {ReadableStream}</span></h4>
+
+
+
+
+
+
+<div class="description">
+ Send a request to the Gremlin Server and receive a stream for the results, can send a script or bytecode steps.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>message</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="Bytecode.html">Bytecode</a></span>
+|
+
+<span class="param-type">string</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The bytecode or script to send</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>bindings</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The script bindings, if any.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>requestOptions</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="global.html#RequestOptions">RequestOptions</a></span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">Configuration specific to the current request.</td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line135">line 135</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type">ReadableStream</span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <h4 class="name" id="submit"><span class="type-signature"></span>submit<span class="signature">(message, bindings<span class="signature-attributes">opt</span>, requestOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
+
+
+
+
+
+
+<div class="description">
+ Send a request to the Gremlin Server, can send a script or bytecode steps.
+</div>
+
+
+
+
+
+
+
+
+
+ <h5>Parameters:</h5>
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+ <th>Attributes</th>
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>message</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="Bytecode.html">Bytecode</a></span>
+|
+
+<span class="param-type">string</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The bytecode or script to send</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>bindings</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">The script bindings, if any.</td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>requestOptions</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="global.html#RequestOptions">RequestOptions</a></span>
+
+
+
+ </td>
+
+
+ <td class="attributes">
+
+ <optional><br>
+
+
+
+
+
+ </td>
+
+
+
+
+ <td class="description last">Configuration specific to the current request.</td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>
+ <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line96">line 96</a>
+ </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type">Promise</span>
+
+
+ </dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnonymousTraversalSource.html">AnonymousTraversalSource</a></li><li><a href="Authenticator.html">Authenticator</a></li><li><a href="Bytecode.html">Bytecode</a></li><li><a href="Client.html">Client</a></li><li><a href="Connection.html">Connection</a></li><li><a href="DriverRemoteConnection.html">DriverRemoteConnection</a></li><li><a href="EdgeLabelVerificationStrategy.html">EdgeLabelVerificationStrategy</a></li><li><a href="Graph.html">Graph</a></li><li><a href="GraphSON2Reader.html">GraphSON2Reader</a></li><li><a href="GraphSON2Writer.html">GraphSON2Writer</a></li><li><a href="GraphSON3Reader.html">GraphSON3Reader</a></li><li><a href="GraphSON3Writer.html">GraphSON3Writer</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="HaltedTraverserStrategy.html">HaltedTraverserStrategy</a></li><li><a href="MatchAlgorithmStrat
egy.html">MatchAlgorithmStrategy</a></li><li><a href="module.exports.html">exports</a></li><li><a href="P.html">P</a></li><li><a href="PartitionStrategy.html">PartitionStrategy</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</a></li><li><a href="ProductiveByStrategy.html">ProductiveByStrategy</a></li><li><a href="RemoteConnection.html">RemoteConnection</a></li><li><a href="RemoteStrategy.html">RemoteStrategy</a></li><li><a href="RemoteTraversal.html">RemoteTraversal</a></li><li><a href="ReservedKeysVerificationStrategy.html">ReservedKeysVerificationStrategy</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="SaslAuthenticator.html">SaslAuthenticator</a></li><li><a href="SaslMechanismBase.html">SaslMechanismBase</a></li><li><a href="SaslMechanismPlain.html">SaslMechanismPlain</a></li><li><a href="SeedStrategy.html">SeedStrategy</a></li><li><a hr
ef="SubgraphStrategy.html">SubgraphStrategy</a></li><li><a href="TextP.html">TextP</a></li><li><a href="Transaction.html">Transaction</a></li><li><a href="Translator.html">Translator</a></li><li><a href="TraversalStrategies.html">TraversalStrategies</a></li><li><a href="TraversalStrategy.html">TraversalStrategy</a></li><li><a href="TypeSerializer.html">TypeSerializer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DataType">DataType</a></li><li><a href="global.html#statics">statics</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri Jan 20 2023 17:38:52 GMT-0800 (Pacific Standard Time)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>
\ No newline at end of file