Skip to content

Commit 9e4dfaf

Browse files
committed
Update jsdoc
1 parent 5172aca commit 9e4dfaf

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

common/api-review/util.api.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,6 @@ export interface FirebaseDefaults {
193193
config?: Record<string, string>;
194194
// (undocumented)
195195
emulatorHosts?: Record<string, string>;
196-
// (undocumented)
197196
forceEnvironment?: 'browser' | 'node';
198197
}
199198

@@ -223,8 +222,6 @@ export const getDefaultEmulatorHost: (productName: string) => string | undefined
223222
// @public
224223
export const getDefaultEmulatorHostnameAndPort: (productName: string) => [hostname: string, port: number] | undefined;
225224

226-
// Warning: (ae-missing-release-tag) "getDefaults" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
227-
//
228225
// @public
229226
export const getDefaults: () => FirebaseDefaults | undefined;
230227

packages/util/src/defaults.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ export interface FirebaseDefaults {
3939
emulatorHosts?: Record<string, string>;
4040
_authTokenSyncURL?: string;
4141
_authIdTokenMaxAge?: number;
42+
/**
43+
* Override Firebase's runtime environment detection and
44+
* force the SDK to act as if it were in the specified environment.
45+
*/
4246
forceEnvironment?: 'browser' | 'node';
4347
[key: string]: unknown;
4448
}
@@ -88,6 +92,7 @@ const getDefaultsFromCookie = (): FirebaseDefaults | undefined => {
8892
* (1) if such an object exists as a property of `globalThis`
8993
* (2) if such an object was provided on a shell environment variable
9094
* (3) if such an object exists in a cookie
95+
* @public
9196
*/
9297
export const getDefaults = (): FirebaseDefaults | undefined => {
9398
try {

0 commit comments

Comments
 (0)