Skip to content

Update doc comments #5233

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 14 commits into from
Aug 18, 2021
Merged

Update doc comments #5233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
75f2732
Update files in packages-exp
hsubox76 Aug 2, 2021
ab460dc
Remove docs-exp from commit
hsubox76 Aug 2, 2021
eebd56b
Update in-place packages
hsubox76 Aug 2, 2021
49f8dd2
Remove docs-exp again
hsubox76 Aug 2, 2021
a562cca
Undo link in code blocks and error text
hsubox76 Aug 4, 2021
6ce2064
Address PR comments
hsubox76 Aug 17, 2021
6228af9
Fix Firestore reference
hsubox76 Aug 17, 2021
be3d2b6
fix api-extractor path for auth
hsubox76 Aug 17, 2021
a30a3e6
Fix auth api extractor warnings
hsubox76 Aug 17, 2021
4b6b04c
prettier
hsubox76 Aug 17, 2021
9973b96
Fix up after rebase
hsubox76 Aug 17, 2021
9cc9b97
prettier
hsubox76 Aug 17, 2021
0d463b8
Capitalize and literalize Promise
hsubox76 Aug 17, 2021
8daa71d
prettier
hsubox76 Aug 17, 2021
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
26 changes: 17 additions & 9 deletions common/api-review/auth-exp.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,14 +101,14 @@ export class AuthCredential {
protected constructor(
providerId: string,
signInMethod: string);
// Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.doc.d.ts
// Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.doc.d.ts
//
// @internal (undocumented)
_getIdTokenResponse(_auth: AuthInternal): Promise<PhoneOrOauthTokenResponse>;
// @internal (undocumented)
_getReauthenticationResolver(_auth: AuthInternal): Promise<IdTokenResponse>;
// Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.doc.d.ts
//
// @internal (undocumented)
_linkToIdToken(_auth: AuthInternal, _idToken: string): Promise<IdTokenResponse>;
Expand Down Expand Up @@ -276,6 +276,9 @@ export function connectAuthEmulator(auth: Auth, url: string, options?: {
disableWarnings: boolean;
}): void;

// @public
export const cordovaPopupRedirectResolver: PopupRedirectResolver;

// @public
export function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

Expand Down Expand Up @@ -339,7 +342,7 @@ export interface EmulatorConfig {

export { ErrorFn }

// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.doc.d.ts
//
// @public
export class FacebookAuthProvider extends BaseOAuthProvider {
Expand Down Expand Up @@ -481,7 +484,7 @@ export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
export class OAuthCredential extends AuthCredential {
accessToken?: string;
static fromJSON(json: string | object): OAuthCredential | null;
// Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.doc.d.ts
//
// @internal (undocumented)
static _fromParams(params: OAuthCredentialParams): OAuthCredential;
Expand Down Expand Up @@ -560,7 +563,7 @@ export class PhoneAuthCredential extends AuthCredential {
_getReauthenticationResolver(auth: AuthInternal): Promise<IdTokenResponse>;
// @internal (undocumented)
_linkToIdToken(auth: AuthInternal, idToken: string): Promise<IdTokenResponse>;
// Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.doc.d.ts
//
// @internal (undocumented)
_makeVerificationRequest(): SignInWithPhoneNumberRequest;
Expand Down Expand Up @@ -633,6 +636,9 @@ export interface ReactNativeAsyncStorage {
setItem(key: string, value: string): Promise<void>;
}

// @public
export const reactNativeLocalPersistence: Persistence;

// @public
export function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

Expand All @@ -651,13 +657,13 @@ export interface RecaptchaParameters {
[key: string]: any;
}

// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.doc.d.ts
//
// @public
export class RecaptchaVerifier implements ApplicationVerifierInternal {
constructor(containerOrId: HTMLElement | string, parameters: RecaptchaParameters, authExtern: Auth);
clear(): void;
// Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.doc.d.ts
//
// @internal (undocumented)
readonly _recaptchaLoader: ReCaptchaLoader;
Expand All @@ -671,7 +677,7 @@ export class RecaptchaVerifier implements ApplicationVerifierInternal {
// @public
export function reload(user: User): Promise<void>;

// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.doc.d.ts
//
// @public
export class SAMLAuthProvider extends FederatedAuthProvider {
Expand Down Expand Up @@ -815,4 +821,6 @@ export function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCode
export function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;


// (No @packageDocumentation comment for this package)

```
72 changes: 36 additions & 36 deletions packages-exp/analytics-exp/src/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ declare module '@firebase/component' {
}

/**
* Returns a Firebase Analytics instance for the given app.
* Returns an {@link Analytics} instance for the given app.
*
* @public
*
* @param app - The FirebaseApp to use.
* @param app - The {@link @firebase/app#FirebaseApp} to use.
*/
export function getAnalytics(app: FirebaseApp = getApp()): Analytics {
app = getModularInstance(app);
Expand All @@ -82,11 +82,11 @@ export function getAnalytics(app: FirebaseApp = getApp()): Analytics {
}

/**
* Returns a Firebase Analytics instance for the given app.
* Returns an {@link Analytics} instance for the given app.
*
* @public
*
* @param app - The FirebaseApp to use.
* @param app - The {@link @firebase/app#FirebaseApp} to use.
*/
export function initializeAnalytics(
app: FirebaseApp,
Expand Down Expand Up @@ -115,7 +115,7 @@ export function initializeAnalytics(
* 1. Check if it's not a browser extension environment.
* 2. Check if cookies are enabled in current browser.
* 3. Check if IndexedDB is supported by the browser environment.
* 4. Check if the current browser context is valid for using IndexedDB.open().
* 4. Check if the current browser context is valid for using `IndexedDB.open()`.
*
* @public
*
Expand All @@ -140,11 +140,11 @@ export async function isSupported(): Promise<boolean> {
}

/**
* Use gtag 'config' command to set 'screen_name'.
* Use gtag `config` command to set `screen_name`.
*
* @public
*
* @param analyticsInstance - Firebase Analytics instance.
* @param analyticsInstance - The {@link Analytics} instance.
* @param screenName - Screen name to set.
*/
export function setCurrentScreen(
Expand All @@ -162,11 +162,11 @@ export function setCurrentScreen(
}

/**
* Use gtag 'config' command to set 'user_id'.
* Use gtag `config` command to set `user_id`.
*
* @public
*
* @param analyticsInstance - Firebase Analytics instance.
* @param analyticsInstance - The {@link Analytics} instance.
* @param id - User ID to set.
*/
export function setUserId(
Expand All @@ -184,7 +184,7 @@ export function setUserId(
}

/**
* Use gtag 'config' command to set all params specified.
* Use gtag `config` command to set all params specified.
*
* @public
*/
Expand All @@ -203,12 +203,12 @@ export function setUserProperties(
}

/**
* Sets whether analytics collection is enabled for this app on this device.
* window['ga-disable-analyticsId'] = true;
* Sets whether Google Analytics collection is enabled for this app on this device.
* Sets global `window['ga-disable-analyticsId'] = true;`
*
* @public
*
* @param analyticsInstance - Firebase Analytics instance.
* @param analyticsInstance - The {@link Analytics} instance.
* @param enabled - If true, enables collection, if false, disables it.
*/
export function setAnalyticsCollectionEnabled(
Expand All @@ -222,7 +222,7 @@ export function setAnalyticsCollectionEnabled(
).catch(e => logger.error(e));
}
/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -245,7 +245,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -268,7 +268,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -289,7 +289,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -311,7 +311,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -335,7 +335,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -355,7 +355,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -375,7 +375,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -394,7 +394,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -415,7 +415,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -441,7 +441,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -460,7 +460,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -479,7 +479,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -499,7 +499,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -520,7 +520,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -541,7 +541,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -561,7 +561,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -582,7 +582,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -601,7 +601,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -623,7 +623,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -644,7 +644,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -665,7 +665,7 @@ export function logEvent(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* @public
Expand All @@ -681,7 +681,7 @@ export function logEvent<T extends string>(
): void;

/**
* Sends analytics event with given `eventParams`. This method
* Sends a Google Analytics event with given `eventParams`. This method
* automatically associates this logged event with this Firebase web
* app instance on this device.
* List of official event parameters can be found in the gtag.js
Expand Down
Loading