@@ -136,9 +136,10 @@ export class AppStore {
136136 * Validates that the `requestedOptions` and the `existingApp` options objects
137137 * do not have fields that would break deep equals comparisons.
138138 *
139- * @param requestedOptions The incoming AppOptions of a new initailizeApp
139+ * @param requestedOptions The incoming ` AppOptions` of a new ` initailizeApp`
140140 * request.
141- * @param existingApp An existing app with internal options to compare against.
141+ * @param existingApp An existing `FirebaseApp` with internal `options` to
142+ * compare against.
142143 *
143144 * @throws FirebaseAppError if the objects cannot be deeply compared.
144145 *
@@ -207,15 +208,15 @@ function validateAppNameFormat(appName: string): void {
207208export const defaultAppStore = new AppStore ( ) ;
208209
209210/**
210- * Initializes the App instance.
211+ * Initializes the ` App` instance.
211212 *
212213 * Creates a new instance of {@link App} if one doesn't exist, or returns an existing
213- * { @link App} instance if one exists with the same `appName` and `options`.
214+ * ` App` instance if one exists with the same `appName` and `options`.
214215 *
215216 * Note, due to the inablity to compare `http.Agent` objects and `Credential` objects,
216217 * this function cannot support idempotency if either of `options.httpAgent` or
217218 * `options.credential` are defined. When either is defined, subsequent invocations will
218- * throw instead of returning an { @link App} object.
219+ * throw a `FirebaseAppError` instead of returning an ` App` object.
219220 *
220221 * For example, to safely initialize an app that may already exist:
221222 *
@@ -228,37 +229,37 @@ export const defaultAppStore = new AppStore();
228229 * }
229230 * ```
230231 *
231- * @param options - Optional A set of {@link AppOptions} for the { @link App} instance.
232+ * @param options - Optional A set of {@link AppOptions} for the ` App` instance.
232233 * If not present, `initializeApp` will try to initialize with the options from the
233- * `FIREBASE_CONFIG` environment variable. If the environment variable contains a string
234- * that starts with `{` it will be parsed as JSON, otherwise it will be assumed to be
235- * pointing to a file.
236- * @param appName - Optional name of the FirebaseApp instance.
234+ * `FIREBASE_CONFIG` environment variable. If the environment variable contains a
235+ * string that starts with `{` it will be parsed as JSON, otherwise it will be
236+ * assumed to be pointing to a file.
237+ * @param appName - Optional name of the `App` instance.
237238 *
238239 * @returns A new App instance, or the existing App if the instance already exists with
239240 * the provided configuration.
240241 *
241- * @throws FirebaseAppError if an { @link App} with the same name has already been
242- * initialized with a different set of AppOptions.
243- * @throws FirebaseAppError if an existing { @link App} exists and `options.httpAgent`
242+ * @throws FirebaseAppError if an ` App` with the same name has already been
243+ * initialized with a different set of ` AppOptions` .
244+ * @throws FirebaseAppError if an existing ` App` exists and `options.httpAgent`
244245 * or `options.credential` are defined. This is due to the function's inability to
245- * determine if the existing { @link App} 's `options` compare to the `options` parameter
246+ * determine if the existing ` App` 's `options` equate to the `options` parameter
246247 * of this function. It's recommended to use {@link getApp} or {@link getApps} if your
247- * implementation uses either of these two fields in { @link AppOptions} .
248+ * implementation uses either of these two fields in ` AppOptions` .
248249 */
249250export function initializeApp ( options ?: AppOptions , appName : string = DEFAULT_APP_NAME ) : App {
250251 return defaultAppStore . initializeApp ( options , appName ) ;
251252}
252253
253254/**
254- * Returns an existing App instance for the provided name. If no name is provided
255- * the the default app name is used.
255+ * Returns an existing { @link App} instance for the provided name. If no name
256+ * is provided the the default app name is used.
256257 *
257- * @param appName - Optional name of the FirebaseApp instance.
258+ * @param appName - Optional name of the `App` instance.
258259 *
259- * @returns An existing App instance that matches the name provided.
260+ * @returns An existing ` App` instance that matches the name provided.
260261 *
261- * @throws FirebaseAppError if no { @link App} exists for the given name.
262+ * @throws FirebaseAppError if no ` App` exists for the given name.
262263 * @throws FirebaseAppError if the `appName` is malformed.
263264 */
264265export function getApp ( appName : string = DEFAULT_APP_NAME ) : App {
0 commit comments