47 lines
No EOL
1.8 KiB
TypeScript
47 lines
No EOL
1.8 KiB
TypeScript
/// <reference types="node" />
|
|
/**
|
|
* @module botframework-streaming
|
|
*/
|
|
/**
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License.
|
|
*/
|
|
import { Duplex, DuplexOptions } from 'stream';
|
|
/**
|
|
* An extension of `Duplex` that operates in conjunction with a `PayloadAssembler` to convert raw bytes into a consumable form.
|
|
*/
|
|
export declare class SubscribableStream extends Duplex {
|
|
length: number;
|
|
private readonly bufferList;
|
|
private _onData;
|
|
/**
|
|
* Initializes a new instance of the [SubscribableStream](xref:botframework-streaming.SubscribableStream) class.
|
|
*
|
|
* @param options The `DuplexOptions` to use when constructing this stream.
|
|
*/
|
|
constructor(options?: DuplexOptions);
|
|
/**
|
|
* Writes data to the buffered list.
|
|
* All calls to writable.write() that occur between the time writable._write() is called and the callback is called will cause the written data to be buffered.
|
|
*
|
|
* @param chunk The Buffer to be written.
|
|
* @param _encoding The encoding. Unused in the implementation of Duplex.
|
|
* @param callback Callback for when this chunk of data is flushed.
|
|
*/
|
|
_write(chunk: any, _encoding: string, callback: (error?: Error | null) => void): void;
|
|
/**
|
|
* Reads the buffered list.
|
|
* Once the readable._read() method has been called, it will not be called again until more data is pushed through the readable.push() method.
|
|
* Empty data such as empty buffers and strings will not cause readable._read() to be called.
|
|
*
|
|
* @param size Number of bytes to read.
|
|
*/
|
|
_read(size: number): void;
|
|
/**
|
|
* Subscribes to the stream when receives data.
|
|
*
|
|
* @param onData Callback to be called when onData is executed.
|
|
*/
|
|
subscribe(onData: (chunk: any) => void): void;
|
|
}
|
|
//# sourceMappingURL=subscribableStream.d.ts.map
|