s/useLimitedUseAppCheckToken/limitedUseAppCheckTokens/g

Author: avolkovi

common/api-review/functions.api.md

@@ -43,8 +43,8 @@ export function httpsCallableFromURL<RequestData = unknown, ResponseData = unkno
 
 // @public
 export interface HttpsCallableOptions {
+    limitedUseAppCheckTokens?: boolean;
     timeout?: number;
-    useLimitedUseAppCheckToken?: boolean;
 }
 
 // @public

docs-devsite/functions.httpscallableoptions.md

@@ -22,25 +22,25 @@ export interface HttpsCallableOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [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. |
 |  [timeout](./functions.httpscallableoptions.md#httpscallableoptionstimeout) | number | Time in milliseconds after which to cancel if there is no response. Default is 70000. |
-|  [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. |
 
-## HttpsCallableOptions.timeout
+## HttpsCallableOptions.limitedUseAppCheckTokens
 
-Time in milliseconds after which to cancel if there is no response. Default is 70000.
+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.
 
 <b>Signature:</b>
 
 ```typescript
-timeout?: number;
+limitedUseAppCheckTokens?: boolean;
 ```
 
-## HttpsCallableOptions.useLimitedUseAppCheckToken
+## HttpsCallableOptions.timeout
 
-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.
+Time in milliseconds after which to cancel if there is no response. Default is 70000.
 
 <b>Signature:</b>
 
 ```typescript
-useLimitedUseAppCheckToken?: boolean;
+timeout?: number;
 ```

packages/functions/src/callable.test.ts

@@ -196,7 +196,7 @@ describe('Firebase Functions > Call', () => {
     // Stub out the internals to get an app check token.
     const stub = sinon.stub(appCheckMock, 'getLimitedUseToken').callThrough();
     const func = httpsCallable(functions, 'appCheckTest', {
-      useLimitedUseAppCheckToken: true
+      limitedUseAppCheckTokens: true
     });
     const result = await func({});
     expect(result.data).to.deep.equal({ token: 'app-check-single-use-token' });

packages/functions/src/context.ts

@@ -120,10 +120,10 @@ export class ContextProvider {
   }
 
   async getAppCheckToken(
-    useLimitedUseAppCheckToken?: boolean
+    limitedUseAppCheckTokens?: boolean
   ): Promise<string | null> {
     if (this.appCheck) {
-      const result = useLimitedUseAppCheckToken
+      const result = limitedUseAppCheckTokens
         ? await this.appCheck.getLimitedUseToken()
         : await this.appCheck.getToken();
       if (result.error) {
@@ -137,11 +137,11 @@ export class ContextProvider {
     return null;
   }
 
-  async getContext(useLimitedUseAppCheckToken?: boolean): Promise<Context> {
+  async getContext(limitedUseAppCheckTokens?: boolean): Promise<Context> {
     const authToken = await this.getAuthToken();
     const messagingToken = await this.getMessagingToken();
     const appCheckToken = await this.getAppCheckToken(
-      useLimitedUseAppCheckToken
+      limitedUseAppCheckTokens
     );
     return { authToken, messagingToken, appCheckToken };
   }

packages/functions/src/public-types.ts

@@ -52,7 +52,7 @@ export interface HttpsCallableOptions {
    * instance of {@link Functions}. You must use limited-use tokens to call functions with
    * replay protection enabled. By default, this is false.
    */
-  useLimitedUseAppCheckToken?: boolean;
+  limitedUseAppCheckTokens?: boolean;
 }
 
 /**

packages/functions/src/service.ts

@@ -278,7 +278,7 @@ async function callAtURL(
   // Add a header for the authToken.
   const headers: { [key: string]: string } = {};
   const context = await functionsInstance.contextProvider.getContext(
-    options.useLimitedUseAppCheckToken
+    options.limitedUseAppCheckTokens
   );
   if (context.authToken) {
     headers['Authorization'] = 'Bearer ' + context.authToken;