Skip to content

Commit 178e420

Browse files
Doc feedback
Co-authored-by: Kevin Cheung <[email protected]>
1 parent c220234 commit 178e420

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

docs-devsite/functions.httpscallableoptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface HttpsCallableOptions
2323
| Property | Type | Description |
2424
| --- | --- | --- |
2525
| [timeout](./functions.httpscallableoptions.md#httpscallableoptionstimeout) | number | Time in milliseconds after which to cancel if there is no response. Default is 70000. |
26-
| [useLimitedUseAppCheckToken](./functions.httpscallableoptions.md#httpscallableoptionsuselimiteduseappchecktoken) | boolean | If set to true, uses limited use App Check token for callable function requests from this instance of Functions. By default, this is false. |
26+
| [useLimitedUseAppCheckToken](./functions.httpscallableoptions.md#httpscallableoptionsuselimiteduseappchecktoken) | boolean | If set to true, uses limited-use App Check token for callable function requests from this instance of [Functions](./functions.functions.md#functions_interface)<!-- -->. You must use limited-use tokens to call functions with replay protection enabled. By default, this is false. |
2727

2828
## HttpsCallableOptions.timeout
2929

@@ -37,7 +37,7 @@ timeout?: number;
3737

3838
## HttpsCallableOptions.useLimitedUseAppCheckToken
3939

40-
If set to true, uses limited use App Check token for callable function requests from this instance of Functions. By default, this is false.
40+
If set to true, uses limited-use App Check token for callable function requests from this instance of [Functions](./functions.functions.md#functions_interface)<!-- -->. You must use limited-use tokens to call functions with replay protection enabled. By default, this is false.
4141

4242
<b>Signature:</b>
4343

packages/functions/src/public-types.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@ export interface HttpsCallableOptions {
4848
*/
4949
timeout?: number;
5050
/**
51-
* If set to true, uses limited use App Check token for callable function requests from this
52-
* instance of Functions. By default, this is false.
51+
* If set to true, uses limited-use App Check token for callable function requests from this
52+
* instance of {@link Functions}. You must use limited-use tokens to call functions with
53+
* replay protection enabled. By default, this is false.
5354
*/
5455
useLimitedUseAppCheckToken?: boolean;
5556
}

0 commit comments

Comments
 (0)