Files
firebase-js-sdk/docs-devsite/functions.httpscallableoptions.md
T
6c0138f0e3 Add support for App Check replay protection in callable functions (#7296)
* Add limited token support for functions

* add test, works as a unit test, broken karma

* Finish adding support for app check callable functions SDK

* PR Feedback

* Doc feedback

Co-authored-by: Kevin Cheung <[email protected]>

* s/useLimitedUseAppCheckToken/limitedUseAppCheckTokens/g

* PR Feedback

---------

Co-authored-by: Samuel Bushi <[email protected]>
Co-authored-by: Kevin Cheung <[email protected]>
2023-05-15 16:25:05 -07:00

1.7 KiB

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
limitedUseAppCheckTokens 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.
timeout number Time in milliseconds after which to cancel if there is no response. Default is 70000.

HttpsCallableOptions.limitedUseAppCheckTokens

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:

limitedUseAppCheckTokens?: boolean;

HttpsCallableOptions.timeout

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

Signature:

timeout?: number;