Function

Static Public Summary
public	bookmarkManager(config: BookmarkManagerConfig): BookmarkManager Provides an configured BookmarkManager instance.	since 5.0
public	driver(url: string, authToken: Map<string, string>, config: Config): Driver Construct a new Neo4j Driver.
public	async hasReachableServer(url: string, config: object): true this function is experimental. Verifies if the driver can reach a server at the given url.	since 5.0.0
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.

Static Public

public bookmarkManager(config: BookmarkManagerConfig): BookmarkManager since 5.0 source

import {bookmarkManager} from 'neo4j-driver-core/lib/bookmark-manager.js'

Provides an configured BookmarkManager instance.

Params:

Name	Type	Attribute	Description
config	BookmarkManagerConfig	optional default: {}

Return:

BookmarkManager

public driver(url: string, authToken: Map<string, string>, config: Config): Driver source

import {driver} from 'neo4j-driver'

Construct a new Neo4j Driver. This is your main entry point for this library.

Params:

Name	Type	Attribute	Description
url	string		The URL for the Neo4j database, for instance "neo4j://localhost" and/or "bolt://localhost"
authToken	Map<string, string>		Authentication credentials. See auth for helpers.
config	Config		Configuration object.

Return:

Driver

public async hasReachableServer(url: string, config: object): true since 5.0.0 source

import {hasReachableServer} from 'neo4j-driver'

this function is experimental.

Verifies if the driver can reach a server at the given url.

Params:

Name	Type	Attribute	Description
url	string		The URL for the Neo4j database, for instance "neo4j://localhost" and/or "bolt://localhost"
config	object		Configuration object. See the driver

Return:

true	When the server is reachable

Throw:

Error

When the server is not reachable or the url is invalid

public isDate(obj: Object): boolean source

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

Test if given object is an instance of Date class.

Params:

Name	Type	Attribute	Description
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-core/lib/temporal-types.js'

Test if given object is an instance of DateTime class.

Params:

Name	Type	Attribute	Description
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-core/lib/temporal-types.js'

Test if given object is an instance of Duration class.

Params:

Name	Type	Attribute	Description
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-core/lib/temporal-types.js'

Test if given object is an instance of LocalDateTime class.

Params:

Name	Type	Attribute	Description
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-core/lib/temporal-types.js'

Test if given object is an instance of LocalTime class.

Params:

Name	Type	Attribute	Description
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-core/lib/graph-types.js'

Test if given object is an instance of Node class.

Params:

Name	Type	Attribute	Description
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-core/lib/graph-types.js'

Test if given object is an instance of Path class.

Params:

Name	Type	Attribute	Description
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-core/lib/graph-types.js'

Test if given object is an instance of PathSegment class.

Params:

Name	Type	Attribute	Description
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-core/lib/spatial-types.js'

Test if given object is an instance of Point class.

Params:

Name	Type	Attribute	Description
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-core/lib/graph-types.js'

Test if given object is an instance of Relationship class.

Params:

Name	Type	Attribute	Description
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-core/lib/temporal-types.js'

Test if given object is an instance of Time class.

Params:

Name	Type	Attribute	Description
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-core/lib/graph-types.js'

Test if given object is an instance of UnboundRelationship class.

Params:

Name	Type	Attribute	Description
obj	Object		the object to test.

Return:

boolean

true if given object is a UnboundRelationship, false otherwise.