HttpsCallableStreamOptions interface

An interface for metadata about how a stream call should be executed.

Signature:

export interface HttpsCallableStreamOptions

Properties

Property Type Description
limitedUseAppCheckTokens boolean If set to true, uses a limited-use App Check token for callable function requests from this instance of Functions. You must use limited-use tokens to call functions with replay protection enabled. By default, this is false.
signal AbortSignal An AbortSignal that can be used to cancel the streaming response. When the signal is aborted, the underlying HTTP connection will be terminated.

HttpsCallableStreamOptions.limitedUseAppCheckTokens

If set to true, uses a limited-use App Check token for callable function requests from this instance of Functions. You must use limited-use tokens to call functions with replay protection enabled. By default, this is false.

Signature:

limitedUseAppCheckTokens?: boolean;

HttpsCallableStreamOptions.signal

An AbortSignal that can be used to cancel the streaming response. When the signal is aborted, the underlying HTTP connection will be terminated.

Signature:

signal?: AbortSignal;