Skip to content

Adding CallableResponse reference page and related formatting tweaks. #1666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 23, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/common/providers/https.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ export interface CallableRequest<T = any> {
data: T;

/**
* The result of decoding and verifying a Firebase AppCheck token.
* The result of decoding and verifying a Firebase App Check token.
*/
app?: AppCheckData;

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

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

/**
* An AbortSignal that is triggered when the client disconnects or the
* An `AbortSignal` that is triggered when the client disconnects or the
* request is terminated prematurely.
*/
signal: AbortSignal;
Expand Down
Loading