Home Reference Source
import Result from 'neo4j-driver-core/lib/result.js'
public class | source

Result

Extends:

GenericResult → Result

A stream of Record representing the result of a query. Can be consumed eagerly as Promise resolved with array of records and ResultSummary summary, or rejected with error that contains string code and string message. Alternatively can be consumed lazily using Result#subscribe function.

Inherited Summary

From class GenericResult
public

[_a](onfinally: function() | null): Promise

Called when finally the result is done

public

[Symbol.asyncIterator](): PeekableAsyncIterator<R, ResultSummary>

Provides a async iterator over the records in the result.

public

as(constructorOrRules: GenericConstructor<T> | Rules, rules: Rules): MappedResult<T>

Maps the records of this result to a provided type and/or according to provided Rules.

public

catch(onRejected: function(error: Neo4jError)): Promise

Catch errors when using promises.

public
public

isOpen(): boolean

Check if this result is active, i.e., neither a summary nor an error has been received by the result.

public

keys(): Promise<string[]>

Returns a promise for the field keys.

public

subscribe(observer: Object): void

Stream records to observer as they come in, this is a more efficient method of handling the results, and allows you to handle arbitrarily large results.

public

summary(): Promise<ResultSummary<T>>

Returns a promise for the result summary.

public

then(onFulfilled: function(result: {records: Array<Record>, summary: ResultSummary}), onRejected: function(error: {message: string, code: string})): Promise

Waits for all results and calls the passed in function with the results.