From 9ab4bc92b658298cb530baef300dff1f7c0c41c7 Mon Sep 17 00:00:00 2001 From: Stefano Ottolenghi Date: Tue, 7 Mar 2023 21:12:36 +0100 Subject: [PATCH 1/2] improve Observer types inline docs --- packages/core/src/internal/observers.ts | 11 +++++------ .../neo4j-driver-deno/lib/core/internal/observers.ts | 11 +++++------ 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/packages/core/src/internal/observers.ts b/packages/core/src/internal/observers.ts index 6deafc357..1d36f5e1b 100644 --- a/packages/core/src/internal/observers.ts +++ b/packages/core/src/internal/observers.ts @@ -23,15 +23,15 @@ import ResultSummary from '../result-summary' interface StreamObserver { /** * Will be called on every record that comes in and transform a raw record - * to a Object. If user-provided observer is present, pass transformed record - * to it's onNext method, otherwise, push to record que. + * to an Object. If user-provided observer is present, pass transformed record + * to its onNext method; otherwise push to record que. * @param {Array} rawRecord - An array with the raw record */ onNext?: (rawRecord: any[]) => void /** * Will be called on errors. * If user-provided observer is present, pass the error - * to it's onError method, otherwise set instance variable _error. + * to its onError method, otherwise set instance variable _error. * @param {Object} error - An error object */ onError: (error: Error) => void @@ -40,7 +40,6 @@ interface StreamObserver { /** * Interface to observe updates on the Result which is being produced. - * */ interface ResultObserver { /** @@ -51,7 +50,7 @@ interface ResultObserver { onKeys?: (keys: string[]) => void /** - * Receive the each record present on the {@link @Result} + * Receive each record present on the {@link @Result} * @param {Record} record The {@link Record} produced */ onNext?: (record: Record) => void @@ -115,7 +114,7 @@ export interface ResultStreamObserver extends StreamObserver { * @param {Object} observer - Observer object * @param {function(keys: String[])} observer.onKeys - Handle stream header, field keys. * @param {function(record: Object)} observer.onNext - Handle records, one by one. - * @param {function(metadata: Object)} observer.onCompleted - Handle stream tail, the metadata. + * @param {function(metadata: Object)} observer.onCompleted - Handle stream tail, the summary. * @param {function(error: Object)} observer.onError - Handle errors, should always be provided. */ subscribe: (observer: ResultObserver) => void diff --git a/packages/neo4j-driver-deno/lib/core/internal/observers.ts b/packages/neo4j-driver-deno/lib/core/internal/observers.ts index 1b6aea7a5..f0391dce9 100644 --- a/packages/neo4j-driver-deno/lib/core/internal/observers.ts +++ b/packages/neo4j-driver-deno/lib/core/internal/observers.ts @@ -23,15 +23,15 @@ import ResultSummary from '../result-summary.ts' interface StreamObserver { /** * Will be called on every record that comes in and transform a raw record - * to a Object. If user-provided observer is present, pass transformed record - * to it's onNext method, otherwise, push to record que. + * to an Object. If user-provided observer is present, pass transformed record + * to its onNext method; otherwise, push to record que. * @param {Array} rawRecord - An array with the raw record */ onNext?: (rawRecord: any[]) => void /** * Will be called on errors. * If user-provided observer is present, pass the error - * to it's onError method, otherwise set instance variable _error. + * to its onError method, otherwise set instance variable _error. * @param {Object} error - An error object */ onError: (error: Error) => void @@ -40,7 +40,6 @@ interface StreamObserver { /** * Interface to observe updates on the Result which is being produced. - * */ interface ResultObserver { /** @@ -51,7 +50,7 @@ interface ResultObserver { onKeys?: (keys: string[]) => void /** - * Receive the each record present on the {@link @Result} + * Receive each record present on the {@link @Result} * @param {Record} record The {@link Record} produced */ onNext?: (record: Record) => void @@ -115,7 +114,7 @@ export interface ResultStreamObserver extends StreamObserver { * @param {Object} observer - Observer object * @param {function(keys: String[])} observer.onKeys - Handle stream header, field keys. * @param {function(record: Object)} observer.onNext - Handle records, one by one. - * @param {function(metadata: Object)} observer.onCompleted - Handle stream tail, the metadata. + * @param {function(metadata: Object)} observer.onCompleted - Handle stream tail, the summary. * @param {function(error: Object)} observer.onError - Handle errors, should always be provided. */ subscribe: (observer: ResultObserver) => void From c0617b70ee9df9c999773223f37bccf378ed5f53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antonio=20Barc=C3=A9los?= Date: Fri, 10 Mar 2023 16:29:53 +0100 Subject: [PATCH 2/2] Update packages/neo4j-driver-deno/lib/core/internal/observers.ts --- packages/neo4j-driver-deno/lib/core/internal/observers.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/neo4j-driver-deno/lib/core/internal/observers.ts b/packages/neo4j-driver-deno/lib/core/internal/observers.ts index f0391dce9..f99c100f1 100644 --- a/packages/neo4j-driver-deno/lib/core/internal/observers.ts +++ b/packages/neo4j-driver-deno/lib/core/internal/observers.ts @@ -24,7 +24,7 @@ interface StreamObserver { /** * Will be called on every record that comes in and transform a raw record * to an Object. If user-provided observer is present, pass transformed record - * to its onNext method; otherwise, push to record que. + * to its onNext method; otherwise push to record que. * @param {Array} rawRecord - An array with the raw record */ onNext?: (rawRecord: any[]) => void