Class: Client

Client(url, optionsopt)

A Client contains methods to send messages to a Gremlin Server.

Constructor

new Client(url, optionsopt)

Creates a new instance of Client.
Parameters:
Name Type Attributes Description
url String The resource uri.
options Object <optional>
 The connection options.
Properties
Name Type Attributes Description
ca Array <optional>
 Trusted certificates.
cert String | Array | Buffer <optional>
 The certificate key.
mimeType String <optional>
 The mime type to use.
pfx String | Buffer <optional>
 The private key, certificate, and CA certs.
reader GraphSONReader <optional>
 The reader to use.
rejectUnauthorized Boolean <optional>
 Determines whether to verify or not the server certificate.
traversalSource String <optional>
 The traversal source. Defaults to: 'g'.
writer GraphSONWriter <optional>
 The writer to use.
authenticator Authenticator <optional>
 The authentication handler to use.
headers Object <optional>
 An associative array containing the additional header key/values for the initial request.
enableUserAgentOnConnect Boolean <optional>
 Determines if a user agent will be sent during connection handshake. Defaults to: true
processor String <optional>
 The name of the opProcessor to use, leave it undefined or set 'session' when session mode.
session String <optional>
 The sessionId of Client in session mode. Defaults to null means session-less Client.
pingEnabled Boolean <optional>
 Setup ping interval. Defaults to: true.
pingInterval Number <optional>
 Ping request interval in ms if ping enabled. Defaults to: 60000.
pongTimeout Number <optional>
 Timeout of pong response in ms after sending a ping. Defaults to: 30000.
Source:

Members

isOpen

Returns true if the underlying connection is open
Source:

Methods

addListener(event, handler)

Adds an event listener to the connection
Parameters:
Name Type Description
event String The event name that you want to listen to.
handler function The callback to be called when the event occurs.
Source:

close() → {Promise}

Closes the underlying connection send session close request before connection close if session mode
Source:
Returns:
Type
Promise

open() → {Promise}

Opens the underlying connection to the Gremlin Server, if it's not already opened.
Source:
Returns:
Type
Promise

removeListener(event, handler)

Removes a previowsly added event listener to the connection
Parameters:
Name Type Description
event String The event name that you want to listen to.
handler function The event handler to be removed.
Source:

stream(message, bindingsopt, requestOptionsopt) → {ReadableStream}

Send a request to the Gremlin Server and receive a stream for the results, can send a script or bytecode steps.
Parameters:
Name Type Attributes Description
message Bytecode | string The bytecode or script to send
bindings Object <optional>
 The script bindings, if any.
requestOptions RequestOptions <optional>
 Configuration specific to the current request.
Source:
Returns:
Type
ReadableStream

submit(message, bindingsopt, requestOptionsopt) → {Promise}

Send a request to the Gremlin Server, can send a script or bytecode steps.
Parameters:
Name Type Attributes Description
message Bytecode | string The bytecode or script to send
bindings Object <optional>
 The script bindings, if any.
requestOptions RequestOptions <optional>
 Configuration specific to the current request.
Source:
Returns:
Type
Promise