snowflake-sdk/dist/lib/connection/result/result_stream.d.ts

Node.js driver for Snowflake

export = ResultStream;
/**
 * Creates a stream-like object that can be used to read the contents of an
 * array of chunks with the ability to prefetch chunks as we go. Every time the
 * contents of a new chunk become available, a 'data' event is fired. When there
 * are no more chunks to read, a 'close' event is fired to indicate that the
 * read operation is complete. If no chunks are specified in the options, the
 * stream asynchronously fires a 'close' event after it is returned.
 *
 * @param {Object} [options] An options object with the following properties:
 *   {Object[]} chunks       - The chunks to read.
 *   {Number}   prefetchSize - The number of chunks to prefetch every time a new
 *     chunk is read.
 *
 * @constructor
 */
declare function ResultStream(options?: Object): void;
declare class ResultStream {
    /**
     * Creates a stream-like object that can be used to read the contents of an
     * array of chunks with the ability to prefetch chunks as we go. Every time the
     * contents of a new chunk become available, a 'data' event is fired. When there
     * are no more chunks to read, a 'close' event is fired to indicate that the
     * read operation is complete. If no chunks are specified in the options, the
     * stream asynchronously fires a 'close' event after it is returned.
     *
     * @param {Object} [options] An options object with the following properties:
     *   {Object[]} chunks       - The chunks to read.
     *   {Number}   prefetchSize - The number of chunks to prefetch every time a new
     *     chunk is read.
     *
     * @constructor
     */
    constructor(options?: Object);
    /**
     * Reads the next chunk of data in the result stream.
     */
    read: () => void;
    /**
     * Asynchronously closes this stream.
     *
     * @returns {ResultStream}
     */
    asyncClose(): ResultStream;
}