@firebase/remote-config-compat

What is @firebase/remote-config-compat?

@firebase/remote-config-compat is a Firebase package that allows developers to manage and fetch remote configuration parameters for their applications. This package is part of the Firebase suite and provides compatibility with older versions of Firebase Remote Config, making it easier to integrate with existing projects.

What are @firebase/remote-config-compat's main functionalities?

Fetch and Activate Remote Config

This feature allows you to fetch and activate remote configuration parameters from the Firebase server. The code initializes Firebase, sets up Remote Config with default settings, and fetches the latest configuration values.

const firebase = require('firebase/app');
require('firebase/remote-config');

firebase.initializeApp({
  apiKey: 'your-api-key',
  authDomain: 'your-auth-domain',
  projectId: 'your-project-id',
  storageBucket: 'your-storage-bucket',
  messagingSenderId: 'your-messaging-sender-id',
  appId: 'your-app-id'
});

const remoteConfig = firebase.remoteConfig();
remoteConfig.settings = {
  minimumFetchIntervalMillis: 3600000,
};

remoteConfig.defaultConfig = {
  'welcome_message': 'Welcome to my app!'
};

remoteConfig.fetchAndActivate()
  .then(() => {
    const welcomeMessage = remoteConfig.getString('welcome_message');
    console.log(welcomeMessage);
  })
  .catch((err) => {
    console.error('Error fetching remote config:', err);
  });

Get Remote Config Value

This feature allows you to retrieve a specific configuration value from the Remote Config. The code demonstrates how to get the value of 'welcome_message' after fetching and activating the remote configuration.

const firebase = require('firebase/app');
require('firebase/remote-config');

firebase.initializeApp({
  apiKey: 'your-api-key',
  authDomain: 'your-auth-domain',
  projectId: 'your-project-id',
  storageBucket: 'your-storage-bucket',
  messagingSenderId: 'your-messaging-sender-id',
  appId: 'your-app-id'
});

const remoteConfig = firebase.remoteConfig();
remoteConfig.settings = {
  minimumFetchIntervalMillis: 3600000,
};

remoteConfig.defaultConfig = {
  'welcome_message': 'Welcome to my app!'
};

remoteConfig.fetchAndActivate()
  .then(() => {
    const welcomeMessage = remoteConfig.getString('welcome_message');
    console.log(welcomeMessage);
  })
  .catch((err) => {
    console.error('Error fetching remote config:', err);
  });

Other packages similar to @firebase/remote-config-compat

config

The 'config' package is a popular Node.js configuration management tool that allows you to manage configuration settings for your application. Unlike @firebase/remote-config-compat, which fetches configurations from Firebase servers, 'config' reads configurations from local files and environment variables.

dotenv

The 'dotenv' package loads environment variables from a .env file into process.env. It is commonly used for managing configuration settings in Node.js applications. Unlike @firebase/remote-config-compat, 'dotenv' does not provide remote fetching capabilities and is limited to local environment variables.

convict

The 'convict' package is a configuration management tool for Node.js applications that allows you to define a schema for your configuration files. It supports environment-based configurations and validation. Unlike @firebase/remote-config-compat, 'convict' does not offer remote fetching of configurations and is focused on local configuration management.

README

@firebase/remote-compat

This is the compat package that recreates the v8 APIs.

This package is not intended for direct usage, and should only be used via the officially supported firebase package.