Class default

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

Index

Constructors

Accessors

Methods

addListener close open removeListener stream submit

Constructors

constructor

new default(url: string, options?: ClientOptions): default
Creates a new instance of Client.
Parameters
- url: string
  The resource uri.
- Optionaloptions: ClientOptions = {}
  The connection options.
Returns default
- Defined in gremlin-javascript/lib/driver/client.ts:49

Accessors

isOpen

get isOpen(): boolean
Returns true if the underlying connection is open

Returns boolean
- Defined in gremlin-javascript/lib/driver/client.ts:68

Methods

addListener

addListener(event: string, handler: (...args: any[]) => unknown): void
Adds an event listener to the connection
Parameters
- event: string
  The event name that you want to listen to.
- handler: (...args: any[]) => unknown
  The callback to be called when the event occurs.
Returns void
- Defined in gremlin-javascript/lib/driver/client.ts:145

close

close(): Promise<void>
Closes the underlying connection send session close request before connection close if session mode

Returns Promise<void>
- Defined in gremlin-javascript/lib/driver/client.ts:136

open

open(): Promise<void>
Opens the underlying connection to the Gremlin Server, if it's not already opened.

Returns Promise<void>
- Defined in gremlin-javascript/lib/driver/client.ts:60

removeListener

removeListener(event: string, handler: (...args: any[]) => unknown): void
Removes a previowsly added event listener to the connection
Parameters
- event: string
  The event name that you want to listen to.
- handler: (...args: any[]) => unknown
  The event handler to be removed.
Returns void
- Defined in gremlin-javascript/lib/driver/client.ts:154

stream

stream(
    message: string,
    bindings?: any,
    requestOptions?: RequestOptions,
): Readable
Send a request to the Gremlin Server and receive a stream for the results.
Parameters
- message: string
  The script to send
- Optionalbindings: any
  The script bindings, if any.
- OptionalrequestOptions: RequestOptions
  Configuration specific to the current request.
Returns Readable
- Defined in gremlin-javascript/lib/driver/client.ts:127

submit

submit(
    message: string,
    bindings?: any,
    requestOptions?: RequestOptions,
): Promise<any>
Send a request to the Gremlin Server.
Parameters
- message: string
  The script to send
- Optionalbindings: any
  The script bindings, if any.
- OptionalrequestOptions: RequestOptions
  Configuration specific to the current request.
Returns Promise<any>
- Defined in gremlin-javascript/lib/driver/client.ts:93