RxResult
Method Summary
Public Methods | ||
public |
consume(): Observable<ResultSummary> Returns an observable that exposes a single item of ResultSummary that is generated by the server after the streaming of the executing query is completed. |
|
public |
keys(): Observable<string[]> Returns an observable that exposes a single item containing field names returned by the executing query. |
|
public |
pause() this method is experimental.
Pauses the automatic streaming of records. |
|
public |
push(): Promise<void> this method is experimental.
Pushes the next record to the stream. |
|
public |
Returns an observable that exposes each record returned by the executing query. |
|
public |
resume(): Promise<void> this method is experimental.
Resumes the automatic streaming of records. |
Public Methods
public consume(): Observable<ResultSummary> source
Returns an observable that exposes a single item of ResultSummary that is generated by the server after the streaming of the executing query is completed.
Subscribing to this stream before subscribing to records() stream causes the results to be discarded on the server.
Return:
Observable<ResultSummary> | An observable stream (with exactly one element) of result summary. |
public keys(): Observable<string[]> source
Returns an observable that exposes a single item containing field names returned by the executing query.
Errors raised by actual query execution can surface on the returned observable stream.
Return:
Observable<string[]> | An observable stream (with exactly one element) of field names. |
public pause() source
Pauses the automatic streaming of records.
This method provides a way of control the flow of records
public push(): Promise<void> source
Pushes the next record to the stream.
This method automatic pause the auto-streaming of records and then push next record to the stream.
For returning the automatic streaming of records, use resume method.
Return:
Promise<void> | A promise that resolves when the push is completed. |
public records(): Observable<Record> source
Returns an observable that exposes each record returned by the executing query.
Errors raised during the streaming phase can surface on the returned observable stream.
public resume(): Promise<void> source
Resumes the automatic streaming of records.
This method won't need to be called in normal stream operation. It only applies to the case when the stream is paused.
This method is method won't start the consuming records if the ${@link records()} stream didn't get subscribed.
Return:
Promise<void> | A promise that resolves when the stream is resumed. |