Skip to content

Commit 27c52a0

Browse files
authored
fix(docs): update docstring for forwardEvents (#1700)
1 parent a81663f commit 27c52a0

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

gax/src/streamingCalls/streaming.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,11 @@ export class StreamProxy extends duplexify implements GRPCCallResult {
248248
}
249249
/**
250250
* 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+
*
251256
* @param {Stream} stream - The API request stream.
252257
* @param {RetryOptions} retry - Configures the exceptions upon which the
253258
* function should retry, and the parameters to the exponential backoff retry

0 commit comments

Comments
 (0)