Skip to content

Commit 3e5477b

Browse files
Update doc comments and resolve nits.
1 parent bbdcc3c commit 3e5477b

File tree

5 files changed

+10
-9
lines changed

5 files changed

+10
-9
lines changed

docs-devsite/remote-config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environm
2828
| [getNumber(remoteConfig, key)](./remote-config.md#getnumber_476c09f) | Gets the value for the given key as a number.<!-- -->Convenience method for calling <code>remoteConfig.getValue(key).asNumber()</code>. |
2929
| [getString(remoteConfig, key)](./remote-config.md#getstring_476c09f) | Gets the value for the given key as a string. Convenience method for calling <code>remoteConfig.getValue(key).asString()</code>. |
3030
| [getValue(remoteConfig, key)](./remote-config.md#getvalue_476c09f) | Gets the [Value](./remote-config.value.md#value_interface) for the given key. |
31-
| [onConfigUpdate(remoteConfig, observer)](./remote-config.md#onconfigupdate_8b13b26) | Starts listening for real-time config updates from the Remote Config backend and automatically fetches updates from the RC backend when they are available.<p>If a connection to the Remote Config backend is not already open, calling this method will open it. Multiple listeners can be added by calling this method again, but subsequent calls re-use the same connection to the backend. |
31+
| [onConfigUpdate(remoteConfig, observer)](./remote-config.md#onconfigupdate_8b13b26) | Starts listening for real-time config updates from the Remote Config backend and automatically fetches updates from the RC backend when they are available. |
3232
| [setCustomSignals(remoteConfig, customSignals)](./remote-config.md#setcustomsignals_aeeb95e) | Sets the custom signals for the app instance. |
3333
| [setLogLevel(remoteConfig, logLevel)](./remote-config.md#setloglevel_039a45b) | Defines the log level to use. |
3434
| <b>function()</b> |
@@ -291,7 +291,7 @@ The value for the given key.
291291

292292
Starts listening for real-time config updates from the Remote Config backend and automatically fetches updates from the RC backend when they are available.
293293

294-
<p>If a connection to the Remote Config backend is not already open, calling this method will open it. Multiple listeners can be added by calling this method again, but subsequent calls re-use the same connection to the backend.
294+
If a connection to the Remote Config backend is not already open, calling this method will open it. Multiple listeners can be added by calling this method again, but subsequent calls re-use the same connection to the backend.
295295

296296
<b>Signature:</b>
297297

packages/remote-config/src/api.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,8 @@ export async function setCustomSignals(
366366
* Starts listening for real-time config updates from the Remote Config backend and automatically
367367
* fetches updates from the RC backend when they are available.
368368
*
369-
* <p>If a connection to the Remote Config backend is not already open, calling this method will
369+
* @remarks
370+
* If a connection to the Remote Config backend is not already open, calling this method will
370371
* open it. Multiple listeners can be added by calling this method again, but subsequent calls
371372
* re-use the same connection to the backend.
372373
*

packages/remote-config/src/client/realtime_handler.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ export class RealtimeHandler {
9191

9292
/**
9393
* Increment the number of failed stream attempts, increase the backoff duration, set the backoff
94-
* end time to "backoff duration" after {@code lastFailedStreamTime} and persist the new
94+
* end time to "backoff duration" after `lastFailedStreamTime` and persist the new
9595
* values to storage metadata.
9696
*/
9797
private async updateBackoffMetadataWithLastFailedStreamConnectionTime(
@@ -559,7 +559,7 @@ export class RealtimeHandler {
559559
* Open the real-time connection, begin listening for updates, and auto-fetch when an update is
560560
* received.
561561
*
562-
* <p>If the connection is successful, this method will block on its thread while it reads the
562+
* If the connection is successful, this method will block on its thread while it reads the
563563
* chunk-encoded HTTP body. When the connection closes, it attempts to reestablish the stream.
564564
*/
565565
private async prepareAndBeginRealtimeHttpStream(): Promise<void> {

packages/remote-config/src/client/remote_config_fetch_client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,14 +104,14 @@ export interface FetchRequest {
104104
/**
105105
* The type of fetch to perform, such as a regular fetch or a real-time fetch.
106106
*
107-
* <p>Optional as not all fetch requests need to be distinguished.
107+
* Optional as not all fetch requests need to be distinguished.
108108
*/
109109
fetchType?: FetchType;
110110

111111
/**
112112
* The number of fetch attempts made so far for this request.
113113
*
114-
* <p>Optional as not all fetch requests are part of a retry series.
114+
* Optional as not all fetch requests are part of a retry series.
115115
*/
116116
fetchAttempt?: number;
117117
}

packages/remote-config/src/register.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ export function registerRemoteConfig(): void {
108108
logger
109109
);
110110

111-
const realtimehandler = new RealtimeHandler(
111+
const realtimeHandler = new RealtimeHandler(
112112
installations,
113113
storage,
114114
SDK_VERSION,
@@ -127,7 +127,7 @@ export function registerRemoteConfig(): void {
127127
storageCache,
128128
storage,
129129
logger,
130-
realtimehandler
130+
realtimeHandler
131131
);
132132

133133
// Starts warming cache.

0 commit comments

Comments
 (0)