Skip to content

Commit 637b191

Browse files
authored
Minor fixes for v1/auth docs. (#1200)
1 parent d12b1d1 commit 637b191

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

src/v1/providers/auth.ts

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,13 @@ export { UserRecord, UserInfo, UserRecordMetadata, userRecordConstructor };
4848

4949
export { HttpsError };
5050

51-
/** @hidden */
51+
/** @internal */
5252
export const provider = "google.firebase.auth";
53-
/** @hidden */
53+
/** @internal */
5454
export const service = "firebaseauth.googleapis.com";
5555

5656
/**
57-
* Resource level options
58-
* @public
57+
* Options for Auth blocking function.
5958
*/
6059
export interface UserOptions {
6160
/** Options to set configuration at the resource level for blocking functions. */
@@ -81,7 +80,7 @@ export function user(userOptions?: UserOptions): UserBuilder {
8180
return _userWithOptions({}, userOptions || {});
8281
}
8382

84-
/** @hidden */
83+
/** @internal */
8584
export function _userWithOptions(options: DeploymentOptions, userOptions: UserOptions) {
8685
return new UserBuilder(
8786
() => {
@@ -104,7 +103,6 @@ export class UserBuilder {
104103
return userRecordConstructor(raw.data);
105104
}
106105

107-
/** @hidden */
108106
constructor(
109107
private triggerResource: () => string,
110108
private options: DeploymentOptions,
@@ -149,7 +147,6 @@ export class UserBuilder {
149147
return this.beforeOperation(handler, "beforeSignIn");
150148
}
151149

152-
/** @hidden */
153150
private onOperation(
154151
handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any,
155152
eventType: string
@@ -167,7 +164,6 @@ export class UserBuilder {
167164
});
168165
}
169166

170-
/** @hidden */
171167
private beforeOperation(
172168
handler: (
173169
user: AuthUserRecord,

0 commit comments

Comments
 (0)