Skip to content

Update docs for identity #1107

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 5 commits into from
May 10, 2022
Merged

Update docs for identity #1107

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4574838
Update docs for identity
TheIronDev May 9, 2022
c4841b1
Change internal -> hidden
TheIronDev May 9, 2022
fa98620
Remove @beta from identity provider
TheIronDev May 9, 2022
0de7739
Update indentity docs
TheIronDev May 9, 2022
b83a753
Update docs per pr feedback
TheIronDev May 10, 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
36 changes: 31 additions & 5 deletions src/v2/providers/identity.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import * as options from '../options';

export { HttpsError };

/** Internally used when parsing the options. */
/** @hidden Internally used when parsing the options. */
interface InternalOptions {
opts: options.GlobalOptions;
idToken: boolean;
Expand All @@ -29,7 +29,8 @@ export interface BlockingOptions extends options.GlobalOptions {
}

/**
* Handle an event that is triggered before a user is created.
* Handles an event that is triggered before a user is created.
* @param handler - Event handler which is run every time before a user is created
*/
export function beforeUserCreated(
handler: (
Expand All @@ -40,6 +41,12 @@ export function beforeUserCreated(
| void
| Promise<void>
): BlockingFunction;

/**
* Handles an event that is triggered before a user is created.
* @param opts - Object containing function options
* @param handler - Event handler which is run every time before a user is created
*/
export function beforeUserCreated(
opts: BlockingOptions,
handler: (
Expand All @@ -50,6 +57,12 @@ export function beforeUserCreated(
| void
| Promise<void>
): BlockingFunction;

/**
* Handles an event that is triggered before a user is created
* @param optsOrHandler - Either an object containing function options, or an event handler (run before user creation)
* @param handler? - If defined, an event handler which is run every time before a user is created
*/
export function beforeUserCreated(
optsOrHandler:
| BlockingOptions
Expand All @@ -72,7 +85,8 @@ export function beforeUserCreated(
}

/**
* Handle an event that is triggered before a user is signed in.
* Handles an event that is triggered before a user is signed in.
* @param handler - Event handler which is run every time before a user is signed in
*/
export function beforeUserSignedIn(
handler: (
Expand All @@ -83,6 +97,12 @@ export function beforeUserSignedIn(
| void
| Promise<void>
): BlockingFunction;

/**
* Handles an event that is triggered before a user is signed in.
* @param opts - Object containing function options
* @param handler - Event handler which is run every time before a user is signed in
*/
export function beforeUserSignedIn(
opts: BlockingOptions,
handler: (
Expand All @@ -93,6 +113,12 @@ export function beforeUserSignedIn(
| void
| Promise<void>
): BlockingFunction;

/**
* Handles an event that is triggered before a user is signed in.
* @param optsOrHandler - Either an object containing function options, or an event handler (run before user signin)
* @param handler - Event handler which is run every time before a user is signed in
*/
export function beforeUserSignedIn(
optsOrHandler:
| BlockingOptions
Expand All @@ -114,7 +140,7 @@ export function beforeUserSignedIn(
return beforeOperation('beforeSignIn', optsOrHandler, handler);
}

/** @internal */
/** @hidden */
export function beforeOperation(
eventType: AuthBlockingEventType,
optsOrHandler:
Expand Down Expand Up @@ -197,7 +223,7 @@ export function beforeOperation(
return func;
}

/** @internal */
/** @hidden */
export function getOpts(blockingOptions: BlockingOptions): InternalOptions {
const accessToken = blockingOptions.accessToken || false;
const idToken = blockingOptions.idToken || false;
Expand Down