Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.88 KB

functions.httpscallablestreamoptions.md

File metadata and controls

46 lines (32 loc) · 1.88 KB

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.

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;