Skip to content

Update docs for auth #1108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 9, 2022
Merged

Update docs for auth #1108

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c63bd11
Update docs for auth
TheIronDev May 9, 2022
af4c859
Update docs (Per pr feedback)
TheIronDev May 9, 2022
03a77a2
More minor updates
TheIronDev May 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions src/providers/auth.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,10 @@ export const provider = 'google.firebase.auth';
/** @hidden */
export const service = 'firebaseauth.googleapis.com';

/** Resource level options */
/**
* Resource level options
* @public
*/
export interface UserOptions {
blockingOptions?: {
idToken?: boolean;
Expand All @@ -64,9 +67,12 @@ export interface UserOptions {
}

/**
* Handle events related to Firebase authentication users.
* Handles events related to Firebase authentication users.
* @param userOptions - Resource level options
* @returns UserBuilder - Builder used to create Cloud Functions for Firebase Auth user lifecycle events
* @public
*/
export function user(userOptions?: UserOptions) {
export function user(userOptions?: UserOptions): UserBuilder {
return _userWithOptions({}, userOptions || {});
}

Expand All @@ -87,7 +93,10 @@ export function _userWithOptions(
);
}

/** Builder used to create Cloud Functions for Firebase Auth user lifecycle events. */
/**
* Builder used to create Cloud Functions for Firebase Auth user lifecycle events.
* @public
*/
export class UserBuilder {
private static dataConstructor(raw: Event): UserRecord {
return userRecordConstructor(raw.data);
Expand All @@ -100,14 +109,20 @@ export class UserBuilder {
private userOptions?: UserOptions
) {}

/** Respond to the creation of a Firebase Auth user. */
/**
* Responds to the creation of a Firebase Auth user.
* @public
*/
onCreate(
handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any
): CloudFunction<UserRecord> {
return this.onOperation(handler, 'user.create');
}

/** Respond to the deletion of a Firebase Auth user. */
/**
* Responds to the deletion of a Firebase Auth user.
* @public
*/
onDelete(
handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any
): CloudFunction<UserRecord> {
Expand Down