Class default

Represents a single connection to a Gremlin Server.

Hierarchy

EventEmitter
- default

Index

Constructors

constructor

new default(url: string, options?: ConnectionOptions): default
Creates a new instance of Connection.
Parameters
- url: string
  The resource uri.
- Optionaloptions: ConnectionOptions = {}
  The connection options.
Returns default
Overrides EventEmitter.constructor
- Defined in gremlin-javascript/lib/driver/connection.ts:110

Properties

isOpen

isOpen: boolean = true

`Readonly`options

options: ConnectionOptions = {}

The connection options.

traversalSource

traversalSource: string

`Readonly`url

url: string

The resource uri.

`Static`prefixed

prefixed: string | boolean

Accessors

batchSize

get batchSize(): number
The connection-level default batch size, used to fill a request's batchSize when unset.

Returns number
- Defined in gremlin-javascript/lib/driver/connection.ts:169

bulkResults

get bulkResults(): boolean
The connection-level default for bulkResults, applied to every request unless overridden per-request. Defaults to false.

Returns boolean
- Defined in gremlin-javascript/lib/driver/connection.ts:177

Methods

addListener

addListener<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

close

close(): Promise<void>
Closes the Connection.

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

emit

emit<T extends string | symbol>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends string | symbol>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

open

open(): Promise<void>
Opens the connection, if its not already opened.

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

removeAllListeners

removeAllListeners(event?: string | symbol): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

stream

stream(request: RequestMessage): AsyncGenerator<any>
Send a request and stream the response incrementally. Returns an AsyncGenerator that yields deserialized result items. For bulked responses, yields Traverser objects.

In the GraphBinary v4 streaming protocol, the server sends the status after all result data. If the server encounters an error mid-traversal, values yielded before the error are valid partial results. A ResponseError is thrown after the last value has been yielded.
Parameters
- request: RequestMessage
Returns AsyncGenerator<any>
- Defined in gremlin-javascript/lib/driver/connection.ts:211

submit

submit(request: RequestMessage): Promise<default>
Send a request and buffer the entire response. Returns a Promise.
Parameters
- request: RequestMessage
Returns Promise<default>
- Defined in gremlin-javascript/lib/driver/connection.ts:193

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

isOpen

Readonlyoptions

traversalSource

Readonlyurl

Staticprefixed

Accessors

batchSize

Returns number

bulkResults

Returns boolean

Methods

addListener

Type Parameters

Parameters

Returns this

close

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: any[]) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

open

Returns Promise<void>

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

stream

Parameters

Returns AsyncGenerator<any>

submit

Parameters

Returns Promise<default>

Settings

On This Page

`Readonly`options

`Readonly`url

`Static`prefixed