Skip to content

Commit 9ea463d

Browse files
committed
Update docs per comments.
1 parent 5fb40f1 commit 9ea463d

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

docs-devsite/functions.httpscallable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# HttpsCallable interface
13-
A reference to a "callable" HTTP trigger in Google Cloud Functions.
13+
A reference to a "callable" HTTP trigger in Cloud Functions.
1414

1515
<b>Signature:</b>
1616

docs-devsite/functions.httpscallableoptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ export interface HttpsCallableOptions
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25-
| [limitedUseAppCheckTokens](./functions.httpscallableoptions.md#httpscallableoptionslimiteduseappchecktokens) | 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. |
25+
| [limitedUseAppCheckTokens](./functions.httpscallableoptions.md#httpscallableoptionslimiteduseappchecktokens) | boolean | If set to true, uses a 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. |
2626
| [timeout](./functions.httpscallableoptions.md#httpscallableoptionstimeout) | number | Time in milliseconds after which to cancel if there is no response. Default is 70000. |
2727

2828
## HttpsCallableOptions.limitedUseAppCheckTokens
2929

30-
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.
30+
If set to true, uses a 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.
3131

3232
<b>Signature:</b>
3333

docs-devsite/functions.httpscallablestreamoptions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# HttpsCallableStreamOptions interface
13-
An interface for metadata about how stream call should be executed.
13+
An interface for metadata about how a stream call should be executed.
1414

1515
<b>Signature:</b>
1616

@@ -22,12 +22,12 @@ export interface HttpsCallableStreamOptions
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25-
| [limitedUseAppCheckTokens](./functions.httpscallablestreamoptions.md#httpscallablestreamoptionslimiteduseappchecktokens) | 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. |
26-
| [signal](./functions.httpscallablestreamoptions.md#httpscallablestreamoptionssignal) | AbortSignal | An AbortSignal that can be used to cancel the streaming response. When the signal is aborted, the underlying http connection will be terminated. |
25+
| [limitedUseAppCheckTokens](./functions.httpscallablestreamoptions.md#httpscallablestreamoptionslimiteduseappchecktokens) | boolean | If set to true, uses a 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. |
26+
| [signal](./functions.httpscallablestreamoptions.md#httpscallablestreamoptionssignal) | AbortSignal | An <code>AbortSignal</code> that can be used to cancel the streaming response. When the signal is aborted, the underlying HTTP connection will be terminated. |
2727

2828
## HttpsCallableStreamOptions.limitedUseAppCheckTokens
2929

30-
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.
30+
If set to true, uses a 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.
3131

3232
<b>Signature:</b>
3333

@@ -37,7 +37,7 @@ limitedUseAppCheckTokens?: boolean;
3737

3838
## HttpsCallableStreamOptions.signal
3939

40-
An AbortSignal that can be used to cancel the streaming response. When the signal is aborted, the underlying http connection will be terminated.
40+
An `AbortSignal` that can be used to cancel the streaming response. When the signal is aborted, the underlying HTTP connection will be terminated.
4141

4242
<b>Signature:</b>
4343

docs-devsite/functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ Cloud Functions for Firebase
3434
| Interface | Description |
3535
| --- | --- |
3636
| [Functions](./functions.functions.md#functions_interface) | A <code>Functions</code> instance. |
37-
| [HttpsCallable](./functions.httpscallable.md#httpscallable_interface) | A reference to a "callable" HTTP trigger in Google Cloud Functions. |
37+
| [HttpsCallable](./functions.httpscallable.md#httpscallable_interface) | A reference to a "callable" HTTP trigger in Cloud Functions. |
3838
| [HttpsCallableOptions](./functions.httpscallableoptions.md#httpscallableoptions_interface) | An interface for metadata about how calls should be executed. |
3939
| [HttpsCallableResult](./functions.httpscallableresult.md#httpscallableresult_interface) | An <code>HttpsCallableResult</code> wraps a single result from a function call. |
40-
| [HttpsCallableStreamOptions](./functions.httpscallablestreamoptions.md#httpscallablestreamoptions_interface) | An interface for metadata about how stream call should be executed. |
40+
| [HttpsCallableStreamOptions](./functions.httpscallablestreamoptions.md#httpscallablestreamoptions_interface) | An interface for metadata about how a stream call should be executed. |
4141
| [HttpsCallableStreamResult](./functions.httpscallablestreamresult.md#httpscallablestreamresult_interface) | An <code>HttpsCallableStreamResult</code> wraps a single streaming result from a function call. |
4242

4343
## Type Aliases

packages/functions/src/public-types.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export interface HttpsCallableStreamResult<
4040
}
4141

4242
/**
43-
* A reference to a "callable" HTTP trigger in Google Cloud Functions.
43+
* A reference to a "callable" HTTP trigger in Cloud Functions.
4444
* @param data - Data to be passed to callable function.
4545
* @public
4646
*/
@@ -67,25 +67,25 @@ export interface HttpsCallableOptions {
6767
*/
6868
timeout?: number;
6969
/**
70-
* If set to true, uses limited-use App Check token for callable function requests from this
70+
* If set to true, uses a limited-use App Check token for callable function requests from this
7171
* instance of {@link Functions}. You must use limited-use tokens to call functions with
7272
* replay protection enabled. By default, this is false.
7373
*/
7474
limitedUseAppCheckTokens?: boolean;
7575
}
7676

7777
/**
78-
* An interface for metadata about how stream call should be executed.
78+
* An interface for metadata about how a stream call should be executed.
7979
* @public
8080
*/
8181
export interface HttpsCallableStreamOptions {
8282
/**
83-
* An AbortSignal that can be used to cancel the streaming response. When the signal is aborted,
84-
* the underlying http connection will be terminated.
83+
* An `AbortSignal` that can be used to cancel the streaming response. When the signal is aborted,
84+
* the underlying HTTP connection will be terminated.
8585
*/
8686
signal?: AbortSignal;
8787
/**
88-
* If set to true, uses limited-use App Check token for callable function requests from this
88+
* If set to true, uses a limited-use App Check token for callable function requests from this
8989
* instance of {@link Functions}. You must use limited-use tokens to call functions with
9090
* replay protection enabled. By default, this is false.
9191
*/

0 commit comments

Comments
 (0)