Skip to content

Files

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Latest commit

178e420 · May 15, 2023

History

History
46 lines (32 loc) · 1.69 KB
·

functions.httpscallableoptions.md

File metadata and controls

46 lines (32 loc) · 1.69 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 %}

HttpsCallableOptions interface

An interface for metadata about how calls should be executed.

Signature:

export interface HttpsCallableOptions 

Properties

Property Type Description
timeout number Time in milliseconds after which to cancel if there is no response. Default is 70000.
useLimitedUseAppCheckToken boolean If set to true, uses 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.

HttpsCallableOptions.timeout

Time in milliseconds after which to cancel if there is no response. Default is 70000.

Signature:

timeout?: number;

HttpsCallableOptions.useLimitedUseAppCheckToken

If set to true, uses 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:

useLimitedUseAppCheckToken?: boolean;