Skip to content

Commit c3d35c8

Browse files
authored
Initial tweaks to streaming-related API. (#1666)
1 parent 5cc9325 commit c3d35c8

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/common/providers/https.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ export interface CallableRequest<T = any> {
123123
data: T;
124124

125125
/**
126-
* The result of decoding and verifying a Firebase AppCheck token.
126+
* The result of decoding and verifying a Firebase App Check token.
127127
*/
128128
app?: AppCheckData;
129129

@@ -145,15 +145,15 @@ export interface CallableRequest<T = any> {
145145
/**
146146
* Whether this is a streaming request.
147147
* Code can be optimized by not trying to generate a stream of chunks to
148-
* call response.sendChunk on if request.acceptsStreaming is false.
149-
* It is always safe, however, to call response.sendChunk as this will
150-
* noop if acceptsStreaming is false.
148+
* call `response.sendChunk` if `request.acceptsStreaming` is false.
149+
* It is always safe, however, to call `response.sendChunk` as this will
150+
* noop if `acceptsStreaming` is false.
151151
*/
152152
acceptsStreaming: boolean;
153153
}
154154

155155
/**
156-
* CallableProxyResponse allows streaming response chunks and listening to signals
156+
* `CallableProxyResponse` allows streaming response chunks and listening to signals
157157
* triggered in events such as a disconnect.
158158
*/
159159
export interface CallableResponse<T = unknown> {
@@ -166,7 +166,7 @@ export interface CallableResponse<T = unknown> {
166166
sendChunk: (chunk: T) => Promise<boolean>;
167167

168168
/**
169-
* An AbortSignal that is triggered when the client disconnects or the
169+
* An `AbortSignal` that is triggered when the client disconnects or the
170170
* request is terminated prematurely.
171171
*/
172172
signal: AbortSignal;

0 commit comments

Comments
 (0)