Skip to content

Improve Observer types inline docs #1066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 15, 2023
Merged

Improve Observer types inline docs #1066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ab4bc9
improve Observer types inline docs
stefano-ottolenghi Mar 7, 2023
c0617b7
Update packages/neo4j-driver-deno/lib/core/internal/observers.ts
bigmontz Mar 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions packages/core/src/internal/observers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -40,7 +40,6 @@ interface StreamObserver {

/**
* Interface to observe updates on the Result which is being produced.
*
*/
interface ResultObserver {
/**
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
11 changes: 5 additions & 6 deletions packages/neo4j-driver-deno/lib/core/internal/observers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -40,7 +40,6 @@ interface StreamObserver {

/**
* Interface to observe updates on the Result which is being produced.
*
*/
interface ResultObserver {
/**
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down