Home Reference Source

Function

Static Public Summary
public

driver(url: *, authToken: *, config: {}): *

public

isDate(obj: Object): boolean

Test if given object is an instance of Date class.

public

isDateTime(obj: Object): boolean

Test if given object is an instance of DateTime class.

public

isDuration(obj: Object): boolean

Test if given object is an instance of Duration class.

public

isLocalDateTime(obj: Object): boolean

Test if given object is an instance of LocalDateTime class.

public

isLocalTime(obj: Object): boolean

Test if given object is an instance of LocalTime class.

public

isNode(obj: Object): boolean

Test if given object is an instance of Node class.

public

isPath(obj: Object): boolean

Test if given object is an instance of Path class.

public

isPathSegment(obj: Object): boolean

Test if given object is an instance of PathSegment class.

public

isPoint(obj: Object): boolean

Test if given object is an instance of Point class.

public

isRelationship(obj: Object): boolean

Test if given object is an instance of Relationship class.

public

isTime(obj: Object): boolean

Test if given object is an instance of Time class.

public

isUnboundRelationship(obj: Object): boolean

Test if given object is an instance of UnboundRelationship class.

public

newError(message: *, code: string): *

Static Public

public driver(url: *, authToken: *, config: {}): * source

import {driver} from 'neo4j-driver'

Params:

NameTypeAttributeDescription
url *
authToken *
config {}
  • optional
  • default: {}

Return:

*

public isDate(obj: Object): boolean source

import {isDate} from 'neo4j-driver/lib/temporal-types.js'

Test if given object is an instance of Date class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a Date, false otherwise.

public isDateTime(obj: Object): boolean source

import {isDateTime} from 'neo4j-driver/lib/temporal-types.js'

Test if given object is an instance of DateTime class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a DateTime, false otherwise.

public isDuration(obj: Object): boolean source

import {isDuration} from 'neo4j-driver/lib/temporal-types.js'

Test if given object is an instance of Duration class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a Duration, false otherwise.

public isLocalDateTime(obj: Object): boolean source

import {isLocalDateTime} from 'neo4j-driver/lib/temporal-types.js'

Test if given object is an instance of LocalDateTime class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a LocalDateTime, false otherwise.

public isLocalTime(obj: Object): boolean source

import {isLocalTime} from 'neo4j-driver/lib/temporal-types.js'

Test if given object is an instance of LocalTime class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a LocalTime, false otherwise.

public isNode(obj: Object): boolean source

import {isNode} from 'neo4j-driver/lib/graph-types.js'

Test if given object is an instance of Node class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a Node, false otherwise.

public isPath(obj: Object): boolean source

import {isPath} from 'neo4j-driver/lib/graph-types.js'

Test if given object is an instance of Path class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a Path, false otherwise.

public isPathSegment(obj: Object): boolean source

import {isPathSegment} from 'neo4j-driver/lib/graph-types.js'

Test if given object is an instance of PathSegment class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a PathSegment, false otherwise.

public isPoint(obj: Object): boolean source

import {isPoint} from 'neo4j-driver/lib/spatial-types.js'

Test if given object is an instance of Point class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a Point, false otherwise.

public isRelationship(obj: Object): boolean source

import {isRelationship} from 'neo4j-driver/lib/graph-types.js'

Test if given object is an instance of Relationship class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a Relationship, false otherwise.

public isTime(obj: Object): boolean source

import {isTime} from 'neo4j-driver/lib/temporal-types.js'

Test if given object is an instance of Time class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a Time, false otherwise.

public isUnboundRelationship(obj: Object): boolean source

import {isUnboundRelationship} from 'neo4j-driver/lib/graph-types.js'

Test if given object is an instance of UnboundRelationship class.

Params:

NameTypeAttributeDescription
obj Object

the object to test.

Return:

boolean

true if given object is a UnboundRelationship, false otherwise.

public newError(message: *, code: string): * source

import {newError} from 'neo4j-driver/lib/error.js'

Params:

NameTypeAttributeDescription
message *
code string
  • optional
  • default: N/A

Return:

*