Class: ClientReadableStream

grpc~ClientReadableStream(call, deserializeopt)

new ClientReadableStream(call, deserializeopt)

A stream that the client can read from. Used for calls that are streaming from the server side.

Parameters:
Name Type Attributes Default Description
call grpc.internal~Call

The call object to read data with

deserialize grpc~deserialize <optional>
identity

Deserialization function for reads

Source:

Extends

Methods

cancel()

Cancel the ongoing call. Results in the call ending with a CANCELLED status, unless it has already ended with some other status.

Source:

getPeer() → {string}

Get the endpoint this call/stream is connected to.

Source:
Returns:

The URI of the endpoint

Type
string

Events

metadata

Initial response metadata sent by the server when it starts processing the call

Type:
Source:

status

Status of the call when it has completed.

Type:
Source: