Skip to content

Commit 77bc5ef

Browse files
committed
Added TODO and comments
1 parent 22ba366 commit 77bc5ef

File tree

4 files changed

+236
-199
lines changed

4 files changed

+236
-199
lines changed

packages/remote-config/src/api.ts

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ export function getValue(remoteConfig: RemoteConfig, key: string): Value {
258258
if (!rc._isInitializationComplete) {
259259
rc._logger.debug(
260260
`A value was requested for key "${key}" before SDK initialization completed.` +
261-
' Await on ensureInitialized if the intent was to get a previously activated value.'
261+
' Await on ensureInitialized if the intent was to get a previously activated value.'
262262
);
263263
}
264264
const activeConfig = rc._storageCache.getActiveConfig();
@@ -269,7 +269,7 @@ export function getValue(remoteConfig: RemoteConfig, key: string): Value {
269269
}
270270
rc._logger.debug(
271271
`Returning static value for key "${key}".` +
272-
' Define a default or remote value if this is unintentional.'
272+
' Define a default or remote value if this is unintentional.'
273273
);
274274
return new ValueImpl('static');
275275
}
@@ -354,8 +354,14 @@ export async function setCustomSignals(
354354
}
355355
}
356356

357+
// TODO: Add public document for the Remote Config Realtime API guide on the Web Platform.
357358
/**
358-
* Registers a real-time listener for Remote Config updates.
359+
* Starts listening for real-time config updates from the Remote Config backend and automatically
360+
* fetches updates from the RC backend when they are available.
361+
*
362+
* <p>If a connection to the Remote Config backend is not already open, calling this method will
363+
* open it. Multiple listeners can be added by calling this method again, but subsequent calls
364+
* re-use the same connection to the backend.
359365
*
360366
* @param remoteConfig - The {@link RemoteConfig} instance.
361367
* @param observer - The {@link ConfigUpdateObserver} to be notified of config updates.

0 commit comments

Comments
 (0)