Class default

constructor

• new default(url: string, options?: ClientOptions): default

  Parameters

  • url: string
  • options: ClientOptions = {}

  Returns default

Readonlyoptions

Readonlyurl

isOpen

• get isOpen(): boolean

  Returns true if the underlying connection is open

  Returns boolean

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

close

• close(): Promise<void>

  Closes the underlying connection

  Returns Promise<void>

open

• open(): Promise<void>

  Opens the underlying connection to the Gremlin Server, if it's not already opened.

  Returns Promise<void>

removeListener

• removeListener(event: string, handler: (...args: any[]) => unknown): void

  Removes a previously 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

stream

• stream(
      message: string,
      parameters?: any,
      requestOptions?: RequestOptions,
  ): AsyncGenerator<any>

  Send a request to the Gremlin Server and stream results incrementally. Returns an AsyncGenerator that yields individual result items as they are deserialized from the response. For bulked responses, yields Traverser objects.

  Parameters

  • message: string

    The script to send

  • Optionalparameters: any

    The query parameters, if any.

  • OptionalrequestOptions: RequestOptions

    Configuration specific to the current request.

  Returns AsyncGenerator<any>

submit

• submit(
      message: string,
      parameters?: any,
      requestOptions?: RequestOptions,
  ): Promise<any>

  Send a request to the Gremlin Server and buffer the entire response.

  Parameters

  • message: string

    The script to send

  • Optionalparameters: any

    The query parameters, if any.

  • OptionalrequestOptions: RequestOptions

    Configuration specific to the current request.

  Returns Promise<any>

trackTransaction

• trackTransaction(tx: any): void

  Parameters

  • tx: any

  Returns void

transact

• transact(): Transaction

  Creates a new Transaction for executing operations within an explicit transaction. Transactions are short-lived and single-use. After commit or rollback, create a new Transaction for the next unit of work. The traversal source (g alias) is inherited from this Client.

  Returns Transaction

untrackTransaction

• untrackTransaction(tx: any): void

  Parameters

  • tx: any

  Returns void