ResponseDisassembler class

Streaming response disassembler.

Extends

Constructors

ResponseDisassembler(PayloadSender, string, StreamingResponse)

Initializes a new instance of the ResponseDisassembler class.

Properties

payloadType
response

Methods

getStream()

Gets the stream this disassembler is operating on.

Inherited Methods

disassemble()

Begins the process of disassembling a payload and sending the resulting chunks to the PayloadSender to dispatch over the transport.

Constructor Details

ResponseDisassembler(PayloadSender, string, StreamingResponse)

Initializes a new instance of the ResponseDisassembler class.

new ResponseDisassembler(sender: PayloadSender, id: string, response: StreamingResponse)

Parameters

sender
PayloadSender

The PayloadSender to send the disassembled data to.

id

string

The ID of this disassembler.

response
StreamingResponse

The response to be disassembled.

Property Details

payloadType

payloadType: PayloadTypes

Property Value

response

response: StreamingResponse

Property Value

Method Details

getStream()

Gets the stream this disassembler is operating on.

function getStream(): Promise<IStreamWrapper>

Returns

Promise<IStreamWrapper>

An IStreamWrapper with a Subscribable Stream.

Inherited Method Details

disassemble()

Begins the process of disassembling a payload and sending the resulting chunks to the PayloadSender to dispatch over the transport.

function disassemble(): Promise<void>

Returns

Promise<void>

A completed Promise after the disassembled payload has been sent.

Inherited From PayloadDisassembler.disassemble