We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent a81663f commit 27c52a0Copy full SHA for 27c52a0
gax/src/streamingCalls/streaming.ts
@@ -248,6 +248,11 @@ export class StreamProxy extends duplexify implements GRPCCallResult {
248
}
249
/**
250
* Forward events from an API request stream to the user's stream.
251
+ * gRPC is guaranteed emit the 'status' event but not 'metadata'
252
+ * 'status' is the last event to emit; if 'metadata' emits, it will
253
+ * be the first event to emit. It should only emit once; if it emits
254
+ * more than once, unexpected side effects will occur.
255
+ *
256
* @param {Stream} stream - The API request stream.
257
* @param {RetryOptions} retry - Configures the exceptions upon which the
258
* function should retry, and the parameters to the exponential backoff retry
0 commit comments