Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(remote-config)!: update docs to be explicit about new behavior #4169

Merged
merged 1 commit into from
Aug 28, 2020
Merged

docs(remote-config)!: update docs to be explicit about new behavior #4169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions packages/remote-config/lib/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ export namespace FirebaseRemoteConfigTypes {

/**
* Moves fetched data to the apps active config.
* Resolves with a boolean value of whether the fetched config was moved successfully.
* Resolves with a boolean value true if new local values were activated
*
* #### Example
*
Expand Down Expand Up @@ -395,6 +395,7 @@ export namespace FirebaseRemoteConfigTypes {

/**
* Fetches the remote config data from Firebase, as defined in the dashboard. If duration is defined (seconds), data will be locally cached for this duration.
* Returns true only if new values were fetched, false otherwise.
*
* #### Example
*
Expand All @@ -410,7 +411,7 @@ export namespace FirebaseRemoteConfigTypes {
/**
* Fetches the remote config data from Firebase, as defined in the dashboard.
*
* Once fetching is complete this method immediately calls activate and returns a boolean value of the activation status.
* Once fetching is complete this method immediately calls activate and returns a boolean value true if new values were fetched
*
* #### Example
*
Expand All @@ -419,9 +420,9 @@ export namespace FirebaseRemoteConfigTypes {
* const fetchedRemotely = await firebase.remoteConfig().fetchAndActivate();
*
* if (fetchedRemotely) {
* console.log('Configs were retrieved from the backend and activated.');
* console.log('New configs were retrieved from the backend and activated.');
* } else {
* console.log('No configs were fetched from the backend, and the local configs were already activated');
* console.log('No new configs were fetched from the backend, and the local configs were already activated');
* }
* ```
*
Expand Down