Skip to content

Commit 4ab383b

Browse files
authored
Add tsdocs for blocking function options (#1121)
* updating docs * fixing comments * add blocking options tsdoc * wording
1 parent 1bf0a86 commit 4ab383b

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

src/providers/auth.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,15 @@ export const service = 'firebaseauth.googleapis.com';
5959
* @public
6060
*/
6161
export interface UserOptions {
62+
/** Options to set configuration at the resource level for blocking functions. */
6263
blockingOptions?: {
64+
/** Pass the ID Token credential to the function. */
6365
idToken?: boolean;
66+
67+
/** Pass the Access Token credential to the function. */
6468
accessToken?: boolean;
69+
70+
/** Pass the Refresh Token credential to the function. */
6571
refreshToken?: boolean;
6672
};
6773
}

src/v2/providers/identity.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,13 @@ interface InternalOptions {
2323
* All function options plus idToken, accessToken, and refreshToken.
2424
*/
2525
export interface BlockingOptions {
26+
/** Pass the ID Token credential to the function. */
2627
idToken?: boolean;
28+
29+
/** Pass the Access Token credential to the function. */
2730
accessToken?: boolean;
31+
32+
/** Pass the Refresh Token credential to the function. */
2833
refreshToken?: boolean;
2934

3035
/**

0 commit comments

Comments
 (0)