Skip to content

Commit 6756dfa

Browse files
author
kjelko
committed
Mark options as optional
1 parent 676627d commit 6756dfa

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs-devsite/remote-config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ export declare function getRemoteConfig(app?: FirebaseApp, options?: RemoteConfi
6868
| Parameter | Type | Description |
6969
| --- | --- | --- |
7070
| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) instance. |
71-
| options | [RemoteConfigOptions](./remote-config.remoteconfigoptions.md#remoteconfigoptions_interface) | The [RemoteConfigOptions](./remote-config.remoteconfigoptions.md#remoteconfigoptions_interface) with which to instantiate the Remote Config instance. |
71+
| options | [RemoteConfigOptions](./remote-config.remoteconfigoptions.md#remoteconfigoptions_interface) | Optional. The [RemoteConfigOptions](./remote-config.remoteconfigoptions.md#remoteconfigoptions_interface) with which to instantiate the Remote Config instance. |
7272

7373
<b>Returns:</b>
7474

packages/remote-config/src/api.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ import { LogLevel as FirebaseLogLevel } from '@firebase/logger';
3838
/**
3939
*
4040
* @param app - The {@link @firebase/app#FirebaseApp} instance.
41-
* @param options - The {@link RemoteConfigOptions} with which to instantiate the
41+
* @param options - Optional. The {@link RemoteConfigOptions} with which to instantiate the
4242
* Remote Config instance.
4343
* @returns A {@link RemoteConfig} instance.
4444
*
@@ -256,7 +256,7 @@ export function getValue(remoteConfig: RemoteConfig, key: string): Value {
256256
if (!rc._isInitializationComplete) {
257257
rc._logger.debug(
258258
`A value was requested for key "${key}" before SDK initialization completed.` +
259-
' Await on ensureInitialized if the intent was to get a previously activated value.'
259+
' Await on ensureInitialized if the intent was to get a previously activated value.'
260260
);
261261
}
262262
const activeConfig = rc._storageCache.getActiveConfig();
@@ -267,7 +267,7 @@ export function getValue(remoteConfig: RemoteConfig, key: string): Value {
267267
}
268268
rc._logger.debug(
269269
`Returning static value for key "${key}".` +
270-
' Define a default or remote value if this is unintentional.'
270+
' Define a default or remote value if this is unintentional.'
271271
);
272272
return new ValueImpl('static');
273273
}

0 commit comments

Comments
 (0)