Class: RowStream

vertx-sql-client-js/row_stream~ RowStream

new RowStream()

A row oriented stream.
Source:

Methods

close(completionHandler)

Close the stream and release the resources.
Parameters:
Name Type Description
completionHandler function the completion handler for this operation
Source:

endHandler(endHandler) → {RowStream}

Parameters:
Name Type Description
endHandler function
Source:
Returns:
Type
RowStream

exceptionHandler(handler) → {RowStream}

Parameters:
Name Type Description
handler function
Source:
Returns:
Type
RowStream

fetch(amount) → {ReadStream}

Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.
Parameters:
Name Type Description
amount number
Source:
Returns:
a reference to this, so the API can be used fluently
Type
ReadStream

handler(handler) → {RowStream}

Parameters:
Name Type Description
handler function
Source:
Returns:
Type
RowStream

pause() → {RowStream}

Source:
Returns:
Type
RowStream

pipe() → {Pipe}

Pause this stream and return a to transfer the elements of this stream to a destination .

The stream will be resumed when the pipe will be wired to a WriteStream.

Source:
Returns:
a pipe
Type
Pipe

pipeTo(dst, handler)

Pipe this ReadStream to the WriteStream.

Elements emitted by this stream will be written to the write stream until this stream ends or fails.

Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

Parameters:
Name Type Description
dst WriteStream the destination write stream
handler function
Source:

resume() → {RowStream}

Source:
Returns:
Type
RowStream