gremlin 3.5.2 → 3.5.3

package/.eslintrc.js

@@ -0,0 +1,154 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+
+'use strict';
+
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+  },
+  parserOptions: {
+    ecmaVersion: 2017,
+  },
+  ignorePatterns: ['test/**/*.js', 'doc/**/*.js'],
+  extends: ['eslint:recommended', 'prettier'],
+  plugins: ['prettier'],
+  rules: {
+    'prettier/prettier': ['error'],
+    indent: ['error', 2, { SwitchCase: 1 }],
+    'linebreak-style': ['error', 'unix'],
+    quotes: ['error', 'single'],
+    semi: ['error', 'always'],
+    'no-constant-condition': ['error', { checkLoops: false }],
+    strict: ['error', 'global'],
+    'array-callback-return': 'error',
+    curly: 'error',
+    'no-unused-vars': ['error', { args: 'none' }],
+    'global-require': 'error',
+    eqeqeq: ['error', 'allow-null'],
+
+    // make sure for-in loops have an if statement
+    'guard-for-in': 'error',
+    'no-alert': 'error',
+    'no-caller': 'error',
+    'no-case-declarations': 'error',
+    'no-else-return': 'error',
+    'no-empty-pattern': 'error',
+    'no-eval': 'error',
+    'no-extend-native': 'error',
+    'no-extra-bind': 'error',
+    'no-extra-label': 'error',
+    'no-floating-decimal': 'error',
+    'no-global-assign': ['error', { exceptions: [] }],
+    'no-implicit-coercion': [
+      'off',
+      {
+        boolean: false,
+        number: true,
+        string: true,
+        allow: [],
+      },
+    ],
+    'no-implied-eval': 'error',
+    'no-labels': ['error', { allowLoop: false, allowSwitch: false }],
+    'no-lone-blocks': 'error',
+    'no-loop-func': 'error',
+    //
+    // disallow use of multiple spaces
+    'no-multi-spaces': 'error',
+    'no-new': 'error',
+    'no-new-func': 'error',
+    'no-new-wrappers': 'error',
+    'no-octal-escape': 'error',
+    'no-proto': 'error',
+    'no-prototype-builtins': 0,
+    'no-redeclare': 'error',
+    'no-restricted-properties': [
+      'error',
+      {
+        object: 'arguments',
+        property: 'callee',
+        message: 'arguments.callee is deprecated',
+      },
+      {
+        property: '__defineGetter__',
+        message: 'Please use Object.defineProperty instead.',
+      },
+      {
+        property: '__defineSetter__',
+        message: 'Please use Object.defineProperty instead.',
+      },
+    ],
+    'no-self-assign': 'error',
+    'no-self-compare': 'error',
+    'no-sequences': 'error',
+    'no-throw-literal': 'error',
+    'no-unmodified-loop-condition': 'off',
+    'no-unused-expressions': [
+      'error',
+      {
+        allowShortCircuit: false,
+        allowTernary: false,
+      },
+    ],
+    'no-useless-call': 'off',
+    'no-useless-concat': 'error',
+    'no-useless-escape': 'error',
+    'no-useless-return': 'error',
+    'no-void': 'error',
+    'no-with': 'error',
+    'no-buffer-constructor': 'error',
+    radix: 'error',
+    'no-var': 'error',
+    'prefer-const': 'error',
+    'arrow-body-style': ['error', 'as-needed'],
+    'arrow-spacing': 'error',
+    'no-confusing-arrow': ['error', { allowParens: true }],
+    yoda: 'error',
+    'constructor-super': 'error',
+    'require-await': 'error',
+    'require-atomic-updates': 'off',
+  },
+  globals: {
+    Buffer: false,
+    Promise: true,
+    Symbol: false,
+    Uint16Array: false,
+    Int32Array: false,
+    Int8Array: false,
+    BigInt: false,
+    process: false,
+    setInterval: false,
+    setTimeout: false,
+    setImmediate: false,
+    clearInterval: false,
+    clearTimeout: false,
+    describe: false,
+    xdescribe: false,
+    it: false,
+    xit: false,
+    context: false,
+    after: false,
+    afterEach: false,
+    before: false,
+    beforeEach: false,
+    __filename: false,
+  },
+};

package/.prettierrc.js

@@ -0,0 +1,29 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+
+module.exports = {
+  singleQuote: true,
+  printWidth: 120,
+  trailingComma: 'all',
+  bracketSpacing: true,
+  arrowParens: 'always',
+  semi: true,
+  tabWidth: 2,
+  useTabs: false,
+};

package/Gruntfile.js

@@ -18,19 +18,18 @@
  */
 'use strict';
 
-module.exports = function(grunt) {
-
-    grunt.loadNpmTasks('grunt-jsdoc');
-    grunt.initConfig({
-        jsdoc : {
-            dist : {
-                src: ['lib'],
-                options: {
-                    destination: 'doc',
-                    recurse: true,
-                    readme: 'README.md'
-                }
-            }
-        }
-    });
-}
+module.exports = function (grunt) {
+  grunt.loadNpmTasks('grunt-jsdoc');
+  grunt.initConfig({
+    jsdoc: {
+      dist: {
+        src: ['lib'],
+        options: {
+          destination: 'doc',
+          recurse: true,
+          readme: 'README.md',
+        },
+      },
+    },
+  });
+};

package/doc/AnonymousTraversalSource.html

@@ -330,7 +330,7 @@ instance or a <code>RemoteConnection</code>.</div>
     
     <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#line48">line 48</a>
+        <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>
     
 
@@ -496,7 +496,7 @@ at which point there will be support for {@code withEmbedded} which is part of t
     
     <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#line73">line 73</a>
+        <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>
     
 
@@ -652,7 +652,7 @@ reference so that traversals spawned from it will execute over that reference.
     
     <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#line58">line 58</a>
+        <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>
     
 
@@ -722,7 +722,7 @@ reference so that traversals spawned from it will execute over that reference.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 14 2022 09:04:29 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 11 2022 07:21:14 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/doc/Authenticator.html

@@ -294,7 +294,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 14 2022 09:04:29 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 11 2022 07:21:14 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/doc/Bytecode.html

@@ -248,7 +248,7 @@
     
     <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#line114">line 114</a>
+        <a href="process_bytecode.js.html">process/bytecode.js</a>, <a href="process_bytecode.js.html#line116">line 116</a>
     </li></ul></dd>
     
 
@@ -400,7 +400,7 @@
     
     <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#line104">line 104</a>
+        <a href="process_bytecode.js.html">process/bytecode.js</a>, <a href="process_bytecode.js.html#line106">line 106</a>
     </li></ul></dd>
     
 
@@ -578,7 +578,7 @@
     
     <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#line49">line 49</a>
+        <a href="process_bytecode.js.html">process/bytecode.js</a>, <a href="process_bytecode.js.html#line48">line 48</a>
     </li></ul></dd>
     
 
@@ -756,7 +756,7 @@
     
     <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#line68">line 68</a>
+        <a href="process_bytecode.js.html">process/bytecode.js</a>, <a href="process_bytecode.js.html#line67">line 67</a>
     </li></ul></dd>
     
 
@@ -862,7 +862,7 @@
     
     <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#line94">line 94</a>
+        <a href="process_bytecode.js.html">process/bytecode.js</a>, <a href="process_bytecode.js.html#line96">line 96</a>
     </li></ul></dd>
     
 
@@ -932,7 +932,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 14 2022 09:04:29 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 11 2022 07:21:14 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/doc/Client.html

@@ -683,7 +683,7 @@
     
     <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#line72">line 72</a>
+        <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line71">line 71</a>
     </li></ul></dd>
     
 
@@ -835,7 +835,7 @@
     
     <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#line134">line 134</a>
+        <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line180">line 180</a>
     </li></ul></dd>
     
 
@@ -924,7 +924,7 @@ send session close request before connection close if session mode
     
     <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#line121">line 121</a>
+        <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line167">line 167</a>
     </li></ul></dd>
     
 
@@ -1030,7 +1030,7 @@ send session close request before connection close if session mode
     
     <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#line64">line 64</a>
+        <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line63">line 63</a>
     </li></ul></dd>
     
 
@@ -1208,7 +1208,7 @@ send session close request before connection close if session mode
     
     <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#line143">line 143</a>
+        <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line189">line 189</a>
     </li></ul></dd>
     
 
@@ -1244,7 +1244,7 @@ send session close request before connection close if session mode
     
 
     
-    <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"> &rarr; {Promise}</span></h4>
+    <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"> &rarr; {ReadableStream}</span></h4>
     
 
     
@@ -1252,7 +1252,7 @@ send session close request before connection close if session mode
 
 
 <div class="description">
-    Send a request to the Gremlin Server, can send a script or bytecode steps.
+    Send a request to the Gremlin Server and receive a stream for the results, can send a script or bytecode steps.
 </div>
 
 
@@ -1363,7 +1363,7 @@ send session close request before connection close if session mode
             <td class="type">
             
                 
-<span class="param-type">Object</span>
+<span class="param-type"><a href="global.html#RequestOptions">RequestOptions</a></span>
 
 
             
@@ -1383,9 +1383,122 @@ send session close request before connection close if session mode
 
             
 
-            <td class="description last">Configuration specific to the current request.
-                <h6>Properties</h6>
-                
+            <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#line130">line 130</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"> &rarr; {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>
@@ -1411,46 +1524,16 @@ send session close request before connection close if session mode
 
         <tr>
             
-                <td class="name"><code>requestId</code></td>
+                <td class="name"><code>message</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">String</span>
-
-
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-                    &lt;optional><br>
-                
-
-                
-
-                
-                </td>
-            
-
-            
-
-            <td class="description last">User specified request identifier which must be a UUID.</td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>batchSize</code></td>
-            
+<span class="param-type"><a href="Bytecode.html">Bytecode</a></span>
+|
 
-            <td class="type">
-            
-                
-<span class="param-type">Number</span>
+<span class="param-type">string</span>
 
 
             
@@ -1459,8 +1542,6 @@ send session close request before connection close if session mode
             
                 <td class="attributes">
                 
-                    &lt;optional><br>
-                
 
                 
 
@@ -1470,20 +1551,20 @@ send session close request before connection close if session mode
 
             
 
-            <td class="description last">The size in which the result of a request is to be "batched" back to the client</td>
+            <td class="description last">The bytecode or script to send</td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>userAgent</code></td>
+                <td class="name"><code>bindings</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">String</span>
+<span class="param-type">Object</span>
 
 
             
@@ -1503,20 +1584,20 @@ send session close request before connection close if session mode
 
             
 
-            <td class="description last">A custom string that specifies to the server where the request came from.</td>
+            <td class="description last">The script bindings, if any.</td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>evaluationTimeout</code></td>
+                <td class="name"><code>requestOptions</code></td>
             
 
             <td class="type">
             
                 
-<span class="param-type">Number</span>
+<span class="param-type"><a href="global.html#RequestOptions">RequestOptions</a></span>
 
 
             
@@ -1536,14 +1617,7 @@ send session close request before connection close if session mode
 
             
 
-            <td class="description last">The timeout for the evaluation of the request.</td>
-        </tr>
-
-    
-    </tbody>
-</table>
-
-            </td>
+            <td class="description last">Configuration specific to the current request.</td>
         </tr>
 
     
@@ -1584,7 +1658,7 @@ send session close request before connection close if session mode
     
     <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#line87">line 87</a>
+        <a href="driver_client.js.html">driver/client.js</a>, <a href="driver_client.js.html#line91">line 91</a>
     </li></ul></dd>
     
 
@@ -1654,7 +1728,7 @@ send session close request before connection close if session mode
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jan 14 2022 09:04:29 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Apr 11 2022 07:21:14 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>