Home Reference Source

Variable

Static Public Summary
public

PROTOCOL_ERROR: string

Error code representing serialization/deserialization issue in the Bolt protocol.

public

READ: string

Constant that represents read session access mode.

public

Error code representing complete loss of service.

public

SESSION_EXPIRED: string

Error code representing transient loss of service.

public

WRITE: string

Constant that represents write session access mode.

public

auth: {"basic": *, "kerberos": *, "custom": *}

public

error: {"SERVICE_UNAVAILABLE": *, "SESSION_EXPIRED": *, "PROTOCOL_ERROR": *}

Object containing string constants representing predefined Neo4jError codes.

public

inSafeRange(value: Mixed): Boolean: *

Check if a variable can be safely converted to a number

public

int(value: Mixed): Integer: *

Cast value to Integer type.

public

integer: {"toNumber": *, "toString": *, "inSafeRange": *}

Object containing functions to work with Integer objects.

public

isInt(value: Mixed): Boolean: *

Check if a variable is of Integer type.

public

logging: {"console": *}

Object containing predefined logging configurations.

public

session: {"READ": *, "WRITE": *}

Object containing string constants representing session access modes.

public

spatial: {"isPoint": *}

Object containing functions to work with spatial types, like Point.

public

statementType: {"READ_ONLY": string, "READ_WRITE": string, "WRITE_ONLY": string, "SCHEMA_WRITE": string}

public

temporal: {"isDuration": *, "isLocalTime": *, "isTime": *, "isDate": *, "isLocalDateTime": *, "isDateTime": *}

Object containing functions to work with temporal types, like Time or Duration.

public

toNumber(value: Mixed): number: *

Converts a variable to a number

public

toString(value: Mixed, radix: number): String: *

Converts the integer to a string representation

public

types: {"Node": *, "Relationship": *, "UnboundRelationship": *, "PathSegment": *, "Path": *, "Result": *, "ResultSummary": *, "Record": *, "Point": *, "Date": *, "DateTime": *, "Duration": *, "LocalDateTime": *, "LocalTime": *, "Time": *}

Object containing constructors for all neo4j types.

Static Public

public PROTOCOL_ERROR: string source

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

Error code representing serialization/deserialization issue in the Bolt protocol. Used by Neo4jError#code.

public READ: string source

import {READ} from 'neo4j-driver/lib/v1/driver.js'

Constant that represents read session access mode. Should be used like this: driver.session(neo4j.session.READ).

public SERVICE_UNAVAILABLE: string source

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

Error code representing complete loss of service. Used by Neo4jError#code.

public SESSION_EXPIRED: string source

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

Error code representing transient loss of service. Used by Neo4jError#code.

public WRITE: string source

import {WRITE} from 'neo4j-driver/lib/v1/driver.js'

Constant that represents write session access mode. Should be used like this: driver.session(neo4j.session.WRITE).

public auth: {"basic": *, "kerberos": *, "custom": *} source

import {auth} from 'neo4j-driver/lib/v1/index.js'

Properties:

NameTypeAttributeDescription
basic function(username: string, password: string, realm: ?string)

the function to create a basic authentication token.

kerberos function(base64EncodedTicket: string)

the function to create a Kerberos authentication token. Accepts a single string argument - base64 encoded Kerberos ticket.

custom function(principal: string, credentials: string, realm: string, scheme: string, parameters: ?object)

the function to create a custom authentication token.

public error: {"SERVICE_UNAVAILABLE": *, "SESSION_EXPIRED": *, "PROTOCOL_ERROR": *} source

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

Object containing string constants representing predefined Neo4jError codes.

public inSafeRange(value: Mixed): Boolean: * source

import {inSafeRange} from 'neo4j-driver/lib/v1/integer.js'

Check if a variable can be safely converted to a number

Return:

Boolean

true if it is safe to call toNumber on variable otherwise false

public int(value: Mixed): Integer: * source

import {int} from 'neo4j-driver/lib/v1/integer.js'

Cast value to Integer type.

Return:

Integer

An object of type Integer.

public integer: {"toNumber": *, "toString": *, "inSafeRange": *} source

import {integer} from 'neo4j-driver/lib/v1/index.js'

Object containing functions to work with Integer objects.

public isInt(value: Mixed): Boolean: * source

import {isInt} from 'neo4j-driver/lib/v1/integer.js'

Check if a variable is of Integer type.

Return:

Boolean

Is it of the Integer type?

public logging: {"console": *} source

import {logging} from 'neo4j-driver/lib/v1/index.js'

Object containing predefined logging configurations. These are expected to be used as values of the driver config's logging property.

Properties:

NameTypeAttributeDescription
console function(level: ?string): object

the function to create a logging config that prints all messages to console.log with timestamp, level and message. It takes an optional level parameter which represents the maximum log level to be logged. Default value is 'info'.

public session: {"READ": *, "WRITE": *} source

import {session} from 'neo4j-driver/lib/v1/index.js'

Object containing string constants representing session access modes.

public spatial: {"isPoint": *} source

import {spatial} from 'neo4j-driver/lib/v1/index.js'

Object containing functions to work with spatial types, like Point.

public statementType: {"READ_ONLY": string, "READ_WRITE": string, "WRITE_ONLY": string, "SCHEMA_WRITE": string} source

import {statementType} from 'neo4j-driver/lib/v1/result-summary.js'

public temporal: {"isDuration": *, "isLocalTime": *, "isTime": *, "isDate": *, "isLocalDateTime": *, "isDateTime": *} source

import {temporal} from 'neo4j-driver/lib/v1/index.js'

Object containing functions to work with temporal types, like Time or Duration.

public toNumber(value: Mixed): number: * source

import {toNumber} from 'neo4j-driver/lib/v1/integer.js'

Converts a variable to a number

Return:

number

the variable as a number

public toString(value: Mixed, radix: number): String: * source

import {toString} from 'neo4j-driver/lib/v1/integer.js'

Converts the integer to a string representation

Return:

String

returns a string representation of the integer

public types: {"Node": *, "Relationship": *, "UnboundRelationship": *, "PathSegment": *, "Path": *, "Result": *, "ResultSummary": *, "Record": *, "Point": *, "Date": *, "DateTime": *, "Duration": *, "LocalDateTime": *, "LocalTime": *, "Time": *} source

import {types} from 'neo4j-driver/lib/v1/index.js'

Object containing constructors for all neo4j types.