Added: tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/Client.html URL: http://svn.apache.org/viewvc/tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/Client.html?rev=1846578&view=auto ============================================================================== --- tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/Client.html (added) +++ tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/Client.html Wed Nov 14 12:33:19 2018 @@ -0,0 +1,1009 @@ +<!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"><a href="GraphSONReader.html">GraphSONReader</a></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"><a href="GraphSONWriter.html">GraphSONWriter</a></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> + + + </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#line27">line 27</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + + + + + + + <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 +</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#line85">line 85</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#line53">line 53</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="submit"><span class="type-signature"></span>submit<span class="signature">(message, bindings<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> + + + </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#line63">line 63</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="GraphSONReader.html">GraphSONReader</a></li><li><a href="GraphSONWriter.html">GraphSONWriter</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="P.html">P</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</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="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="TextP.html">TextP</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#statics">statics</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Wed Nov 14 2018 07:31:46 GMT-0500 (EST) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> \ No newline at end of file
Added: tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/Connection.html URL: http://svn.apache.org/viewvc/tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/Connection.html?rev=1846578&view=auto ============================================================================== --- tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/Connection.html (added) +++ tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/Connection.html Wed Nov 14 12:33:19 2018 @@ -0,0 +1,1001 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: Connection</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: Connection</h1> + + + + + + +<section> + +<header> + + <h2><span class="attribs"><span class="type-signature"></span></span>Connection<span class="signature">(url, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> + + <div class="class-description">Represents a single connection to a Gremlin Server.</div> + + +</header> + +<article> + <div class="container-overview"> + + + + + <h2>Constructor</h2> + + + + <h4 class="name" id="Connection"><span class="type-signature"></span>new Connection<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="Connection.html">Connection</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"><a href="GraphSONReader.html">GraphSONReader</a></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"><a href="GraphSONWriter.html">GraphSONWriter</a></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> + + + </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_connection.js.html">driver/connection.js</a>, <a href="driver_connection.js.html#line43">line 43</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + + + + + + + + + + + + + <h3 class="subsection-title">Members</h3> + + + +<h4 class="name" id="mimeType"><span class="type-signature"></span>mimeType<span class="type-signature"> :String</span></h4> + + + + +<div class="description"> + Gets the MIME type. +</div> + + + + <h5>Type:</h5> + <ul> + <li> + +<span class="param-type">String</span> + + + </li> + </ul> + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="driver_connection.js.html">driver/connection.js</a>, <a href="driver_connection.js.html#line93">line 93</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + + + + + + + <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 Connection. +</div> + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="driver_connection.js.html">driver/connection.js</a>, <a href="driver_connection.js.html#line252">line 252</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 connection, if its not already opened. +</div> + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="driver_connection.js.html">driver/connection.js</a>, <a href="driver_connection.js.html#line105">line 105</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="submit"><span class="type-signature"></span>submit<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_connection.js.html">driver/connection.js</a>, <a href="driver_connection.js.html#line122">line 122</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="GraphSONReader.html">GraphSONReader</a></li><li><a href="GraphSONWriter.html">GraphSONWriter</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="P.html">P</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</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="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="TextP.html">TextP</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#statics">statics</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Wed Nov 14 2018 07:31:46 GMT-0500 (EST) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> \ No newline at end of file Added: tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/DriverRemoteConnection.html URL: http://svn.apache.org/viewvc/tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/DriverRemoteConnection.html?rev=1846578&view=auto ============================================================================== --- tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/DriverRemoteConnection.html (added) +++ tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/DriverRemoteConnection.html Wed Nov 14 12:33:19 2018 @@ -0,0 +1,881 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: DriverRemoteConnection</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: DriverRemoteConnection</h1> + + + + + + +<section> + +<header> + + <h2><span class="attribs"><span class="type-signature"></span></span>DriverRemoteConnection<span class="signature">(url, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> + + <div class="class-description">Represents the default <a href="RemoteConnection.html">RemoteConnection</a> implementation.</div> + + +</header> + +<article> + <div class="container-overview"> + + + + + <h2>Constructor</h2> + + + + <h4 class="name" id="DriverRemoteConnection"><span class="type-signature"></span>new DriverRemoteConnection<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="DriverRemoteConnection.html">DriverRemoteConnection</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"><a href="GraphSONReader.html">GraphSONReader</a></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"><a href="GraphSONWriter.html">GraphSONWriter</a></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> + + + </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_driver-remote-connection.js.html">driver/driver-remote-connection.js</a>, <a href="driver_driver-remote-connection.js.html#line33">line 33</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + + + + + + + <h4 class="name" id="close"><span class="type-signature"></span>close<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_driver-remote-connection.js.html">driver/driver-remote-connection.js</a>, <a href="driver_driver-remote-connection.js.html#line67">line 67</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + + + + + + <h4 class="name" id="open"><span class="type-signature"></span>open<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_driver-remote-connection.js.html">driver/driver-remote-connection.js</a>, <a href="driver_driver-remote-connection.js.html#line57">line 57</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + + + + + + <h4 class="name" id="submit"><span class="type-signature"></span>submit<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_driver-remote-connection.js.html">driver/driver-remote-connection.js</a>, <a href="driver_driver-remote-connection.js.html#line62">line 62</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="GraphSONReader.html">GraphSONReader</a></li><li><a href="GraphSONWriter.html">GraphSONWriter</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="P.html">P</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</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="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="TextP.html">TextP</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#statics">statics</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Wed Nov 14 2018 07:31:46 GMT-0500 (EST) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> \ No newline at end of file Added: tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/GraphSONReader.html URL: http://svn.apache.org/viewvc/tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/GraphSONReader.html?rev=1846578&view=auto ============================================================================== --- tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/GraphSONReader.html (added) +++ tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/GraphSONReader.html Wed Nov 14 12:33:19 2018 @@ -0,0 +1,291 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: GraphSONReader</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: GraphSONReader</h1> + + + + + + +<section> + +<header> + + <h2><span class="attribs"><span class="type-signature"></span></span>GraphSONReader<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> + + +</header> + +<article> + <div class="container-overview"> + + + + + + + <h4 class="name" id="GraphSONReader"><span class="type-signature"></span>new GraphSONReader<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + GraphSON Reader +</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>options</code></td> + + + <td class="type"> + + +<span class="param-type">Object</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + + <td class="description last"> + <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>serializers</code></td> + + + <td class="type"> + + +<span class="param-type">Object</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + + <td class="description last">An object used as an associative array with GraphSON 2 type name as keys and +deserializer instances as values, ie: { 'g:Int64': longSerializer }.</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="structure_io_graph-serializer.js.html">structure/io/graph-serializer.js</a>, <a href="structure_io_graph-serializer.js.html#line94">line 94</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + + + + + + + + + + + + + + + + + + +</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="GraphSONReader.html">GraphSONReader</a></li><li><a href="GraphSONWriter.html">GraphSONWriter</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="P.html">P</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</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="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="TextP.html">TextP</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#statics">statics</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Wed Nov 14 2018 07:31:46 GMT-0500 (EST) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> \ No newline at end of file Added: tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/GraphSONWriter.html URL: http://svn.apache.org/viewvc/tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/GraphSONWriter.html?rev=1846578&view=auto ============================================================================== --- tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/GraphSONWriter.html (added) +++ tinkerpop/site/jsdocs/3.4.0-SNAPSHOT/GraphSONWriter.html Wed Nov 14 12:33:19 2018 @@ -0,0 +1,436 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: GraphSONWriter</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: GraphSONWriter</h1> + + + + + + +<section> + +<header> + + <h2><span class="attribs"><span class="type-signature"></span></span>GraphSONWriter<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> + + <div class="class-description">GraphSON Writer</div> + + +</header> + +<article> + <div class="container-overview"> + + + + + <h2>Constructor</h2> + + + + <h4 class="name" id="GraphSONWriter"><span class="type-signature"></span>new GraphSONWriter<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> + + + + + + + + + + + + + + + <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>options</code></td> + + + <td class="type"> + + +<span class="param-type">Object</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + + <td class="description last"> + <h6>Properties</h6> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>serializers</code></td> + + + <td class="type"> + + +<span class="param-type">Object</span> + + + + </td> + + + + + + <td class="description last">An object used as an associative array with GraphSON 2 type name as keys and +serializer instances as values, ie: { 'g:Int64': longSerializer }.</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="structure_io_graph-serializer.js.html">structure/io/graph-serializer.js</a>, <a href="structure_io_graph-serializer.js.html#line30">line 30</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + + + + + + + <h4 class="name" id="write"><span class="type-signature"></span>write<span class="signature">(obj)</span><span class="type-signature"> → {String}</span></h4> + + + + + + +<div class="description"> + Returns the GraphSON representation of the provided object instance. +</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>obj</code></td> + + + <td class="type"> + + +<span class="param-type">Object</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="structure_io_graph-serializer.js.html">structure/io/graph-serializer.js</a>, <a href="structure_io_graph-serializer.js.html#line81">line 81</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="GraphSONReader.html">GraphSONReader</a></li><li><a href="GraphSONWriter.html">GraphSONWriter</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="P.html">P</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</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="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="TextP.html">TextP</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#statics">statics</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Wed Nov 14 2018 07:31:46 GMT-0500 (EST) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> \ No newline at end of file
