Back to Firebase Js Sdk

HttpsCallableStreamOptions interface

docs-devsite/functions.httpscallablestreamoptions.md

12.12.11.9 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

HttpsCallableStreamOptions interface

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

<b>Signature:</b>

typescript
export interface HttpsCallableStreamOptions 

Properties

PropertyTypeDescription
limitedUseAppCheckTokensbooleanIf 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.
signalAbortSignalAn <code>AbortSignal</code> 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.

<b>Signature:</b>

typescript
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.

<b>Signature:</b>

typescript
signal?: AbortSignal;